com.pingidentity.pa.sdk.http

Interface Message

All Known Subinterfaces:

Request, Response

public interface Message

Interface defining the representation for a HTTP message.

Method Summary

Modifier and Type	Method and Description
Body	getBody() Returns the body of this Message Note: when processing an Agent Request from a PingAccess agent, the headers of the Message might indicate a non-empty body should be returned, but an empty body will be returned.
Headers	getHeaders() Returns the headers associated with this Message.
String	getStartLine() Returns the Start-Line for this Message.
String	getVersion() Returns the Start-Line version string.
boolean	isKeepAlive() Indicates whether or not this Message is a KeepAlive transaction.
void	setBody(Body body) Sets the body of this Message.
void	setBodyContent(byte[] content) Sets the body content of this Message.
void	setHeaders(Headers srcHeaders) Sets the headers to be associated with this Message.

Method Detail

getBody

Body getBody()

Returns the body of this Message Note: when processing an Agent Request from a PingAccess agent, the headers of the Message might indicate a non-empty body should be returned, but an empty body will be returned.

Returns:

the body of the Message (never null).

setBody

void setBody(Body body)

Sets the body of this Message. This method does not change the Headers of the Message to account for the change in the Body, e.g., the Content-Length header field is not updated. The setBodyContent(byte[]) will update the Headers appropriately.

Parameters:

body - the Body to replace in this Message.

Throws:

IllegalArgumentException - if the specified Body was not created by the provided BodyFactory. See ServiceFactory.bodyFactory()).

setBodyContent

void setBodyContent(byte[] content)

Sets the body content of this Message. The associated Headers will be updated to reflect the change to the body content.

Parameters:

content - the data used to replace the existing Body for this Message. The provided array will be copied.

getHeaders

Headers getHeaders()

Returns the headers associated with this Message.

Returns:

the Headers object for this Message.

setHeaders

void setHeaders(Headers srcHeaders)

Sets the headers to be associated with this Message.

Parameters:

srcHeaders - the replacement Headers for this Message.

Throws:

IllegalArgumentException - if the specified Headers object was not created with the provided HeadersFactory. See ServiceFactory.headersFactory().

getStartLine

String getStartLine()

Returns the Start-Line for this Message.

Returns:

the Start-Line for this Message

getVersion

String getVersion()

Returns the Start-Line version string.

Returns:

the version string from the Start-Line. The value will be 1.0 or 1.1

isKeepAlive

boolean isKeepAlive()

Indicates whether or not this Message is a KeepAlive transaction.

Returns:

true if this Message is a KeepAlive transaction