groovyx.net.http

Class NativeHandlers.Encoders

java.lang.Object

groovyx.net.http.NativeHandlers.Encoders

Enclosing class:

NativeHandlers

public static class NativeHandlers.Encoders
extends java.lang.Object

The set of available content encoders.

Constructor Summary

Constructors

Constructor and Description
Encoders()

Method Summary

Modifier and Type	Method and Description
static void	binary(ChainedHttpConfig config, ToServer ts) Standard encoder for binary types.
static java.lang.Object	checkNull(java.lang.Object body)
static void	checkTypes(java.lang.Object body, java.lang.Class<?>[] allowedTypes)
static void	form(ChainedHttpConfig config, ToServer ts) Standard encoder for requests with content type 'application/x-www-form-urlencoded'.
static boolean	handleRawUpload(ChainedHttpConfig config, ToServer ts)
static void	json(ChainedHttpConfig config, ToServer ts) Standard encoder for requests with a json body.
static java.io.InputStream	readerToStream(java.io.Reader r, java.nio.charset.Charset cs)
static java.io.InputStream	stringToStream(java.lang.String s, java.nio.charset.Charset cs)
static void	text(ChainedHttpConfig config, ToServer ts) Standard encoder for text types.
static void	xml(ChainedHttpConfig config, ToServer ts) Standard encoder for requests with an xml body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Encoders

public Encoders()

Method Detail

checkNull

public static java.lang.Object checkNull(java.lang.Object body)

checkTypes

public static void checkTypes(java.lang.Object body,
                              java.lang.Class<?>[] allowedTypes)

readerToStream

public static java.io.InputStream readerToStream(java.io.Reader r,
                                                 java.nio.charset.Charset cs)
                                          throws java.io.IOException

Throws:

java.io.IOException

stringToStream

public static java.io.InputStream stringToStream(java.lang.String s,
                                                 java.nio.charset.Charset cs)

handleRawUpload

public static boolean handleRawUpload(ChainedHttpConfig config,
                                      ToServer ts)

binary

public static void binary(ChainedHttpConfig config,
                          ToServer ts)

Standard encoder for binary types. Accepts ByteArrayInputStream, InputStream, and byte[] types.

Parameters:

config - Fully configured chained request

ts - Formatted http body is passed to the ToServer argument

text

public static void text(ChainedHttpConfig config,
                        ToServer ts)
                 throws java.io.IOException

Standard encoder for text types. Accepts String and Reader types

Parameters:

config - Fully configured chained request

ts - Formatted http body is passed to the ToServer argument

Throws:

java.io.IOException

form

public static void form(ChainedHttpConfig config,
                        ToServer ts)

Standard encoder for requests with content type 'application/x-www-form-urlencoded'. Accepts String and Map types. If the body is a String type the method assumes it is properly url encoded and is passed to the ToServer parameter as is. If the body is a Map type then the output is generated by the Form class.

Parameters:

config - Fully configured chained request

ts - Formatted http body is passed to the ToServer argument

xml

public static void xml(ChainedHttpConfig config,
                       ToServer ts)

Standard encoder for requests with an xml body. <p> Accepts String and Closure types. If the body is a String type the method passes the body to the ToServer parameter as is. If the body is a Closure then the closure is converted to xml using Groovy’s StreamingMarkupBuilder.

Parameters:

config - Fully configured chained request

ts - Formatted http body is passed to the ToServer argument

json

public static void json(ChainedHttpConfig config,
                        ToServer ts)

Standard encoder for requests with a json body. <p> Accepts String, GString and Closure types. If the body is a String type the method passes the body to the ToServer parameter as is. If the body is a Closure then the closure is converted to json using Groovy’s JsonBuilder.

Parameters:

config - Fully configured chained request

ts - Formatted http body is passed to the ToServer argument