com.oracle.iot.client.message

Class RequestMessage

java.lang.Object

com.oracle.iot.client.message.Message

com.oracle.iot.client.message.RequestMessage

public final class RequestMessage
extends Message

RequestMessage extends Message class. It stores HTTP headers, parameters, method, 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	RequestMessage.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 request message body.
java.lang.String	getBodyString() Get HTTP request message body in String.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders() Get Http request message headers.
java.lang.String	getHeaderValue(java.lang.String name) Get first value from request message header.
java.lang.String	getHeaderValue(java.lang.String name, int index) Get request message header value at given index.
java.util.List<java.lang.String>	getHeaderValues(java.lang.String name) Get Http request message header values for given header name.
java.lang.String	getMethod() Get request message method.
java.lang.String	getParam(java.lang.String name) Get parameter value for given parameter name.
java.util.Map<java.lang.String,java.lang.String>	getParams() Get Http request message parameters.
Message.Type	getType() Get message type.
java.lang.String	getURL() Get request message URL.
int	hashCode()
org.json.JSONObject	toJson() Exports Http request message to JSONObject format.
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 request 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 request 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 request 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 request 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.

getParams

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

Get Http request message parameters.

Returns:

Map of pair String and String representing parameters, never null

getParam

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

Get parameter value for given parameter name.

Parameters:

name - parameter name, should not be null.

Returns:

parameter value, may return null if the parameter name does not exist.

getURL

public final java.lang.String getURL()

Get request message URL.

Returns:

URL, never null

getBody

public final byte[] getBody()

Get HTTP request 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 request message body in String. It fromString and return the inner representation of message body to String.

Returns:

Http message body as String, never null

getMethod

public final java.lang.String getMethod()

Get request message method. Note that the returned String is always in lower case.

Returns:

Http method, 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 Http request message to JSONObject format.

Overrides:

toJson in class Message

Returns:

request 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