com.oracle.iot.client.message

Class RequestMessage.Builder

java.lang.Object

com.oracle.iot.client.message.Message.MessageBuilder<RequestMessage.Builder>

com.oracle.iot.client.message.RequestMessage.Builder

Enclosing class:

RequestMessage

public static final class RequestMessage.Builder
extends Message.MessageBuilder<RequestMessage.Builder>

Builder extends Message.MessageBuilder class. RequestMessage class is immutable. A builder is required when creating RequestMessage. RequestMessage uses Builder design pattern.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RequestMessage.Builder	body(byte[] body) Set message body.
RequestMessage.Builder	body(java.lang.String body) Set message body using a String.
RequestMessage	build() Creates new instance of RequestMessage using values from RequestMessage.Builder.
RequestMessage.Builder	fromJson(org.json.JSONObject jsonObject) Method to deserialization of the Message from a JsonObject.
RequestMessage.Builder	header(java.lang.String name, java.util.List<java.lang.String> values) Add Http message header.
RequestMessage.Builder	method(java.lang.String method) Set Http method.
RequestMessage.Builder	param(java.lang.String name, java.lang.String value) Add Http parameter.
protected RequestMessage.Builder	self() Returns current instance of RequestMessage.Builder.
RequestMessage.Builder	url(java.lang.String url) Set message URL.

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

clientId, destination, diagnostic, direction, eventTime, eventTime, id, priority, properties, receivedTime, reliability, sender, sentTime, source

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

header

public final RequestMessage.Builder header(java.lang.String name,
                                           java.util.List<java.lang.String> values)

Add Http message header. The name cannot be null. The values can be null. The List of values cannot contain nulls. Name and values must contain ASCII-printable characters only. Note that the name of the header is always converted to lower case.

Parameters:

name - Name of the http header.

values - Http header values.

Returns:

Builder with updated header field.

Throws:

java.lang.NullPointerException - when the header name is null or if values contains null string.

java.lang.IllegalArgumentException - when name or values contain non-ASCII-printable characters.

param

public final RequestMessage.Builder param(java.lang.String name,
                                          java.lang.String value)

Add Http parameter. Name of the param cannot be null. Parameter value can be null.

Parameters:

name - Http parameter name.

value - Http parameter value.

Returns:

Builder with updated param field.

Throws:

java.lang.NullPointerException - when the name is null.

url

public final RequestMessage.Builder url(java.lang.String url)

Set message URL. The URL is not checked for validity.

Parameters:

url - URL of the HTTP request.

Returns:

Builder with updated url field.

body

public final RequestMessage.Builder body(byte[] body)

Set message body.

Parameters:

body - Body of the HTTP message, should not be null.

Returns:

Builder with updated body field.

body

public final RequestMessage.Builder body(java.lang.String body)

Set message body using a String. The encoding for the body is UTF-8.

Parameters:

body - Body of the HTTP message, should not be null.

Returns:

Builder with updated body field.

method

public final RequestMessage.Builder method(java.lang.String method)

Set Http method. Tha name of the HTTP method is always converted to lower case.

Parameters:

method - Method of the HTTP.

Returns:

Builder with updated method field.

fromJson

public final RequestMessage.Builder fromJson(org.json.JSONObject jsonObject)

Description copied from class: Message.MessageBuilder

Method to deserialization of the Message from a JsonObject.

Overrides:

fromJson in class Message.MessageBuilder<RequestMessage.Builder>

Parameters:

jsonObject - the jsonObject to fromString

Returns:

generic type of message builder

self

protected final RequestMessage.Builder self()

Returns current instance of RequestMessage.Builder.

Specified by:

self in class Message.MessageBuilder<RequestMessage.Builder>

Returns:

Instance of RequestMessage.Builder

build

public RequestMessage build()

Creates new instance of RequestMessage using values from RequestMessage.Builder.

Specified by:

build in class Message.MessageBuilder<RequestMessage.Builder>

Returns:

Instance of RequestMessage