org.apache.juneau.rest

Class RequestBody

java.lang.Object

org.apache.juneau.rest.RequestBody

public class RequestBody
extends Object

Contains the body of the HTTP request.

See Also:

• Overview > juneau-rest-server > RequestBody

Method Summary

Modifier and Type	Method and Description
String	asHex() Returns the HTTP body content as a simple hexadecimal character string.
String	asSpacedHex() Returns the HTTP body content as a simple space-delimited hexadecimal character string.
String	asString() Returns the HTTP body content as a plain string.
<T> T	asType(Class<T> type) Reads the input from the HTTP request parsed into a POJO.
<T> T	asType(Type type, Type... args) Reads the input from the HTTP request parsed into a POJO.
int	getContentLength() Returns the content length of the body.
javax.servlet.ServletInputStream	getInputStream() Returns the HTTP body content as an InputStream.
Parser	getParser() Returns the parser matching the request Content-Type header.
ParserMatch	getParserMatch() Returns the parser and media type matching the request Content-Type header.
BufferedReader	getReader() Returns the HTTP body content as a Reader.
ReaderParser	getReaderParser() Returns the reader parser matching the request Content-Type header.
protected Reader	getUnbufferedReader() Same as getReader(), but doesn't encapsulate the result in a BufferedReader;

Methods inherited from class java.lang.Object

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

Method Detail

asType

public <T> T asType(Class<T> type)
             throws IOException,
                    ParseException

Reads the input from the HTTP request parsed into a POJO.

The parser used is determined by the matching Content-Type header on the request.

If type is null or Object.class, then the actual type will be determined automatically based on the following input:

Type	JSON input	XML input	Return type
object	"{...}"	<object>...</object> <x type='object'>...</x>	ObjectMap
array	"[...]"	<array>...</array> <x type='array'>...</x>	ObjectList
string	"'...'"	<string>...</string> <x type='string'>...</x>	String
number	123	<number>123</number> <x type='number'>...</x>	Number
boolean	true	<boolean>true</boolean> <x type='boolean'>...</x>	Boolean
null	null or blank	<null/> or blank <x type='null'/>	null

Refer to POJO Categories for a complete definition of supported POJOs.

Examples:

// Parse into an integer. int body = req.getBody().asType(int.class); // Parse into an int array. int[] body = req.getBody().asType(int[].class); // Parse into a bean. MyBean body = req.getBody().asType(MyBean.class); // Parse into a linked-list of objects. List body = req.getBody().asType(LinkedList.class); // Parse into a map of object keys/values. Map body = req.getBody().asType(TreeMap.class);

Notes:

• If allowHeaderParams init parameter is true, then first looks for &body=xxx in the URL query string.

Type Parameters:

T - The class type to instantiate.

Parameters:

type - The class type to instantiate.

Returns:

The input parsed to a POJO.

Throws:

IOException - If a problem occurred trying to read from the reader.

ParseException - If the input contains a syntax error or is malformed for the requested Accept header or is not valid for the specified type.

asType

public <T> T asType(Type type,
                    Type... args)

Reads the input from the HTTP request parsed into a POJO.

This is similar to asType(Class) but allows for complex collections of POJOs to be created.

Examples:

// Parse into a linked-list of strings. List<String> body = req.getBody().asType(LinkedList.class, String.class); // Parse into a linked-list of linked-lists of strings. List<List<String>> body = req.getBody().asType(LinkedList.class, LinkedList.class, String.class); // Parse into a map of string keys/values. Map<String,String> body = req.getBody().asType(TreeMap.class, String.class, String.class); // Parse into a map containing string keys and values of lists containing beans. Map<String,List<MyBean>> body = req.getBody().asType(TreeMap.class, String.class, List.class, MyBean.class);

Notes:

• Collections must be followed by zero or one parameter representing the value type.
• Maps must be followed by zero or two parameters representing the key and value types.
• If allowHeaderParams init parameter is true, then first looks for &body=xxx in the URL query string.

Type Parameters:

T - The class type to instantiate.

Parameters:

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The input parsed to a POJO.

asString

public String asString()
                throws IOException

Returns the HTTP body content as a plain string.

Notes:

• If allowHeaderParams init parameter is true, then first looks for &body=xxx in the URL query string.

Returns:

The incoming input from the connection as a plain string.

Throws:

IOException - If a problem occurred trying to read from the reader.

asHex

public String asHex()
             throws IOException

Returns the HTTP body content as a simple hexadecimal character string.

Example:

0123456789ABCDEF

Returns:

The incoming input from the connection as a plain string.

Throws:

IOException - If a problem occurred trying to read from the reader.

asSpacedHex

public String asSpacedHex()
                   throws IOException

Returns the HTTP body content as a simple space-delimited hexadecimal character string.

Example:

01 23 45 67 89 AB CD EF

Returns:

The incoming input from the connection as a plain string.

Throws:

IOException - If a problem occurred trying to read from the reader.

getReader

public BufferedReader getReader()
                         throws IOException

Returns the HTTP body content as a Reader.

Notes:

• If allowHeaderParams init parameter is true, then first looks for &body=xxx in the URL query string.
• Automatically handles GZipped input streams.

Returns:

The body contents as a reader.

Throws:

IOException

getUnbufferedReader

protected Reader getUnbufferedReader()
                              throws IOException

Same as getReader(), but doesn't encapsulate the result in a BufferedReader;

Returns:

An unbuffered reader.

Throws:

IOException

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException

Returns the HTTP body content as an InputStream.

Returns:

The negotiated input stream.

Throws:

IOException - If any error occurred while trying to get the input stream or wrap it in the GZIP wrapper.

getParserMatch

public ParserMatch getParserMatch()

Returns the parser and media type matching the request Content-Type header.

Returns:

The parser matching the request Content-Type header, or null if no matching parser was found. Includes the matching media type.

getParser

public Parser getParser()

Returns the parser matching the request Content-Type header.

Returns:

The parser matching the request Content-Type header, or null if no matching parser was found.

getReaderParser

public ReaderParser getReaderParser()

Returns the reader parser matching the request Content-Type header.

Returns:

The reader parser matching the request Content-Type header, or null if no matching reader parser was found, or the matching parser was an input stream parser.

getContentLength

public int getContentLength()

Returns the content length of the body.

Returns:

The content length of the body in bytes.