Skip navigation links
Java SE Messaging API Reference for Oracle Internet of Things Cloud Service Client Software Library. Release 21.1.1.0.0-3 E70331-25
A B C D E F G H I L M N O P Q R S T U V 

A

activate(String...) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Activate the device.
add(Resource) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Add a resource in the list
addValue(String, String) - Method in class com.oracle.iot.client.message.MessageProperties.Builder
Add a new key/vale pair.
addValues(String, List<String>) - Method in class com.oracle.iot.client.message.MessageProperties.Builder
Add a new key/values pair.
AlertMessage - Class in com.oracle.iot.client.message
AlertMessage extends Message class.
AlertMessage.Builder - Class in com.oracle.iot.client.message
AlertMessage.Severity - Enum in com.oracle.iot.client.message
The Severity of this Alert
alias() - Method in enum com.oracle.iot.client.enterprise.DeviceApp.Field
Get the alias of this Field.
alias() - Method in enum com.oracle.iot.client.message.Message.Type
 
all() - Static method in enum com.oracle.iot.client.enterprise.DeviceApp.Field
Get a new Set initialized with all possible Field values.
Argument() - Constructor for class com.oracle.iot.client.DeviceModelAction.Argument
 

B

BatchByPersistence - Class in com.oracle.iot.client.device.persistence
Support for persisting messages for guaranteed delivery.
BatchByPersistence() - Constructor for class com.oracle.iot.client.device.persistence.BatchByPersistence
Base class constructor for implementations
body(byte[]) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Set message body.
body(String) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Set message body using a String.
body(byte[]) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Set message body.
body(String) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Set message body using a String.
Bootstrapper - Class in com.oracle.iot.client.util
The Bootstrapper application is used to complete the provisioning for a an unprovisioned client.
Bootstrapper() - Constructor for class com.oracle.iot.client.util.Bootstrapper
 
build() - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Creates new instance of AlertMessage using values from AlertMessage.Builder.
build() - Method in class com.oracle.iot.client.message.DataMessage.Builder
Creates new instance of DataMessage using values from DataMessage.Builder.
build() - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Abstract build method
build() - Method in class com.oracle.iot.client.message.MessageProperties.Builder
Creates new instance of MessageProperties using values from MessageProperties.Builder.
build() - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Creates new instance of RequestMessage using values from RequestMessage.Builder.
build() - Method in class com.oracle.iot.client.message.Resource.Builder
Builds (creates) new instance of Resource.
build() - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Creates new instance of ResourceMessage using values from ResourceMessage.Builder.
build() - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse.Builder
 
build() - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Creates new instance of ResponseMessage using values from ResponseMessage.Builder.
Builder() - Constructor for class com.oracle.iot.client.message.AlertMessage.Builder
 
Builder() - Constructor for class com.oracle.iot.client.message.DataMessage.Builder
 
Builder() - Constructor for class com.oracle.iot.client.message.MessageProperties.Builder
 
Builder() - Constructor for class com.oracle.iot.client.message.RequestMessage.Builder
 
Builder() - Constructor for class com.oracle.iot.client.message.Resource.Builder
Constructor - does nothing.
Builder() - Constructor for class com.oracle.iot.client.message.ResourceMessage.Builder
 
Builder() - Constructor for class com.oracle.iot.client.message.ResourceMessage.ReportResponse.Builder
Constructor - does nothing.
Builder() - Constructor for class com.oracle.iot.client.message.ResponseMessage.Builder
 
Builder(RequestMessage) - Constructor for class com.oracle.iot.client.message.ResponseMessage.Builder
 

C

cancel(StorageObject) - Method in class com.oracle.iot.client.device.util.StorageDispatcher
Cancel the transfer of content to or from storage.
clientId(String) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Sets message client ID.
close() - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Implementation of java.io.Closeable interface required of Client
com.oracle.iot.client - package com.oracle.iot.client
 
com.oracle.iot.client.device - package com.oracle.iot.client.device
 
com.oracle.iot.client.device.persistence - package com.oracle.iot.client.device.persistence
 
com.oracle.iot.client.device.util - package com.oracle.iot.client.device.util
Utility classes that may be used with the oracle.iot.client.device package.
com.oracle.iot.client.enterprise - package com.oracle.iot.client.enterprise
 
com.oracle.iot.client.message - package com.oracle.iot.client.message
Defines messages that can be exchanged between Server and Client and vice versa.
com.oracle.iot.client.trust - package com.oracle.iot.client.trust
API for handling trust material used for activation and authentication to the Oracle IoT Cloud Service.
com.oracle.iot.client.util - package com.oracle.iot.client.util
 
containsKey(String) - Method in class com.oracle.iot.client.message.MessageProperties
Check if the properties contain the key.
contentType(String) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
A convenience method for setting the "Content-Type" header to the specified value.
copy(MessageProperties) - Method in class com.oracle.iot.client.message.MessageProperties.Builder
Copy another MessageProperties by adding all properties to the current MessageProperties
createBuilderFromJson(byte[]) - Static method in class com.oracle.iot.client.message.Message
Convert a byte array to a List of Message.MessageBuilders.
createStorageObject(String, String) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Create a new StorageObject that will have a name with the given object name prefixed with the device's endpoint ID and a directory separator.
createStorageObject(String) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Create a new StorageObject from the URI for a named object in storage.
createValue(String) - Static method in enum com.oracle.iot.client.message.Resource.Method
Returns the Method value for the String
createValue(int) - Static method in enum com.oracle.iot.client.message.Resource.Method
Returns a list of the Method values for the bit string

D

dataItem(String, double) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Add double DataItem.
dataItem(String, boolean) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Add boolean DataItem.
dataItem(String, String) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Add String DataItem.
DataItem<T> - Class in com.oracle.iot.client.message
DataItem is a key/value/type triplet for data in DataMessage along with the type of the data.
DataItem(String, double) - Constructor for class com.oracle.iot.client.message.DataItem
Constructor that takes String key and double value.
DataItem(String, boolean) - Constructor for class com.oracle.iot.client.message.DataItem
Constructor that takes String key and boolean value.
DataItem(String, String) - Constructor for class com.oracle.iot.client.message.DataItem
Constructor that takes String key and String value.
dataItem(String, double) - Method in class com.oracle.iot.client.message.DataMessage.Builder
Add double DataItem.
dataItem(String, boolean) - Method in class com.oracle.iot.client.message.DataMessage.Builder
Add boolean DataItem.
dataItem(String, String) - Method in class com.oracle.iot.client.message.DataMessage.Builder
Add String DataItem.
DataItem.Type - Enum in com.oracle.iot.client.message
The data type of the data item.
dataItems(Collection<DataItem<?>>) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Add all DataItems to existing ones.
dataItems(Collection<DataItem<?>>) - Method in class com.oracle.iot.client.message.DataMessage.Builder
Add all DataItems to existing ones.
DataMessage - Class in com.oracle.iot.client.message
DataMessage extends Message class.
DataMessage.Builder - Class in com.oracle.iot.client.message
delete(Collection<Message>) - Method in class com.oracle.iot.client.device.persistence.MessagePersistence
Delete the given collection of messages from persistent storage.
delete(Map<String, String>) - Method in interface com.oracle.iot.client.enterprise.Resource
Delete a resource of a device with the DELETE method and return a response when ready.
delete() - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Set the type of the ResourceMessage to register.
delivered(List<Message>) - Method in interface com.oracle.iot.client.device.util.MessageDispatcher.DeliveryCallback
Notify that messages have been successfully dispatched.
description(String) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Set the description for the alert
destination(String) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message destination.
DEVICE_CLASS - Static variable in class com.oracle.iot.client.device.GatewayDevice
The deviceClass attribute.
DeviceApp - Class in com.oracle.iot.client.enterprise
A DeviceApp represents an application, running on a device, and implementing its own device model.
DeviceApp() - Constructor for class com.oracle.iot.client.enterprise.DeviceApp
 
DeviceApp.Field - Enum in com.oracle.iot.client.enterprise
The Field enum defines the characteristics of a device.
DeviceAppEnumerator - Class in com.oracle.iot.client.enterprise
A DeviceAppEnumerator can be used to enumerate device applications.
DeviceAppEnumerator(EnterpriseClient) - Constructor for class com.oracle.iot.client.enterprise.DeviceAppEnumerator
Creates a message enumerator to retrieve messages.
DeviceModelAction - Class in com.oracle.iot.client
DeviceModelAction is the model of an action in a DeviceModel.
DeviceModelAction() - Constructor for class com.oracle.iot.client.DeviceModelAction
 
DeviceModelAction.Argument - Class in com.oracle.iot.client
 
DeviceModelAttribute<T> - Class in com.oracle.iot.client
DeviceModelAttribute is the model of an attribute in a DeviceModel.
DeviceModelAttribute() - Constructor for class com.oracle.iot.client.DeviceModelAttribute
 
DeviceModelAttribute.Access - Enum in com.oracle.iot.client
Access rules for an attribute.
DeviceModelAttribute.Type - Enum in com.oracle.iot.client
An enumeration of the data types an attribute may contain.
DeviceModelFormat - Class in com.oracle.iot.client
DeviceModelFormat is the model of an message in a DeviceModel.
DeviceModelFormat() - Constructor for class com.oracle.iot.client.DeviceModelFormat
 
DeviceModelFormat.Field - Interface in com.oracle.iot.client
Describes a field of a message.
DeviceModelFormat.Type - Enum in com.oracle.iot.client
The message type.
DIAG_CLIENT_ADDRESS - Static variable in class com.oracle.iot.client.message.Message
Client address diagnostic value.
DIAG_CREATED_TIME - Static variable in class com.oracle.iot.client.message.Message
Created time of the message diagnostic value.
diagnostic(String, Object) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set a diagnostic Object value
direction(Message.Direction) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message direction.
DirectlyConnectedDevice - Class in com.oracle.iot.client.device
A directly-connected device is able to send messages to, and receive messages from, the IoT server.
DirectlyConnectedDevice() - Constructor for class com.oracle.iot.client.device.DirectlyConnectedDevice
Constructs a new DirectlyConnectedDevice instance that will use a custom or default TrustedAssetsManager to store, load and handle the device configuration.
DirectlyConnectedDevice(Object) - Constructor for class com.oracle.iot.client.device.DirectlyConnectedDevice
Constructs a new DirectlyConnectedDevice instance with a platform specific context.
DirectlyConnectedDevice(String, String) - Constructor for class com.oracle.iot.client.device.DirectlyConnectedDevice
Constructs a new DirectlyConnectedDevice instance that will load the device configuration from the given file path and password.
DirectlyConnectedDevice(String, String, Object) - Constructor for class com.oracle.iot.client.device.DirectlyConnectedDevice
Constructs a new DirectlyConnectedDevice instance with a platform specific context.
DISABLE_LONG_POLLING_PROPERTY - Static variable in interface com.oracle.iot.client.trust.TrustedAssetsManager
 
dispatch(RequestMessage) - Method in class com.oracle.iot.client.device.util.RequestDispatcher
Match the request to a registered handler and invoke the handler.

E

endpointName(String) - Method in class com.oracle.iot.client.message.Resource.Builder
Sets the name or ID of the resource's endpoint.
endpointName(String) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Set the endpointName this message is for.
endpointName(String) - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse.Builder
Sets the name or ID of the resource's endpoint.
equals(Object) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Compare DirectlyConnectedDevice devices
equals(Object) - Method in class com.oracle.iot.client.message.AlertMessage
equals(Object) - Method in class com.oracle.iot.client.message.DataItem
equals(Object) - Method in class com.oracle.iot.client.message.DataMessage
equals(Object) - Method in class com.oracle.iot.client.message.Message
equals(Object) - Method in class com.oracle.iot.client.message.MessageProperties
equals(Object) - Method in class com.oracle.iot.client.message.RequestMessage
equals(Object) - Method in class com.oracle.iot.client.message.Resource
equals(Object) - Method in class com.oracle.iot.client.message.ResourceMessage
equals(Object) - Method in class com.oracle.iot.client.message.ResponseMessage
equals(Object) - Method in class com.oracle.iot.client.StorageObject
 
eventTime(Long) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message creation time.
eventTime(long) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message creation time.
ExternalObject - Class in com.oracle.iot.client
ExternalObject represents the value of a URI type in a device model.
ExternalObject(String) - Constructor for class com.oracle.iot.client.ExternalObject
Create an ExternalObject.

F

failed(List<Message>, Exception) - Method in interface com.oracle.iot.client.device.util.MessageDispatcher.ErrorCallback
Notify that an error occurred when attempting to deliver messages to the server.
format(String) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Set message format.
format(String) - Method in class com.oracle.iot.client.message.DataMessage.Builder
Set message format.
fromAlias(String) - Static method in enum com.oracle.iot.client.enterprise.DeviceApp.Field
Get the Field instance associated with the specified alias.
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
 
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.DataMessage.Builder
 
fromJson(byte[]) - Static method in class com.oracle.iot.client.message.Message
Convert a byte array to a List of Messages.
fromJson(String) - Static method in class com.oracle.iot.client.message.Message
Convert a json string to a List of Messages.
fromJson(Object) - Static method in class com.oracle.iot.client.message.Message
Convert a JSONArray or JSONObject to a List of Messages.
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Method to deserialization of the Message from a JsonObject.
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
 
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.Resource.Builder
 
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
 
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse.Builder
 
fromJson(JSONObject) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
 
fromString(String) - Method in enum com.oracle.iot.client.DeviceModelAttribute.Type
 
fromString(String) - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse.Builder
 

G

GatewayDevice - Class in com.oracle.iot.client.device
A GatewayDevice is capable of registering indirectly–connected devices and proxies messages for indirectly–connected devices.
GatewayDevice() - Constructor for class com.oracle.iot.client.device.GatewayDevice
Constructs a new GatewayDevice instance that will use a custom or default TrustedAssetsManager to store, load and handle the device configuration.
GatewayDevice(Object) - Constructor for class com.oracle.iot.client.device.GatewayDevice
Constructs a new GatewayDevice instance with a platform specific context.
GatewayDevice(String, String) - Constructor for class com.oracle.iot.client.device.GatewayDevice
Constructs a new GatewayDevice instance that will load the device configuration from the given file path and password.
GatewayDevice(String, String, Object) - Constructor for class com.oracle.iot.client.device.GatewayDevice
Constructs a new GatewayDevice instance with platform specific context.
generateKeyPair(String, int) - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Generates the key pair to be used for assertion-based client authentication with the IoT CS.
get(Map<String, String>, Map<String, String>) - Method in interface com.oracle.iot.client.enterprise.Resource
Invoke the resource GET method and return a response when ready.
getAccess() - Method in class com.oracle.iot.client.DeviceModelAttribute
Return the access rules for the attribute.
getAlias() - Method in class com.oracle.iot.client.DeviceModelAction
getAlias() - Method in class com.oracle.iot.client.DeviceModelAttribute
getAllProperties() - Method in class com.oracle.iot.client.message.MessageProperties
Get all properties.
getArgType() - Method in class com.oracle.iot.client.DeviceModelAction.Argument
The data type of the argument to the action.
getArguments() - Method in class com.oracle.iot.client.DeviceModelAction
The data type of the argument to the action.
getBitMask(List<Resource.Method>) - Static method in enum com.oracle.iot.client.message.Resource.Method
Returns a bit mask for a list of the Method values
getBody() - Method in interface com.oracle.iot.client.enterprise.Response
Get HTTP response message body.
getBody() - Method in class com.oracle.iot.client.message.RequestMessage
Get HTTP request message body.
getBody() - Method in class com.oracle.iot.client.message.ResponseMessage
Get HTTP response message body.
getBodyString() - Method in class com.oracle.iot.client.message.RequestMessage
Get HTTP request message body in String.
getBodyString() - Method in class com.oracle.iot.client.message.ResponseMessage
Get HTTP response message body in String.
getBytesTransferred() - Method in interface com.oracle.iot.client.device.util.StorageDispatcher.Progress
Get the number of bytes transferred.
getClientId() - Method in class com.oracle.iot.client.message.Message
Get client's unique ID for a message.
getClientId() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the ID of this client.
getCode() - Method in enum com.oracle.iot.client.message.StatusCode
Returns HTTP status code.
getCustomMetadata() - Method in class com.oracle.iot.client.StorageObject
This method return unmodifiable copy of metadata.
getDataItems() - Method in class com.oracle.iot.client.message.AlertMessage
Get message payload as List of DataItems.
getDataItems() - Method in class com.oracle.iot.client.message.DataMessage
Get message payload as List of DataItems.
getDate() - Method in class com.oracle.iot.client.StorageObject
Get the date and time the content was created or last modified in cloud storage.
getDBName() - Static method in class com.oracle.iot.client.device.persistence.PersistenceMetaData
By default, the database name is "persistence_store".
getDefaultValue() - Method in class com.oracle.iot.client.DeviceModelAction.Argument
Get the default value of the argument as defined by the device model.
getDefaultValue() - Method in class com.oracle.iot.client.DeviceModelAttribute
Get the default value of the attribute as defined by the device model.
getDescription() - Method in class com.oracle.iot.client.DeviceModelAction
A human friendly description of the action.
getDescription() - Method in class com.oracle.iot.client.DeviceModelAttribute
A human friendly description of the attribute.
getDescription() - Method in class com.oracle.iot.client.DeviceModelFormat
A human friendly description of the message format.
getDescription() - Method in interface com.oracle.iot.client.enterprise.Resource
Get the free form description of this resource.
getDescription() - Method in class com.oracle.iot.client.message.AlertMessage
Gets the description for this alert.
getDescription() - Method in enum com.oracle.iot.client.message.StatusCode
Returns text description of HTTP status.
getDestination() - Method in class com.oracle.iot.client.message.Message
Get message destination (Endpoint Id to which the message is originated).
getDeviceApps(Filter) - Method in class com.oracle.iot.client.enterprise.DeviceAppEnumerator
Return a Pageable collection of DeviceApp matching the specified filter.
getDeviceId() - Method in interface com.oracle.iot.client.enterprise.Resource
Get the device identifier this resource belongs to
getDeviceModel(String) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Get the DeviceModel for the device model urn.
getDeviceModels() - Method in class com.oracle.iot.client.enterprise.DeviceApp
Get the list of device models supported by this endpoint.
getDiagnostics() - Method in class com.oracle.iot.client.message.Message
Get message diagnostics
getDiagnosticValue(String) - Method in class com.oracle.iot.client.message.Message
 
getDirection() - Method in class com.oracle.iot.client.message.Message
Get message direction.
getEncoding() - Method in class com.oracle.iot.client.StorageObject
Get the compression scheme of the content.
getEncryptedSharedSecret() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Deprecated.
This method is not called by the client library
getEndpointCertificate() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the assigned endpoint certificate.
getEndpointId() - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Return the endpoint identifier of this directly-connected device.
getEndpointId() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the assigned endpoint ID.
getEndpointName() - Method in class com.oracle.iot.client.message.Resource
 
getEndpointName() - Method in class com.oracle.iot.client.message.ResourceMessage
Returns endpoint id for the message
getEndpointName() - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse
 
getErrorCode() - Method in exception com.oracle.iot.client.message.MessageParsingException
Method returns code for the current error.
getEventTime() - Method in class com.oracle.iot.client.message.Message
Get event time of the message
getFailureCause() - Method in interface com.oracle.iot.client.device.util.StorageDispatcher.Progress
Get the exception that resulted in the transfer failure.
getFields() - Method in class com.oracle.iot.client.DeviceModelFormat
Get the format of fields.
getFormat() - Method in class com.oracle.iot.client.message.AlertMessage
Get the name of the format for data.
getFormat() - Method in class com.oracle.iot.client.message.DataMessage
Get the name of the format for data.
getHeaders() - Method in interface com.oracle.iot.client.enterprise.Response
 
getHeaders() - Method in class com.oracle.iot.client.message.RequestMessage
Get Http request message headers.
getHeaders() - Method in class com.oracle.iot.client.message.ResponseMessage
Get Http response message headers.
getHeaderValue(String, int) - Method in class com.oracle.iot.client.message.RequestMessage
Get request message header value at given index.
getHeaderValue(String) - Method in class com.oracle.iot.client.message.RequestMessage
Get first value from request message header.
getHeaderValue(String, int) - Method in class com.oracle.iot.client.message.ResponseMessage
Get response message header value at given index.
getHeaderValue(String) - Method in class com.oracle.iot.client.message.ResponseMessage
Get first value from response message header.
getHeaderValues(String) - Method in class com.oracle.iot.client.message.RequestMessage
Get Http request message header values for given header name.
getHeaderValues(String) - Method in class com.oracle.iot.client.message.ResponseMessage
Get Http response message header values for given header name.
getId() - Method in class com.oracle.iot.client.enterprise.DeviceApp
Get the endpoint identifier.
getId() - Method in interface com.oracle.iot.client.enterprise.Resource
Get the resource identifier
getId() - Method in class com.oracle.iot.client.message.Message
Get unique ID for a message.
getInputStream() - Method in class com.oracle.iot.client.StorageObject
Called by the library to obtain the input stream when uploading content
getInstance() - Static method in class com.oracle.iot.client.device.persistence.BatchByPersistence
Get the batch-by persistence instance.
getInstance() - Static method in class com.oracle.iot.client.device.persistence.MessagePersistence
Get the message persistence instance.
getInstance() - Static method in class com.oracle.iot.client.device.util.RequestDispatcher
The RequestDispatcher is a singleton.
getIsolationLevel(Connection) - Static method in class com.oracle.iot.client.device.persistence.PersistenceMetaData
Get the transaction isolation level for SQL database persistence.
getKey() - Method in class com.oracle.iot.client.message.DataItem
Get data item key.
getKeys() - Method in class com.oracle.iot.client.message.MessageProperties
Get a Set of the keys.
getLength() - Method in class com.oracle.iot.client.StorageObject
Get the length of the content in bytes.
getLocalStorageDirectory() - Static method in class com.oracle.iot.client.device.persistence.PersistenceMetaData
Get the directory that is used for local persistence.
getLowerBound() - Method in class com.oracle.iot.client.DeviceModelAction.Argument
For DeviceModelAttribute.Type.NUMBER and DeviceModelAttribute.Type.INTEGER only, give the lower bound of the acceptable range of values for the action's argument.
getLowerBound() - Method in class com.oracle.iot.client.DeviceModelAttribute
For DeviceModelAttribute.Type.NUMBER only, give the lower bound of the acceptable range of values.
getMD5ofList(List<String>) - Static method in class com.oracle.iot.client.message.ResourceMessage
Calculates the MD5 hash value for a list of Strings.
getMessageDispatcher(DirectlyConnectedDevice) - Static method in class com.oracle.iot.client.device.util.MessageDispatcher
Get the instance of a MessageDispatcher for the DirectlyConnectedDevice.
getMessages(String, Message.Type, boolean, long, long) - Method in class com.oracle.iot.client.enterprise.MessageEnumerator
Returns a list of messages stored by cloud service matching the given query criteria.
getMessageType() - Method in class com.oracle.iot.client.message.ResourceMessage
Returns type of the message (Could be UPDATE or DELETE)
getMetadata() - Method in class com.oracle.iot.client.enterprise.DeviceApp
Return the endpoint metadata.
getMetadata(String) - Method in class com.oracle.iot.client.enterprise.DeviceApp
Return the value of the metadata field key.
getMethod() - Method in class com.oracle.iot.client.message.RequestMessage
Get request message method.
getMethods() - Method in interface com.oracle.iot.client.enterprise.Resource
Get the methods allowed on this resource.
getMethods() - Method in class com.oracle.iot.client.message.Resource
 
getModel() - Method in class com.oracle.iot.client.DeviceModelAttribute
Get the URN of the device type model this attribute comes from.
getName() - Method in class com.oracle.iot.client.DeviceModelAction.Argument
Get the argument name.
getName() - Method in class com.oracle.iot.client.DeviceModelAction
Get the action name.
getName() - Method in class com.oracle.iot.client.DeviceModelAttribute
Get the attribute name.
getName() - Method in interface com.oracle.iot.client.DeviceModelFormat.Field
Get the message format name.
getName() - Method in class com.oracle.iot.client.DeviceModelFormat
Get the message format name.
getName() - Method in class com.oracle.iot.client.message.Resource
 
getName() - Method in class com.oracle.iot.client.StorageObject
Get the the name of this object in the storage cloud.
getOrdinal() - Method in class com.oracle.iot.client.message.Message
Get the order in which this message was created.
getOutputStream() - Method in class com.oracle.iot.client.StorageObject
Called by the library to obtain the output stream when downloading content
getParam(String) - Method in class com.oracle.iot.client.message.RequestMessage
Get parameter value for given parameter name.
getParams() - Method in class com.oracle.iot.client.message.RequestMessage
Get Http request message parameters.
getPath() - Method in interface com.oracle.iot.client.enterprise.Response
Get request message Path.
getPath() - Method in class com.oracle.iot.client.message.Resource
 
getPriority() - Method in class com.oracle.iot.client.message.Message
Get message priority.
getProperties() - Method in class com.oracle.iot.client.message.Message
Get message properties.
getProperties(String) - Method in class com.oracle.iot.client.message.MessageProperties
Get a List of values for a particular key.
getProperty(String) - Method in class com.oracle.iot.client.message.MessageProperties
Get the first value for a particular key.
getProperty(String, int) - Method in class com.oracle.iot.client.message.MessageProperties
Get a specific value.
getPublicKey() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the public key to be used for certificate request.
getReceivedTime() - Method in class com.oracle.iot.client.message.Message
Get message received time.
getReconciliationMark() - Method in class com.oracle.iot.client.message.ResourceMessage
 
getReliability() - Method in class com.oracle.iot.client.message.Message
Get message reliability
getRemainingRetries() - Method in class com.oracle.iot.client.message.Message
Not intended for general use.
getRequestDispatcher() - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Get the RequestDispatcher that is used by this MessageDispatcher for handling RequestMessages.
getRequestHandler(String, String) - Method in class com.oracle.iot.client.device.util.RequestDispatcher
Lookup a RequestHandler for the given endpointId and path.
getRequestId() - Method in interface com.oracle.iot.client.enterprise.Response
Returns the message id of the http request that this is a response for.
getRequestId() - Method in class com.oracle.iot.client.message.ResponseMessage
Get ID of RequestMessage.
getResources() - Method in class com.oracle.iot.client.enterprise.ResourceEnumerator
Get the resources for the specified deviceId.
getResources() - Method in class com.oracle.iot.client.message.ResourceMessage
Returns List of resources described in the message.
getSender() - Method in class com.oracle.iot.client.message.Message
Get message sender (Endpoint Id from which the message is sent from).
getSentTime() - Method in class com.oracle.iot.client.message.Message
Get message sent time.
getServerHost() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the IoT CS server host name.
getServerPort() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the IoT CS server port.
getServerScheme() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the protocol scheme that should be used to talk to the IoT CS.
getSeverity() - Method in class com.oracle.iot.client.message.AlertMessage
Gets the severity of this alert
getSource() - Method in class com.oracle.iot.client.message.Message
Get message source (Endpoint Id from which the message is originated).
getState() - Method in interface com.oracle.iot.client.device.util.StorageDispatcher.Progress
Get the state of the transfer
getStatus() - Method in class com.oracle.iot.client.message.Resource
 
getStatus() - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse
 
getStatusCode() - Method in interface com.oracle.iot.client.enterprise.Response
Returns the HTTP status code
getStatusCode() - Method in class com.oracle.iot.client.message.ResponseMessage
Get Http response message status code.
getStorageDispatcher(DirectlyConnectedDevice) - Static method in class com.oracle.iot.client.device.util.StorageDispatcher
Get the StorageDispatcher for the given DirectlyConnectedDevice.
getStorageObject() - Method in interface com.oracle.iot.client.device.util.StorageDispatcher.Progress
Get the StorageObject that was queued for which this progress event pertains.
getTrustAnchorCertificates() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Retrieves the trust anchor or most-trusted Certification Authority (CA) certificates to be used to validate the IoT CS server certificate chain.
getTrustedAssetsManager(Object) - Static method in class com.oracle.iot.client.trust.TrustedAssetsManager.Factory
Loads and instantiates a custom or the default TrustedAssetsManager.
getTrustedAssetsManager(String, String, Object) - Static method in class com.oracle.iot.client.trust.TrustedAssetsManager.Factory
Loads and instantiates a custom or the default TrustedAssetsManager.
getType() - Method in class com.oracle.iot.client.DeviceModelAttribute
The data type of the attribute.
getType() - Method in interface com.oracle.iot.client.DeviceModelFormat.Field
The JSON type message.
getType() - Method in class com.oracle.iot.client.DeviceModelFormat
The type of the message.
getType() - Method in class com.oracle.iot.client.message.AlertMessage
 
getType() - Method in class com.oracle.iot.client.message.DataItem
Get data item type.
getType() - Method in class com.oracle.iot.client.message.DataMessage
Get type message type.
getType() - Method in class com.oracle.iot.client.message.Message
Abstract method to return message type.
getType() - Method in class com.oracle.iot.client.message.RequestMessage
Get message type.
getType() - Method in class com.oracle.iot.client.message.ResourceMessage
 
getType() - Method in class com.oracle.iot.client.message.ResponseMessage
Get message type.
getType() - Method in class com.oracle.iot.client.StorageObject
Get the mime-type of the content.
getUpperBound() - Method in class com.oracle.iot.client.DeviceModelAction.Argument
For DeviceModelAttribute.Type.NUMBER and DeviceModelAttribute.Type.INTEGER only, give the upper bound of the acceptable range of values for the action's argument.
getUpperBound() - Method in class com.oracle.iot.client.DeviceModelAttribute
For DeviceModelAttribute.Type.NUMBER only, give the upper bound of the acceptable range of values.
getURI() - Method in class com.oracle.iot.client.ExternalObject
Get the URI value.
getURL() - Method in interface com.oracle.iot.client.enterprise.Resource
Get the relative url to access this resource.
getURL() - Method in class com.oracle.iot.client.message.RequestMessage
Get request message URL.
getURL() - Method in class com.oracle.iot.client.message.ResponseMessage
Get request message URL.
getURN() - Method in class com.oracle.iot.client.DeviceModelFormat
Get the URN of the message format
getValue(DeviceApp.Field) - Method in class com.oracle.iot.client.enterprise.DeviceApp
Get the value of the specified field or an empty String if the value is unknown.
getValue() - Method in enum com.oracle.iot.client.message.AlertMessage.Severity
Returns severity as int value.
getValue() - Method in class com.oracle.iot.client.message.DataItem
Get data item value.
getValue() - Method in enum com.oracle.iot.client.message.DataItem.Type
Returns name of the enum value as String
getValue() - Method in enum com.oracle.iot.client.message.Message.Priority
Returns priority as int value.
getValue() - Method in enum com.oracle.iot.client.message.Message.Reliability
Returns reliability as int value.

H

handleRequest(RequestMessage) - Method in interface com.oracle.iot.client.device.util.RequestHandler
 
hashCode() - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
 
hashCode() - Method in class com.oracle.iot.client.message.AlertMessage
hashCode() - Method in class com.oracle.iot.client.message.DataItem
hashCode() - Method in class com.oracle.iot.client.message.DataMessage
hashCode() - Method in class com.oracle.iot.client.message.Message
hashCode() - Method in class com.oracle.iot.client.message.MessageProperties
hashCode() - Method in class com.oracle.iot.client.message.RequestMessage
hashCode() - Method in class com.oracle.iot.client.message.Resource
hashCode() - Method in class com.oracle.iot.client.message.ResourceMessage
hashCode() - Method in class com.oracle.iot.client.message.ResponseMessage
hashCode() - Method in class com.oracle.iot.client.StorageObject
 
header(String, List<String>) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Add Http message header.
header(String, List<String>) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Add message header.

I

id(String) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Sets message ID.
initBatchByPersistence(MessagePersistence) - Static method in class com.oracle.iot.client.device.persistence.BatchByPersistence
Initialize the batch-by persistence instance.
initMessagePersistence(Object) - Static method in class com.oracle.iot.client.device.persistence.MessagePersistence
Initialize the message persistence instance.
INVALID_MSG_TYPE - Static variable in exception com.oracle.iot.client.message.MessageParsingException
This code is assigned if the message type is not supported.
isActivated() - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Returns whether the device is activated.
isActivated() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Returns whether the client is activated.
isDone() - Method in interface com.oracle.iot.client.enterprise.Response
Call isDone to determine if the response is complete.
isOptional() - Method in interface com.oracle.iot.client.DeviceModelFormat.Field
If the field is optionalThe type message.
isPersistenceEnabled() - Static method in class com.oracle.iot.client.device.persistence.PersistenceMetaData
Get whether or not persistence is enabled.

L

listToString(List<Resource.Method>) - Static method in enum com.oracle.iot.client.message.Resource.Method
Returns String for a list of the Method values
load(String) - Method in class com.oracle.iot.client.device.persistence.MessagePersistence
Loads the set of persisted messages from disk that belongs to the subsystem identified by endpointId.

M

main(String[]) - Static method in class com.oracle.iot.client.util.Bootstrapper
 
main(String[]) - Static method in class com.oracle.iot.client.util.NetworkProvisioner
 
MANUFACTURER - Static variable in class com.oracle.iot.client.device.GatewayDevice
The manufacturer attribute.
Message - Class in com.oracle.iot.client.message
An abstract class for different types of messages in messaging server.
Message.Direction - Enum in com.oracle.iot.client.message
The message direction with respect to the device.
Message.MessageBuilder<T extends Message.MessageBuilder<T>> - Class in com.oracle.iot.client.message
This is an abstract class for different message builders.
Message.Priority - Enum in com.oracle.iot.client.message
The priority of the message.
Message.Reliability - Enum in com.oracle.iot.client.message
Reliability of the message
Message.Type - Enum in com.oracle.iot.client.message
The message type.
MessageBuilder() - Constructor for class com.oracle.iot.client.message.Message.MessageBuilder
 
MessageDispatcher - Class in com.oracle.iot.client.device.util
The MessageDispatcher queues messages for automatic dispatching to the for the Oracle IoT Cloud Service.
MessageDispatcher() - Constructor for class com.oracle.iot.client.device.util.MessageDispatcher
 
MessageDispatcher.DeliveryCallback - Interface in com.oracle.iot.client.device.util
A callback interface for successful delivery of messages.
MessageDispatcher.ErrorCallback - Interface in com.oracle.iot.client.device.util
A callback interface for errors in delivery of messages.
MessageEnumerator - Class in com.oracle.iot.client.enterprise
Provides a means to lookup messages stored by cloud service.
MessageEnumerator(EnterpriseClient) - Constructor for class com.oracle.iot.client.enterprise.MessageEnumerator
Creates a message enumerator to retrieve messages.
MessageEnumerator.MessageListener - Interface in com.oracle.iot.client.enterprise
An interface used to notify a listener when messages are received.
MessageParsingException - Exception in com.oracle.iot.client.message
MessageParsingException when an incorrect JSON interpretation of any Message is being parsed.
MessageParsingException(String) - Constructor for exception com.oracle.iot.client.message.MessageParsingException
Constructs a new runtime exception with the specified detail message.
MessageParsingException(Throwable) - Constructor for exception com.oracle.iot.client.message.MessageParsingException
Constructs a new runtime exception with the specified cause.
MessageParsingException(String, Throwable) - Constructor for exception com.oracle.iot.client.message.MessageParsingException
Constructs a new runtime exception with the specified detail message and cause.
MessagePersistence - Class in com.oracle.iot.client.device.persistence
Support for persisting messages for guaranteed delivery.
MessagePersistence() - Constructor for class com.oracle.iot.client.device.persistence.MessagePersistence
Base class constructor for implementations
MessageProperties - Class in com.oracle.iot.client.message
MessageProperties contains a table of key and list of values pairs for extra information to send.
MessageProperties.Builder - Class in com.oracle.iot.client.message
MessagePropertiesBuilder is the builder for MessageProperties.
method(String) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Set Http method.
method(Resource.Method) - Method in class com.oracle.iot.client.message.Resource.Builder
Sets the method value for the resource.
methods(List<Resource.Method>) - Method in class com.oracle.iot.client.message.Resource.Builder
Sets the method values for the resource.
MODEL_NUMBER - Static variable in class com.oracle.iot.client.device.GatewayDevice
The modelNumber attribute.

N

name(String) - Method in class com.oracle.iot.client.message.Resource.Builder
Sets the name of the resource.
NetworkProvisioner - Class in com.oracle.iot.client.util
The Network Provisioner application is used to discover the available clients that are waiting to be provisioned and send the provisioning information to the target client to enable it to complete provisioning.
NetworkProvisioner() - Constructor for class com.oracle.iot.client.util.NetworkProvisioner
 
notify(Collection<Message>) - Method in interface com.oracle.iot.client.enterprise.MessageEnumerator.MessageListener
Method called when messages are received.

O

offer(Message...) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Offer messages to be sent to the server.
offer(Message...) - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Offer messages to be queued.
offer(Message) - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Offer a message to be queued.

P

param(String, String) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Add Http parameter.
path(String) - Method in class com.oracle.iot.client.message.Resource.Builder
Sets the path of the resource.
PersistenceMetaData - Class in com.oracle.iot.client.device.persistence
Meta-data related to persistence.
poll() - Method in interface com.oracle.iot.client.enterprise.Response
This method is used to look for an available response.
post(Map<String, String>, Map<String, String>, byte[]) - Method in interface com.oracle.iot.client.enterprise.Resource
Update a resource of a device with the POST method and return a response when ready.
prettyPrintJson(JSONObject) - Static method in class com.oracle.iot.client.message.Message
 
prettyPrintJson(JSONArray) - Static method in class com.oracle.iot.client.message.Message
 
prettyPrintJson(String) - Static method in class com.oracle.iot.client.message.Message
 
prettyPrintJson(byte[]) - Static method in class com.oracle.iot.client.message.Message
 
priority(Message.Priority) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message priority.
progress(StorageDispatcher.Progress) - Method in interface com.oracle.iot.client.device.util.StorageDispatcher.ProgressCallback
Notify of progress for content transfer.
properties(MessageProperties) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message properties.
PROTOCOL - Static variable in class com.oracle.iot.client.device.GatewayDevice
The protocol attribute.
PROTOCOL_DEVICE_CLASS - Static variable in class com.oracle.iot.client.device.GatewayDevice
The protocolDeviceClass attribute.
PROTOCOL_DEVICE_ID - Static variable in class com.oracle.iot.client.device.GatewayDevice
The protocolDeviceId attribute.
put(Map<String, String>, Map<String, String>, byte[]) - Method in interface com.oracle.iot.client.enterprise.Resource
Update a resource of a device with the PUT method and returns the response when ready.

Q

queue(Message...) - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Add the messages to the outgoing message queue if it is possible to do so without violating capacity restrictions.
queue(Message) - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Add the message to the outgoing message queue if it is possible to do so without violating capacity restrictions.
queue(StorageObject) - Method in class com.oracle.iot.client.device.util.StorageDispatcher
Add a StorageObject to the queue to upload/download content to/from the Storage Cloud.

R

receive(long) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Receive a RequestMessage from the server, if any.
receivedTime(Long) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set the time when the message was received by the server.
reconcile() - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Sets the message type to RECONCILIATION.
reconciliationMark(String) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Set the reconciliation mark
register(Resource) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Sets the type of the Resource to register and adds the resource in the list
registerDevice(String, Map<String, String>, String...) - Method in class com.oracle.iot.client.device.GatewayDevice
Register an indirectly-connected device with the cloud service.
registerDevice(boolean, String, Map<String, String>, String...) - Method in class com.oracle.iot.client.device.GatewayDevice
Register an indirectly-connected device with the cloud service and specify whether the gateway device is required to have the appropriate credentials for activating the indirectly-connected device.
registerRequestHandler(String, String, RequestHandler) - Method in class com.oracle.iot.client.device.util.RequestDispatcher
Register a handler for the given endpoint and path.
reliability(Message.Reliability) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Sets reliability for message delivering.
remove(Resource) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Set the type of the Resource to remove and adds the resource in the list
removeMessageDispatcher(DirectlyConnectedDevice) - Static method in class com.oracle.iot.client.device.util.MessageDispatcher
Remove the instance of a MessageDispatcher for the DirectlyConnectedDevice.
RequestDispatcher - Class in com.oracle.iot.client.device.util
RequestDispatcher is a utility that allows the caller to register handlers for requests coming from the IoT server.
RequestHandler - Interface in com.oracle.iot.client.device.util
RequestHandler
requestId(String) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Sets the Id of RequestMessage for that this response was created.
RequestMessage - Class in com.oracle.iot.client.message
RequestMessage extends Message class.
RequestMessage.Builder - Class in com.oracle.iot.client.message
Builder extends Message.MessageBuilder class.
reset() - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Resets the trust material back to its provisioning state; in particular, the key pair is erased.
Resource - Interface in com.oracle.iot.client.enterprise
The Resource class represents a device resource.
Resource - Class in com.oracle.iot.client.message
This class represents a resource for an endpoint.
Resource.Builder - Class in com.oracle.iot.client.message
Resource class is immutable.
Resource.Method - Enum in com.oracle.iot.client.message
Method supported by a Resource
Resource.Status - Enum in com.oracle.iot.client.message
Enumeration for choosing status of the resource directory item.
ResourceEnumerator - Class in com.oracle.iot.client.enterprise
Provides means to lookup for resources of a device.
ResourceEnumerator(EnterpriseClient, String) - Constructor for class com.oracle.iot.client.enterprise.ResourceEnumerator
Creates a resource enumerator to retrieve resources of a device.
ResourceMessage - Class in com.oracle.iot.client.message
ResourceMessage extends Message class.
ResourceMessage.Builder - Class in com.oracle.iot.client.message
Builder extends MessageBuilder class.
ResourceMessage.ReportResponse - Class in com.oracle.iot.client.message
 
ResourceMessage.ReportResponse.Builder - Class in com.oracle.iot.client.message
Resource class is immutable.
ResourceMessage.ReportResponse.ResponseStatus - Enum in com.oracle.iot.client.message
 
ResourceMessage.Type - Enum in com.oracle.iot.client.message
Enumeration for choosing type of the resource directory message.
resources(List<Resource>) - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Adds all resources.
Response - Interface in com.oracle.iot.client.enterprise
A Response instance is used to retrieve the result of a request on a Resource.
ResponseMessage - Class in com.oracle.iot.client.message
ResponseMessage extends Message class.
ResponseMessage.Builder - Class in com.oracle.iot.client.message
Builder extends Message.MessageBuilder class.

S

save(Message, String) - Method in class com.oracle.iot.client.device.persistence.BatchByPersistence
Save a message to the batch-by persistence table.
save(Collection<Message>, String) - Method in class com.oracle.iot.client.device.persistence.MessagePersistence
Save the given collection of messages to persistent storage.
self() - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Returns current instance of AlertMessage.Builder.
self() - Method in class com.oracle.iot.client.message.DataMessage.Builder
Returns current instance of DataMessage.Builder.
self() - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Return current instance of the Message.MessageBuilder.
self() - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Returns current instance of RequestMessage.Builder.
self() - Method in class com.oracle.iot.client.message.ResourceMessage.Builder
Returns current instance of ResourceMessage.Builder.
self() - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Returns current instance of ResponseMessage.Builder.
send(Message...) - Method in class com.oracle.iot.client.device.DirectlyConnectedDevice
Send messages to the server.
sender(String) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message sender.
sentTime(Long) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set the time when the message was sent by the server.
SERIAL_NUMBER - Static variable in class com.oracle.iot.client.device.GatewayDevice
The serialNumber attribute.
setAttributes(String, long) - Method in class com.oracle.iot.client.StorageObject
Used internally by the client library to update fields after upload.
setCustomMetadata(String, String) - Method in class com.oracle.iot.client.StorageObject
Sets the metadata for the StorageObject.
setEndPointCredentials(String, byte[]) - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Sets the assigned endpoint ID and certificate as returned by the activation procedure.
setInputStream(InputStream) - Method in class com.oracle.iot.client.StorageObject
Set an input stream for content to be uploaded.
setListener(String, Message.Type, MessageEnumerator.MessageListener) - Method in class com.oracle.iot.client.enterprise.MessageEnumerator
Set a listener that gets notified when a message is received from the specified device.
setMessageDispatcher(DirectlyConnectedDevice, MessageDispatcher) - Static method in class com.oracle.iot.client.device.util.MessageDispatcher
Set the instance of a MessageDispatcher for the DirectlyConnectedDevice.
setOnDelivery(MessageDispatcher.DeliveryCallback) - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Set a callback to be notified if message is successfully delivered.
setOnError(MessageDispatcher.ErrorCallback) - Method in class com.oracle.iot.client.device.util.MessageDispatcher
Set a callback to be notified if there is an error in dispatching.
setOutputStream(OutputStream) - Method in class com.oracle.iot.client.StorageObject
Set an output stream for content to be downloaded.
setProgressCallback(StorageDispatcher.ProgressCallback) - Method in class com.oracle.iot.client.device.util.StorageDispatcher
Set a callback to be notified as the transfer progresses.
setRemainingRetries(int) - Method in class com.oracle.iot.client.message.Message
Not intended for general use.
setStatus(Resource.Status) - Method in class com.oracle.iot.client.message.Resource
 
severity(AlertMessage.Severity) - Method in class com.oracle.iot.client.message.AlertMessage.Builder
Set alert severity
signWithPrivateKey(byte[], String) - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Signs the provided data using the specified algorithm and the private key.
signWithSharedSecret(byte[], String, String) - Method in interface com.oracle.iot.client.trust.TrustedAssetsManager
Signs the provided data using the specified algorithm and the shared secret of the device indicated by the given hardware id.
source(String) - Method in class com.oracle.iot.client.message.Message.MessageBuilder
Set message source.
startApp(String, String[]) - Static method in class com.oracle.iot.client.util.Bootstrapper
Starts the sample application.
status(Resource.Status) - Method in class com.oracle.iot.client.message.Resource.Builder
Sets the status value for the resource.
status(ResourceMessage.ReportResponse.ResponseStatus) - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse.Builder
 
statusCode(StatusCode) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Set http response status code.
StatusCode - Enum in com.oracle.iot.client.message
Enum for handling HTTP status codes and tests.
StorageDispatcher - Class in com.oracle.iot.client.device.util
The StorageDispatcher queues content for automatic upload to, or download from, the Oracle Storage Cloud Service.
StorageDispatcher() - Constructor for class com.oracle.iot.client.device.util.StorageDispatcher
 
StorageDispatcher.Progress - Interface in com.oracle.iot.client.device.util
An object for receiving progress via the ProgressCallback.
StorageDispatcher.Progress.State - Enum in com.oracle.iot.client.device.util
 
StorageDispatcher.ProgressCallback - Interface in com.oracle.iot.client.device.util
A callback interface for monitoring progress of queued content.
StorageObject - Class in com.oracle.iot.client
StorageObject provides information about content in cloud storage.
StorageObject(String, String, String, String, String, long) - Constructor for class com.oracle.iot.client.StorageObject
Create a StorageObject.
stringToList(String) - Static method in enum com.oracle.iot.client.message.Resource.Method
Converts string of the method names into a list of the Method values.
sync() - Method in class com.oracle.iot.client.StorageObject
Synchronize content with the Storage Cloud Service.

T

TAM_CLASS_PROPERTY - Static variable in class com.oracle.iot.client.trust.TrustedAssetsManager.Factory
The system property name for configuring a custom TrustedAssetsManager implementation.
toJson() - Method in class com.oracle.iot.client.message.AlertMessage
 
toJson() - Method in class com.oracle.iot.client.message.DataMessage
Export DataMessage to JSONObject.
toJson() - Method in class com.oracle.iot.client.message.Message
Export the basic properties of the message to JSONObject.
toJson(List<? extends Message>) - Static method in class com.oracle.iot.client.message.Message
Convert a List of messages into a JSONArray.
toJson(List<Message>, boolean) - Static method in class com.oracle.iot.client.message.Message
Convert a List of Messages into a JSONArray.
toJson() - Method in class com.oracle.iot.client.message.MessageProperties
Method to export the message properties to JSONObject.
toJson() - Method in class com.oracle.iot.client.message.RequestMessage
Exports Http request message to JSONObject format.
toJson() - Method in class com.oracle.iot.client.message.Resource
 
toJson() - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse
 
toJson() - Method in class com.oracle.iot.client.message.ResourceMessage
Method to export the Resource Directory message to JSONObject.
toJson() - Method in class com.oracle.iot.client.message.ResponseMessage
Exports response message to JSONObject.
toString() - Method in class com.oracle.iot.client.message.AlertMessage
Exports data from AlertMessage to String using JSON interpretation of the message.
toString() - Method in class com.oracle.iot.client.message.DataItem
 
toString() - Method in enum com.oracle.iot.client.message.DataItem.Type
Returns name of the enum value as String
toString() - Method in class com.oracle.iot.client.message.DataMessage
Exports data from DataMessage to String using JSON interpretation of the message.
toString() - Method in class com.oracle.iot.client.message.Message
Exports common data from Message to String using JSON interpretation of the message.
toString() - Method in class com.oracle.iot.client.message.MessageProperties
Method to print the message properties in JSON format.
toString() - Method in class com.oracle.iot.client.message.RequestMessage
Exports data from RequestMessage to String using JSON interpretation of the message.
toString() - Method in class com.oracle.iot.client.message.Resource
 
toString() - Method in class com.oracle.iot.client.message.ResourceMessage.ReportResponse
 
toString() - Method in class com.oracle.iot.client.message.ResourceMessage
Exports data from ResourceMessage to String using JSON interpretation of the message.
toString() - Method in class com.oracle.iot.client.message.ResponseMessage
Exports data from RequestMessage to String using JSON interpretation of the message.
toString() - Method in enum com.oracle.iot.client.message.StatusCode
Return information about StatusCode in format: Http (code) (description).
trustedAssetsManager - Variable in class com.oracle.iot.client.device.DirectlyConnectedDevice
 
TrustedAssetsManager - Interface in com.oracle.iot.client.trust
The TrustedAssetsManager interface defines methods for handling trust material used for activation and authentication to the IoT CS.
TrustedAssetsManager.Factory - Class in com.oracle.iot.client.trust
 
TrustException - Exception in com.oracle.iot.client.trust
Thrown to indicate that a general exception occurred on a Trust Management operation.
TrustException(String) - Constructor for exception com.oracle.iot.client.trust.TrustException
Constructs a new TrustException instance with the specified detailed reason message.
TrustException(String, Throwable) - Constructor for exception com.oracle.iot.client.trust.TrustException
Constructs a new TrustException instance with the specified detailed reason message.

U

unregisterRequestHandler(String, String) - Method in class com.oracle.iot.client.device.util.RequestDispatcher
Un-register the handler for the given endpoint and path.
unregisterRequestHandler(RequestHandler) - Method in class com.oracle.iot.client.device.util.RequestDispatcher
Un-register the given handler for all endpoints and paths for which the handler may be registered.
url(String) - Method in class com.oracle.iot.client.message.RequestMessage.Builder
Set message URL.
url(String) - Method in class com.oracle.iot.client.message.ResponseMessage.Builder
Set message URL.

V

value() - Method in enum com.oracle.iot.client.message.Resource.Method
 
valueOf(String) - Static method in enum com.oracle.iot.client.device.util.StorageDispatcher.Progress.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.DeviceModelAttribute.Access
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.DeviceModelAttribute.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.DeviceModelFormat.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.enterprise.DeviceApp.Field
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.AlertMessage.Severity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.DataItem.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.Message.Direction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.Message.Priority
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.Message.Reliability
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.Message.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.Resource.Method
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.Resource.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.ResourceMessage.ReportResponse.ResponseStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.ResourceMessage.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.oracle.iot.client.message.StatusCode
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum com.oracle.iot.client.message.StatusCode
Returns instance of StatusCode for given code.
values() - Static method in enum com.oracle.iot.client.device.util.StorageDispatcher.Progress.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.DeviceModelAttribute.Access
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.DeviceModelAttribute.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.DeviceModelFormat.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.enterprise.DeviceApp.Field
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.AlertMessage.Severity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.DataItem.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.Message.Direction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.Message.Priority
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.Message.Reliability
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.Message.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.Resource.Method
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.Resource.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.ResourceMessage.ReportResponse.ResponseStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.ResourceMessage.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.oracle.iot.client.message.StatusCode
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I L M N O P Q R S T U V 
Skip navigation links
Java SE Messaging API Reference for Oracle Internet of Things Cloud Service Client Software Library. Release 21.1.1.0.0-3 E70331-25

Copyright © 2015, 2017, Oracle. All rights reserved.