com.oracle.iot.client.message

Class ResponseMessage.Builder

java.lang.Object

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

com.oracle.iot.client.message.ResponseMessage.Builder

Enclosing class:

ResponseMessage

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(RequestMessage requestMessage)

Method Summary

Modifier and Type	Method and Description
ResponseMessage.Builder	body(byte[] body) Set message body.
ResponseMessage.Builder	body(java.lang.String body) Set message body using a String.
ResponseMessage	build() Creates new instance of ResponseMessage using values from ResponseMessage.Builder.
ResponseMessage.Builder	contentType(java.lang.String contentType) A convenience method for setting the "Content-Type" header to the specified value.
ResponseMessage.Builder	fromJson(org.json.JSONObject jsonObject) Method to deserialization of the Message from a JsonObject.
ResponseMessage.Builder	header(java.lang.String name, java.util.List<java.lang.String> values) Add message header.
ResponseMessage.Builder	requestId(java.lang.String requestId) Sets the Id of RequestMessage for that this response was created.
protected ResponseMessage.Builder	self() Returns current instance of ResponseMessage.Builder.
ResponseMessage.Builder	statusCode(StatusCode statusCode) Set http response status code.
ResponseMessage.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()

Builder

public Builder(RequestMessage requestMessage)

Method Detail

header

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

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

Parameters:

name - header name

values - 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.

contentType

public final ResponseMessage.Builder contentType(java.lang.String contentType)

A convenience method for setting the "Content-Type" header to the specified value.

Parameters:

contentType - The content type to use, cannot be null. This is used literally.

Returns:

Builder with updated contentType field.

Throws:

java.lang.NullPointerException - when contentType is null.

url

public final ResponseMessage.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 ResponseMessage.Builder body(byte[] body)

Set message body.

Parameters:

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

Returns:

Builder with updated body field.

body

public final ResponseMessage.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.

statusCode

public final ResponseMessage.Builder statusCode(StatusCode statusCode)

Set http response status code.

Parameters:

statusCode - Status code for HTTP response.

Returns:

Builder with updated statusCode field.

requestId

public final ResponseMessage.Builder requestId(java.lang.String requestId)

Sets the Id of RequestMessage for that this response was created.

Parameters:

requestId - Http request message id.

Returns:

Builder with updated requestId field.

fromJson

public final ResponseMessage.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<ResponseMessage.Builder>

Parameters:

jsonObject - the jsonObject to fromString

Returns:

generic type of message builder

self

protected final ResponseMessage.Builder self()

Returns current instance of ResponseMessage.Builder.

Specified by:

self in class Message.MessageBuilder<ResponseMessage.Builder>

Returns:

Instance of ResponseMessage.Builder

build

public ResponseMessage build()

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

Specified by:

build in class Message.MessageBuilder<ResponseMessage.Builder>

Returns:

Instance of ResponseMessage