com.oracle.iot.client.message

Class ResourceMessage

java.lang.Object

com.oracle.iot.client.message.Message

com.oracle.iot.client.message.ResourceMessage

public final class ResourceMessage
extends Message

ResourceMessage extends Message class. It is used for sending sync information between Resource Directory on Gateway and Resource Directory on server. This class is immutable. { reportType: 'typeOfTheReport', reconciliationMark: 'hash for resource available on client at moment of message generation' resources: [{ path: 'pathToResource', resourceStatus: 'STATUS_OF_RESOURCE', description: 'resourceDescription', (other resource properties. TBD) }, { path: 'pathToResource', resourceStatus: 'STATUS_OF_RESOURCE', description: 'resourceDescription', (other resource properties. TBD) }, ... ] }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceMessage.Builder Builder extends MessageBuilder class.
static class	ResourceMessage.ReportResponse
static class	ResourceMessage.Type Enumeration for choosing type of the resource directory message.

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

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)
java.lang.String	getEndpointName() Returns endpoint id for the message
static java.lang.String	getMD5ofList(java.util.List<java.lang.String> resStrings) Calculates the MD5 hash value for a list of Strings.
ResourceMessage.Type	getMessageType() Returns type of the message (Could be UPDATE or DELETE)
java.lang.String	getReconciliationMark()
java.util.List<Resource>	getResources() Returns List of resources described in the message.
Message.Type	getType() Abstract method to return message type.
int	hashCode()
org.json.JSONObject	toJson() Method to export the Resource Directory message to JSONObject.
java.lang.String	toString() Exports data from ResourceMessage 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

getMD5ofList

public static java.lang.String getMD5ofList(java.util.List<java.lang.String> resStrings)

Calculates the MD5 hash value for a list of Strings. The String list is being alphabetical ordered before the calculation

Parameters:

resStrings - List os Strings

Returns:

hash value

toString

public java.lang.String toString()

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

Overrides:

toString in class Message

Returns:

JSON interpretation of the message as String.

toJson

public org.json.JSONObject toJson()

Method to export the Resource Directory message to JSONObject.

Overrides:

toJson in class Message

Returns:

JSON interpretation of ResourceMessage

getType

public Message.Type getType()

Description copied from class: Message

Abstract method to return message type.

Specified by:

getType in class Message

Returns:

type, never null.

getResources

public java.util.List<Resource> getResources()

Returns List of resources described in the message.

Returns:

List of resources, never null

getMessageType

public ResourceMessage.Type getMessageType()

Returns type of the message (Could be UPDATE or DELETE)

Returns:

RDMessageType

getReconciliationMark

public java.lang.String getReconciliationMark()

getEndpointName

public java.lang.String getEndpointName()

Returns endpoint id for the message

Returns:

endpoint id

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Message

hashCode

public int hashCode()

Overrides:

hashCode in class Message