com.pingidentity.pa.sdk.http

Interface Body

public interface Body

A representation of the body content of an HTTP message. Interaction with the body may result in that body being read into memory. Care needs to be taken when reading a HTTP message body into memory because doing so could impact the scalability of PingAccess. If possible, HTTP message bodies should not be read into memory. A Body is a stateful object. In particular, the following methods will only execute successfully when the body is already available in memory: - getContent() - newInputStream() - getLength() isInMemory() will return true when these methods will complete successfully.

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() Gets the body content as a byte array, if the body content is available in memory--isInMemory() returns true when this is the case.
int	getLength() Gets the length of the body content, if the body content is available in memory--isInMemory() returns true when this is the case.
boolean	isInMemory() Returns true if the body content is in memory.
boolean	isRead() Returns true if the body content has been read.
InputStream	newInputStream() Gets the body content as an InputStream, if the body content is available in memory--isInMemory() returns true when this is the case.
Map<String,String[]>	parseFormParams() Parses form parameters from the body content, assuming the content is encoded following the encoding defined by the application/x-www-form-urlencoded content type and a default character encoding of UTF-8.
void	read() Read the body content into memory.
String	toString() A debugging function to provide a String representation of the body content.

Method Detail

read

void read()
   throws AccessException,
          IOException

Read the body content into memory. If the size of the body content is greater than the configured maximum, this method will fail. See the PingAccess administrative documentation for more info on configuring this limit. If isRead() returns true, this method will return immediately and not perform any I/O.

Throws:

AccessException - the body content length is determined to be greater than the configured maximum

IOException - on I/O error while reading the body content

isRead

boolean isRead()

Returns true if the body content has been read. PingAccess will by default stream a message body from the client to the server and vice versa without reading the complete body into memory. In this scenario, after streaming the body, this method will return true. However the body content will not be available for consumption by other methods.

Returns:

true if the body content has been read.

isInMemory

boolean isInMemory()

Returns true if the body content is in memory. PingAccess will by default stream a message body from the client to the server and vice versa without reading the complete body into memory. In this scenario, after streaming the body, this method will return false.

Returns:

true if the body is in memory.

getContent

byte[] getContent()

Gets the body content as a byte array, if the body content is available in memory--isInMemory() returns true when this is the case. This method returns a copy of the byte array. To avoid the copy, use newInputStream().

Returns:

a copy of the body content as a byte array.

Throws:

IllegalStateException - if the body content is not available in memory. isInMemory() will return true when this method will execute successfully.

newInputStream

InputStream newInputStream()

Gets the body content as an InputStream, if the body content is available in memory--isInMemory() returns true when this is the case.

Returns:

the body content as a InputStream.

Throws:

IllegalStateException - if the body content is not available in memory. isInMemory() will return true when this method will execute successfully.

getLength

int getLength()

Gets the length of the body content, if the body content is available in memory--isInMemory() returns true when this is the case.

Returns:

the length of the body.

Throws:

IllegalStateException - if the body content is not available in memory. isInMemory() will return true when this method will execute successfully.

parseFormParams

Map<String,String[]> parseFormParams()

Parses form parameters from the body content, assuming the content is encoded following the encoding defined by the application/x-www-form-urlencoded content type and a default character encoding of UTF-8. This method requires that the body content be available in memory--isInMemory() returns true when this is the case.

Returns:

the form parameters

Throws:

IllegalStateException - if the body content is not available in memory. isInMemory() will return true when this method will execute successfully.

IllegalArgumentException - if the body content is not valid application/x-www-form-urlencoded content

toString

String toString()

A debugging function to provide a String representation of the body content.

Overrides:

toString in class Object

Returns:

a String representation, created from the data returned by getContent() assuming an encoding of UTF-8. If the body has not been read into memory yet, the empty string is returned.