Message (Android Messaging API Reference for Oracle Internet of Things Cloud Service Client Software Library)

java.lang.Object
- com.oracle.iot.client.message.Message

Direct Known Subclasses:

AlertMessage, DataMessage, RequestMessage, ResourceMessage, ResponseMessage
```
public abstract class Message
extends java.lang.Object
```
An abstract class for different types of messages in messaging server. This class is immutable.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Message.Direction` The message direction with respect to the device.
`static class`	`Message.MessageBuilder<T extends Message.MessageBuilder<T>>` This is an abstract class for different message builders.
`static class`	`Message.Priority` The priority of the message.
`static class`	`Message.Reliability` Reliability of the message
`static class`	`Message.Type` The message type.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DIAG_CLIENT_ADDRESS` Client address diagnostic value.
`static java.lang.String`	`DIAG_CREATED_TIME` Created time of the message diagnostic value.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.List<Message.MessageBuilder>`	`createBuilderFromJson(byte[] messagesByteArray)` Convert a byte array to a `List` of `Message.MessageBuilder`s.
`boolean`	`equals(java.lang.Object o)`
`static java.util.List<Message>`	`fromJson(byte[] messagesByteArray)` Convert a byte array to a `List` of `Message`s.
`static java.util.List<Message>`	`fromJson(java.lang.Object structure)` Convert a `JSONArray` or `JSONObject` to a `List` of `Message`s.
`static java.util.List<Message>`	`fromJson(java.lang.String jsonString)` Convert a json string to a `List` of `Message`s.
`java.lang.String`	`getClientId()` Get client's unique ID for a message.
`java.lang.String`	`getDestination()` Get message destination (Endpoint Id to which the message is originated).
`java.util.Map<java.lang.String,java.lang.Object>`	`getDiagnostics()` Get message diagnostics
`java.lang.Object`	`getDiagnosticValue(java.lang.String diagName)`
`Message.Direction`	`getDirection()` Get message direction.
`java.lang.Long`	`getEventTime()` Get event time of the message
`java.lang.String`	`getId()` Get unique ID for a message.
`long`	`getOrdinal()` Get the order in which this message was created.
`Message.Priority`	`getPriority()` Get message priority.
`MessageProperties`	`getProperties()` Get message properties.
`java.lang.Long`	`getReceivedTime()` Get message received time.
`Message.Reliability`	`getReliability()` Get message reliability
`int`	`getRemainingRetries()` Not intended for general use.
`java.lang.String`	`getSender()` Get message sender (Endpoint Id from which the message is sent from).
`java.lang.Long`	`getSentTime()` Get message sent time.
`java.lang.String`	`getSource()` Get message source (Endpoint Id from which the message is originated).
`abstract Message.Type`	`getType()` Abstract method to return message type.
`int`	`hashCode()`
`static java.lang.String`	`prettyPrintJson(byte[] json)`
`static java.lang.String`	`prettyPrintJson(org.json.JSONArray json)`
`static java.lang.String`	`prettyPrintJson(org.json.JSONObject json)`
`static java.lang.String`	`prettyPrintJson(java.lang.String jsonString)`
`void`	`setRemainingRetries(int remainingRetries)` Not intended for general use.
`org.json.JSONObject`	`toJson()` Export the basic properties of the message to `JSONObject`.
`static org.json.JSONArray`	`toJson(java.util.List<? extends Message> messages)` Convert a `List` of messages into a `JSONArray`.
`static org.json.JSONArray`	`toJson(java.util.List<Message> messages, boolean expand)` Convert a `List` of `Message`s into a `JSONArray`.
`java.lang.String`	`toString()` Exports common data from `Message` to `String` using JSON interpretation of the message.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DIAG_CREATED_TIME
```
public static final java.lang.String DIAG_CREATED_TIME
```
    Created time of the message diagnostic value. The value of the created time as a Long that contains the epoch value in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DIAG_CLIENT_ADDRESS
```
public static final java.lang.String DIAG_CLIENT_ADDRESS
```
    Client address diagnostic value. The address client as a String
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
public final java.lang.String getId()
```
    Get unique ID for a message.
    
    Returns:
    
    Message id (String), never null
  - getType
```
public abstract Message.Type getType()
```
    Abstract method to return message type.
    
    Returns:
    
    type, never null.
  - getClientId
```
public final java.lang.String getClientId()
```
    Get client's unique ID for a message.
    
    Returns:
    
    Message id (String), never null
  - getSource
```
public final java.lang.String getSource()
```
    Get message source (Endpoint Id from which the message is originated).
    
    Returns:
    
    source, may be null if the message was sent from server.
  - getDestination
```
public final java.lang.String getDestination()
```
    Get message destination (Endpoint Id to which the message is originated).
    
    Returns:
    
    destination, may be null if the message was sent to server.
  - getPriority
```
public final Message.Priority getPriority()
```
    Get message priority.
    
    Returns:
    
    priority, never null.
  - getReliability
```
public final Message.Reliability getReliability()
```
    Get message reliability
    
    Returns:
    
    reliability, never null.
  - getEventTime
```
public final java.lang.Long getEventTime()
```
    Get event time of the message
    
    Returns:
    
    eventTime, never null.
  - getProperties
```
public final MessageProperties getProperties()
```
    Get message properties.
    
    Returns:
    
    properties, never null
  - getSender
```
public final java.lang.String getSender()
```
    Get message sender (Endpoint Id from which the message is sent from).
    
    Returns:
    
    sender
  - getOrdinal
```
public final long getOrdinal()
```
    Get the order in which this message was created. This information is used for sorting outgoing messages and is not transfered across the wire.
    
    Returns:
    
    the order in which the message was created
  - getRemainingRetries
```
public final int getRemainingRetries()
```
    Not intended for general use. Used internally by the message dispatcher implementation.
    
    Returns:
    
    the number of remaining retries
  - setRemainingRetries
```
public void setRemainingRetries(int remainingRetries)
```
    Not intended for general use. Used internally by the message dispatcher implementation.
    
    Parameters:
    
    remainingRetries - the new number of remaining retries
  - getDiagnostics
```
public final java.util.Map<java.lang.String,java.lang.Object> getDiagnostics()
```
    Get message diagnostics
    
    Returns:
    
    message diagnostics, can be null
  - getDiagnosticValue
```
public final java.lang.Object getDiagnosticValue(java.lang.String diagName)
```
  - getDirection
```
public final Message.Direction getDirection()
```
    Get message direction.
    
    Returns:
    
    message direction, can be null
  - getReceivedTime
```
public final java.lang.Long getReceivedTime()
```
    Get message received time.
    
    Returns:
    
    message received time, can be null
  - getSentTime
```
public final java.lang.Long getSentTime()
```
    Get message sent time.
    
    Returns:
    
    message sent time, can be null
  - toString
```
public java.lang.String toString()
```
    Exports common data from Message to String using JSON interpretation of the message.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    JSON interpretation of the message as String.
  - toJson
```
public org.json.JSONObject toJson()
```
    Export the basic properties of the message to JSONObject.
    
    Returns:
    
    message fields in JSONObject format, never null
  - toJson
```
public static org.json.JSONArray toJson(java.util.List<? extends Message> messages)
```
    Convert a List of messages into a JSONArray.
    
    Parameters:
    
    messages - The List of Messages
    
    Returns:
    
    A JSONArray representing the list of Messages, never null.
  - toJson
```
public static org.json.JSONArray toJson(java.util.List<Message> messages,
                                        boolean expand)
```
    Convert a List of Messages into a JSONArray.
    
    Parameters:
    
    messages - The List of Messages.
    
    expand - boolean flag indicating if properties to be included or not.
    
    Returns:
    
    A JSONArray representing the list of Messages
  - fromJson
```
public static java.util.List<Message> fromJson(byte[] messagesByteArray)
```
    Convert a byte array to a List of Messages.
    
    Parameters:
    
    messagesByteArray - byte[] containing json interpretation of Messages
    
    Returns:
    
    The List of Messages from the byte[]
    
    Throws:
    
    MessageParsingException - when messageArray is null.
  - fromJson
```
public static java.util.List<Message> fromJson(java.lang.String jsonString)
```
    Convert a json string to a List of Messages.
    
    Parameters:
    
    jsonString - String containing json interpretation of Messages
    
    Returns:
    
    The List of Messages from the jsonString.
    
    Throws:
    
    MessageParsingException - when jsonString is null.
  - fromJson
```
public static java.util.List<Message> fromJson(java.lang.Object structure)
```
    Convert a JSONArray or JSONObject to a List of Messages.
    
    Parameters:
    
    structure - Object containing Messages
    
    Returns:
    
    The List of Messages
    
    Throws:
    
    MessageParsingException - when structure is null or when other exception occur during parsing
  - createBuilderFromJson
```
public static java.util.List<Message.MessageBuilder> createBuilderFromJson(byte[] messagesByteArray)
```
    Convert a byte array to a List of Message.MessageBuilders.
    
    Parameters:
    
    messagesByteArray - byte[] containing json interpretation of Messages
    
    Returns:
    
    The List of Message.MessageBuilders from the byte[]
    
    Throws:
    
    MessageParsingException - when messageArray is null.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - prettyPrintJson
```
public static java.lang.String prettyPrintJson(org.json.JSONObject json)
```
  - prettyPrintJson
```
public static java.lang.String prettyPrintJson(org.json.JSONArray json)
```
  - prettyPrintJson
```
public static java.lang.String prettyPrintJson(java.lang.String jsonString)
```
  - prettyPrintJson
```
public static java.lang.String prettyPrintJson(byte[] json)
```

Class Message

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIAG_CREATED_TIME

DIAG_CLIENT_ADDRESS

Method Detail

getId

getType

getClientId

getSource

getDestination

getPriority

getReliability

getEventTime

getProperties

getSender

getOrdinal

getRemainingRetries

setRemainingRetries

getDiagnostics

getDiagnosticValue

getDirection

getReceivedTime

getSentTime

toString

toJson

toJson

toJson

fromJson

fromJson

fromJson

createBuilderFromJson

equals

hashCode

prettyPrintJson

prettyPrintJson

prettyPrintJson

prettyPrintJson