com.oracle.iot.client.message

Class ResponseMessage

java.lang.Object

com.oracle.iot.client.message.Message

com.oracle.iot.client.message.ResponseMessage

public final class ResponseMessage
extends Message

ResponseMessage extends Message class. It stores HTTP headers, status code and URL and body. The body is in byte array. Default encoding for string body is UTF-8. This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseMessage.Builder Builder extends Message.MessageBuilder class.

Nested classes/interfaces inherited from class com.oracle.iot.client.message.Message

Message.Direction, Message.MessageBuilder<T extends Message.MessageBuilder<T>>, Message.Priority, Message.Reliability, Message.Type

Field Summary

Fields inherited from class com.oracle.iot.client.message.Message

DIAG_CLIENT_ADDRESS, DIAG_CREATED_TIME

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
byte[]	getBody() Get HTTP response message body.
java.lang.String	getBodyString() Get HTTP response message body in String.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders() Get Http response message headers.
java.lang.String	getHeaderValue(java.lang.String name) Get first value from response message header.
java.lang.String	getHeaderValue(java.lang.String name, int index) Get response message header value at given index.
java.util.List<java.lang.String>	getHeaderValues(java.lang.String name) Get Http response message header values for given header name.
java.lang.String	getRequestId() Get ID of RequestMessage.
StatusCode	getStatusCode() Get Http response message status code.
Message.Type	getType() Get message type.
java.lang.String	getURL() Get request message URL.
int	hashCode()
org.json.JSONObject	toJson() Exports response message to JSONObject.
java.lang.String	toString() Exports data from RequestMessage to String using JSON interpretation of the message.

Methods inherited from class com.oracle.iot.client.message.Message

createBuilderFromJson, fromJson, fromJson, fromJson, getClientId, getDestination, getDiagnostics, getDiagnosticValue, getDirection, getEventTime, getId, getOrdinal, getPriority, getProperties, getReceivedTime, getReliability, getRemainingRetries, getSender, getSentTime, getSource, prettyPrintJson, prettyPrintJson, prettyPrintJson, prettyPrintJson, setRemainingRetries, toJson, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getHeaders

public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

Get Http response message headers.

Returns:

Map of pair String and List of String representing headers, never null

getHeaderValues

public final java.util.List<java.lang.String> getHeaderValues(java.lang.String name)

Get Http response message header values for given header name.

Parameters:

name - header name, should not be null.

Returns:

List of header values, never null

getHeaderValue

public final java.lang.String getHeaderValue(java.lang.String name,
                                             int index)

Get response message header value at given index.

Parameters:

name - header name, should not be null.

index - index in List of header values.

Returns:

header value, may return null if header name does not exist or index is out of range.

getHeaderValue

public final java.lang.String getHeaderValue(java.lang.String name)

Get first value from response message header.

Parameters:

name - header name, should not be null.

Returns:

first header value, may return null if the header name does not exist or no values were set for given header name.

getURL

public final java.lang.String getURL()

Get request message URL.

Returns:

URL, never null

getBody

public final byte[] getBody()

Get HTTP response message body. If message body contains string value, default encoding is UTF-8.

Returns:

body, never null

getBodyString

public final java.lang.String getBodyString()

Get HTTP response message body in String. It fromString and return the inner representation of message body to String.

Returns:

Http message body as String, never null

getStatusCode

public final StatusCode getStatusCode()

Get Http response message status code.

Returns:

statusCode, never null

getRequestId

public java.lang.String getRequestId()

Get ID of RequestMessage. RequestMessage Id can be used for pairing request-response.

Returns:

Request id, never null

getType

public Message.Type getType()

Get message type.

Specified by:

getType in class Message

Returns:

type, never null.

toString

public final java.lang.String toString()

Exports data from RequestMessage to String using JSON interpretation of the message.

Overrides:

toString in class Message

Returns:

JSON interpretation of the message as String.

toJson

public final org.json.JSONObject toJson()

Exports response message to JSONObject.

Overrides:

toJson in class Message

Returns:

response message in JSON format

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Message

hashCode

public int hashCode()

Overrides:

hashCode in class Message