com.oracle.iot.client.message

Class Message.MessageBuilder<T extends Message.MessageBuilder<T>>

java.lang.Object

com.oracle.iot.client.message.Message.MessageBuilder<T>

Direct Known Subclasses:

AlertMessage.Builder, DataMessage.Builder, RequestMessage.Builder, ResourceMessage.Builder, ResponseMessage.Builder

Enclosing class:

Message

public abstract static class Message.MessageBuilder<T extends Message.MessageBuilder<T>>
extends java.lang.Object

This is an abstract class for different message builders. Message classes are immutable. A builder is required when creating messages.

Constructor Summary

Constructors

Constructor and Description
MessageBuilder()

Method Summary

Modifier and Type	Method and Description
abstract Message	build() Abstract build method
T	clientId(java.lang.String id) Sets message client ID.
T	destination(java.lang.String destination) Set message destination.
T	diagnostic(java.lang.String name, java.lang.Object value) Set a diagnostic Object value
T	direction(Message.Direction direction) Set message direction.
T	eventTime(long eventTime) Set message creation time.
T	eventTime(java.lang.Long eventTime) Set message creation time.
T	fromJson(org.json.JSONObject jsonObject) Method to deserialization of the Message from a JsonObject.
T	id(java.lang.String id) Sets message ID.
T	priority(Message.Priority priority) Set message priority.
T	properties(MessageProperties properties) Set message properties.
T	receivedTime(java.lang.Long time) Set the time when the message was received by the server.
T	reliability(Message.Reliability reliability) Sets reliability for message delivering.
protected abstract T	self() Return current instance of the Message.MessageBuilder.
T	sender(java.lang.String sender) Set message sender.
T	sentTime(java.lang.Long time) Set the time when the message was sent by the server.
T	source(java.lang.String source) Set message source.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBuilder

public MessageBuilder()

Method Detail

self

protected abstract T self()

Return current instance of the Message.MessageBuilder.

Returns:

Current instance of Message.MessageBuilder.

id

public final T id(java.lang.String id)

Sets message ID. Message id is instance of UUID. If no id is provided during creation of the Message, random one is created.

Parameters:

id - UUID of the message assigned to this message.

Returns:

generic type of message builder

clientId

public final T clientId(java.lang.String id)

Sets message client ID. The client message id should be unique within the client. If no id is provided during creation of the Message, random one is created.

Parameters:

id - UUID of the message assigned to this message.

Returns:

generic type of message builder

source

public final T source(java.lang.String source)

Set message source. The value should correspond with endpoint ID where the message was originated.

Parameters:

source - source (source endpoint ID) of the message

Returns:

generic type of message builder

destination

public final T destination(java.lang.String destination)

Set message destination. The value should correspond with endpoint ID where the message should be delivered.

Parameters:

destination - destination (destination endpoint ID) of the message

Returns:

generic type of message builder

priority

public final T priority(Message.Priority priority)

Set message priority.

Parameters:

priority - priority of the message

Returns:

generic type of message builder

reliability

public final T reliability(Message.Reliability reliability)

Sets reliability for message delivering.

Parameters:

reliability - reliability for message delivering.

Returns:

generic type of the message builder

eventTime

public final T eventTime(java.lang.Long eventTime)

Set message creation time. Will be automatically set by the library to current time. Apps should only set it explicitly, if it needs to be something other than current time (for example: some historical measurement from a sensor that just got connected)

Parameters:

eventTime - event time of the message

Returns:

generic type of message builder

eventTime

public final T eventTime(long eventTime)

Set message creation time.

Parameters:

eventTime - event time of the message

Returns:

generic type of message builder

properties

public final T properties(MessageProperties properties)

Set message properties.

Parameters:

properties - extra information for the message

Returns:

generic type of message builder

sender

public final T sender(java.lang.String sender)

Set message sender. The value should correspond with endpoint ID where the message was sent from.

Parameters:

sender - sender (sender endpoint ID) of the message

Returns:

generic type of message builder

direction

public final T direction(Message.Direction direction)

Set message direction.

Parameters:

direction - message direction

Returns:

generic type of message builder

receivedTime

public final T receivedTime(java.lang.Long time)

Set the time when the message was received by the server.

Parameters:

time - epoch value in nano seconds

Returns:

generic type of message builder

sentTime

public final T sentTime(java.lang.Long time)

Set the time when the message was sent by the server.

Parameters:

time - epoch value in nano seconds

Returns:

generic type of message builder

diagnostic

public final T diagnostic(java.lang.String name,
                          java.lang.Object value)

Set a diagnostic Object value

Parameters:

name - diagnostic name

value - diagnostic value

Returns:

generic type of message builder

fromJson

public T fromJson(org.json.JSONObject jsonObject)

Method to deserialization of the Message from a JsonObject.

Parameters:

jsonObject - the jsonObject to fromString

Returns:

generic type of message builder

Throws:

MessageParsingException - when json object is wrong or does not contain mandatory fields.

build

public abstract Message build()

Abstract build method

Returns:

message