- generateIdAsString() - Static method in class com.opendxl.client.util.UuidGenerator
-
Generates and returns a random UUID that is all lowercase and has enclosing brackets
- getBrokerCaBundlePath() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the file name of a bundle containing the broker CA certificates in PEM format
- getBrokerIds() - Method in class com.opendxl.client.message.Message
-
Returns the broker identifiers that the message is to be routed to.
- getBrokerList() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the list of
Broker objects representing brokers on the DXL fabric supporting standard
MQTT connections.
- getCallbacksByTopic() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the a
Map containing the
RequestCallback instances by their associated topic.
- getClientIds() - Method in class com.opendxl.client.message.Message
-
Returns the client identifiers that the message is to be routed to
- getConfig() - Method in class com.opendxl.client.DxlClient
-
- getConnectRetries() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the maximum number of connection attempts for each
Broker specified.
- getConnectTimeout() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the connection timeout.
- getCurrentBroker() - Method in class com.opendxl.client.DxlClient
-
Returns the
Broker that the client is currently connected to.
- getDestinationTopic() - Method in class com.opendxl.client.message.Message
-
Returns the topic to publish the message to
- getDestTenantGuids() - Method in class com.opendxl.client.message.Message
-
Returns the set of tenant identifiers that the message is to be routed to.
- getDestTenantGuids() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the set of tenant identifiers that the service will be available to.
- getDisconnectTimeout() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the disconnection timeout.
- getErrorCode() - Method in enum com.opendxl.client.message.DxlErrorMessageEnum
-
Returns the error code
- getErrorCode() - Method in class com.opendxl.client.message.ErrorResponse
-
Returns the numeric error code for the error response
- getErrorMessage() - Method in enum com.opendxl.client.message.DxlErrorMessageEnum
-
Returns the error message
- getErrorMessage() - Method in class com.opendxl.client.message.ErrorResponse
-
Returns the textual error message
- getHostName() - Method in class com.opendxl.client.Broker
-
Returns the host name or IP address of the broker
- getIncomingMessageQueueSize() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the queue size for incoming messages (will block when queue is full)
- getIncomingMessageThreadPoolSize() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the thread pool size for incoming messages
- getInUseBrokerList() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the list of
Broker objects representing brokers on the DXL fabric.
- getIpAddress() - Method in class com.opendxl.client.Broker
-
Returns a valid IP address for the broker.
- getKeepAliveInterval() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the maximum period in seconds between communications with a connected
Broker.
- getKeyStore() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the KeyStore associated with the client configuration
- getMessage() - Method in exception com.opendxl.client.exception.DxlException
- getMessageId() - Method in class com.opendxl.client.message.Message
-
Returns the unique identifier for the message (UUID)
- getMessagePack() - Static method in class com.opendxl.client.message.Message
-
Returns the message pack instance to use for packing/unpacking messages
- getMessageType() - Method in class com.opendxl.client.message.ErrorResponse
-
Returns the numeric type of the message
- getMessageType() - Method in class com.opendxl.client.message.Event
-
Returns the numeric type of the message
- getMessageType() - Method in class com.opendxl.client.message.Message
-
Returns the numeric type of the message
- getMessageType() - Method in class com.opendxl.client.message.Request
-
Returns the numeric type of the message
- getMessageType() - Method in class com.opendxl.client.message.Response
-
Returns the numeric type of the message
- getMetadata() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the map of meta data associated with this service
- getOperationTimeToWait() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the time to wait for an underlying protocol operation to complete.
- getOtherFields() - Method in class com.opendxl.client.message.Message
-
Returns a Map containing the set of additional fields associated with the message.
- getPayload() - Method in class com.opendxl.client.message.Message
-
Returns the application-specific payload of the message (bytes)
- getPort() - Method in class com.opendxl.client.Broker
-
Returns the port of the broker
- getProtocol() - Method in class com.opendxl.client.Broker
-
Returns the connection protocol of the broker.
- getProxyAddress() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the HTTP proxy address
- getProxyPassword() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the the HTTP proxy password
- getProxyPort() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the HTTP proxy port
- getProxyUserName() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the HTTP proxy user name
- getReconnectBackOffMultiplier() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the exponential reconnect back off multiplier, defaults to 2
- getReconnectDelay() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the amount of time (in ms) for the first connect retry, defaults to 1000
- getReconnectDelayMax() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the maximum reconnect delay time, defaults to 60000 (one minute)
- getReconnectDelayRandom() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the randomness delay percentage (between 0.0 and 1.0).
- getReplyToTopic() - Method in class com.opendxl.client.DxlClient
-
Returns the name of the "reply-to" topic to use for communicating back to this client
(responses to requests).
- getReplyToTopic() - Method in class com.opendxl.client.message.Request
-
- getRequest() - Method in class com.opendxl.client.message.Response
-
Returns the
Request message that this is a response for
- getRequestMessageId() - Method in class com.opendxl.client.message.Response
-
Returns the unique identifier (UUID) for the
Request message that this message is a response for.
- getResponseTime() - Method in class com.opendxl.client.Broker
-
Returns the response time for the broker (essentially the ping time)
- getServiceId() - Method in class com.opendxl.client.message.Request
-
Returns the identifier of the service that this request will be routed to.
- getServiceId() - Method in class com.opendxl.client.message.Response
-
Returns the identifier of the service that sent this response (the service that the corresponding
Request was routed to).
- getServiceId() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns a unique identifier for the service instance (automatically generated when the
ServiceRegistrationInfo object is constructed
- getServiceType() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the a textual name for the service.
- getSourceBrokerId() - Method in class com.opendxl.client.message.Message
-
Returns the identifier of the DXL broker that the message's originating client is connected to (set by the
initial broker)
- getSourceClientId() - Method in class com.opendxl.client.message.Message
-
Returns the identifier of the DXL client that sent the message (set by the broker that initially receives
the message)
- getSourceClientInstanceId() - Method in class com.opendxl.client.message.Message
-
Returns the instance identifier for the client that is the source of the message
- getSourceTenantGuid() - Method in class com.opendxl.client.message.Message
-
Returns the tenant identifier of the DXL client that sent the message (set by the broker that initially
receives the message)
- getSubscriptions() - Method in class com.opendxl.client.DxlClient
-
Returns a Set containing the topics that the client is currently subscribed to
- getTopics() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns a Set containing the topics that the service responds to
- getTtl() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the interval (in minutes unless the resolution has been modified) at which the client will automatically
re-register the service with the DXL fabric (defaults to 60 minutes).
- getTtlMins() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the interval (in minutes) at which the client will automatically re-register the service with the DXL
fabric (defaults to 60 minutes).
- getTtlResolution() - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Returns the Time-To-Live (TTL) resolution factor (by default is 1, minutes)
- getUniqueId() - Method in class com.opendxl.client.Broker
-
Returns a unique identifier for the broker, used to identify the broker in log messages, etc.
- getUniqueId() - Method in class com.opendxl.client.DxlClient
-
Returns the unique identifier of the client instance
- getUniqueId() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the unique identifier of the client instance
- getVersion() - Method in class com.opendxl.client.message.Message
-
Returns the version of the DXL message (used to determine the features that are available)
- getWebSocketBrokers() - Method in class com.opendxl.client.DxlClientConfig
-
Returns the list of
Broker objects representing brokers on the DXL fabric supporting DXL connections
over WebSockets.
- sendEvent(Event) - Method in class com.opendxl.client.DxlClient
-
Attempts to deliver the specified
Event message to the DXL fabric.
- sendResponse(Response) - Method in class com.opendxl.client.DxlClient
-
Attempts to deliver the specified
Response message to the DXL fabric.
- ServiceRegistrationInfo - Class in com.opendxl.client
-
Service Registration instances are used to register and expose services onto a DXL fabric.
- ServiceRegistrationInfo(DxlClient, String) - Constructor for class com.opendxl.client.ServiceRegistrationInfo
-
- setBrokerIds(Set<String>) - Method in class com.opendxl.client.message.Message
-
Sets the broker identifiers that the message is to be routed to.
- setClientIds(Set<String>) - Method in class com.opendxl.client.message.Message
-
Sets the client identifiers that the message is to be routed to.
- setConnectRetries(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the maximum number of connection attempts for each
Broker specified.
- setConnectTimeout(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the connection timeout.
- setDestinationTopic(String) - Method in class com.opendxl.client.message.Message
-
Sets the topic to publish the message to
- setDestTenantGuids(Set<String>) - Method in class com.opendxl.client.message.Message
-
Sets the tenant identifiers that the message is to be routed to.
- setDestTenantGuids(Set<String>) - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Sets the tenant identifiers that the service will be available to.
- setDisconnectedStrategy(DisconnectedStrategy) - Method in class com.opendxl.client.DxlClient
-
Sets the strategy to use if the client becomes unexpectedly disconnected from the broker.
- setDisconnectTimeout(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the disconnection timeout.
- setHostName(String) - Method in class com.opendxl.client.Broker
-
Sets the host name or IP address of the broker
- setHttpsHostnameVerificationEnabled(boolean) - Method in class com.opendxl.client.DxlClientConfig
-
Sets whether the client should do SSL host name verification when connecting to a broker.
- setIncomingMessageQueueSize(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the queue size for incoming messages (will block when queue is full)
- setIncomingMessageThreadPoolSize(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the thread pool size for incoming messages
- setInfiniteReconnectRetries(boolean) - Method in class com.opendxl.client.DxlClientConfig
-
Sets whether the client should infinitely retry to reconnect when it gets disconnected
- setIpAddress(String) - Method in class com.opendxl.client.Broker
-
Sets the IP address for the broker
- setKeepAliveInterval(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the maximum period in seconds between communications with a connected
Broker.
- setMetadata(Map<String, String>) - Method in class com.opendxl.client.ServiceRegistrationInfo
-
A Map of name-value pairs that are sent as part of the service registration.
- setOperationTimeToWait(long) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the time to wait for an underlying protocol operation to complete.
- setOtherFields(Map<String, String>) - Method in class com.opendxl.client.message.Message
-
Sets a Map containing the set of additional fields associated with the message.
- setPayload(byte[]) - Method in class com.opendxl.client.message.Message
-
The payload for the message
- setPort(int) - Method in class com.opendxl.client.Broker
-
Set the port of the broker
- setProtocol(String) - Method in class com.opendxl.client.Broker
-
Set the connection protocol of the broker.
- setProxyAddress(String) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the HTTP proxy address
- setProxyPassword(char[]) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the the HTTP proxy password
- setProxyPort(int) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the HTTP proxy port
- setProxyUserName(String) - Method in class com.opendxl.client.DxlClientConfig
-
Sets the HTTP proxy user name
- setReconnectBackOffMultiplier(int) - Method in class com.opendxl.client.DxlClientConfig
-
The exponential reconnect back off multiplier, defaults to 2
- setReconnectDelay(int) - Method in class com.opendxl.client.DxlClientConfig
-
The amount of time (in ms) for the first connect retry, defaults to 1000
- setReconnectDelayMax(long) - Method in class com.opendxl.client.DxlClientConfig
-
The maximum reconnect delay time, defaults to 60000 (one minute)
- setReconnectDelayRandom(float) - Method in class com.opendxl.client.DxlClientConfig
-
Sets a randomness delay percentage (between 0.0 and 1.0).
- setReplyToTopic(String) - Method in class com.opendxl.client.message.Request
-
- setServiceId(String) - Method in class com.opendxl.client.message.Request
-
Sets the identifier of the service that this request will be routed to.
- setSocketFactory(SSLSocketFactory) - Method in class com.opendxl.client.DxlClient
-
Sets the SSL socket factory
- setSourceClientId(String) - Method in class com.opendxl.client.message.Message
-
Sets the identifier of the DXL client that sent the message (set by the broker that initially receives
the message)
- setSourceClientInstanceId(String) - Method in class com.opendxl.client.message.Message
-
Sets the instance identifier for the client that is the source of the message
- setSourceTenantGuid(String) - Method in class com.opendxl.client.message.Message
-
Sets the tenant identifier of the DXL client that sent the message (set by the broker that initially receives
the message)
- setTtl(long) - Method in class com.opendxl.client.ServiceRegistrationInfo
-
Sets the interval (in minutes unless the resolution has been modified) at which the client will automatically
re-register the service with the DXL fabric (defaults to 60 minutes).
- setUniqueId(String) - Method in class com.opendxl.client.Broker
-
Sets the unique identifier for the broker, used to identify the broker in log messages, etc.
- setUniqueId(String) - Method in class com.opendxl.client.DxlClientConfig
-
Overwrites the unique identifier of the client with a new UUID.
- setUseWebSockets(boolean) - Method in class com.opendxl.client.DxlClientConfig
-
Sets whether the client should use WebSockets or regular MQTT over tcp when connecting to a
Broker
- setWebSocketBrokers(List<Broker>) - Method in class com.opendxl.client.DxlClientConfig
-
Set the list of
Broker objects representing brokers on the DXL fabric supporting DXL connections
over WebSockets.
- SSL_PROTOCOL - Static variable in class com.opendxl.client.Broker
-
Constant for ssl protocol
- subscribe(String) - Method in class com.opendxl.client.DxlClient
-
Subscribes to the specified topic on the DXL fabric.
- syncRequest(Request) - Method in class com.opendxl.client.DxlClient
-
Sends a
Request message to a remote DXL service.
- syncRequest(Request, long) - Method in class com.opendxl.client.DxlClient
-
Sends a
Request message to a remote DXL service.
- SYSPROP_ASYNC_CALLBACK_CHECK_INTERVAL - Static variable in class com.opendxl.client.Constants
-
The system property for specifying the interval for checking async callbacks for timeout
- SYSPROP_CONNECT_RETRIES - Static variable in class com.opendxl.client.Constants
-
The system property for specifying connect retries
- SYSPROP_CONNECT_TIMEOUT - Static variable in class com.opendxl.client.Constants
-
The system property for specifying connection timeout (in ms)
- SYSPROP_DEFAULT_WAIT - Static variable in class com.opendxl.client.Constants
-
The system property for specifying the default wait time (for sync request, etc.)
- SYSPROP_DISABLE_DISCONNECTED_STRATEGY - Static variable in class com.opendxl.client.Constants
-
This system property can be set to false if the reconnect behavior should be disabled when the client
is unexpectedly disconnected from the broker.
- SYSPROP_INCOMING_MESSAGE_QUEUE_SIZE - Static variable in class com.opendxl.client.Constants
-
The thread pool queue size to handle incoming messages
- SYSPROP_INCOMING_MESSAGE_THREAD_POOL_SIZE - Static variable in class com.opendxl.client.Constants
-
The thread pool size to handle incoming messages
- SYSPROP_MAX_RECONNECT_DELAY - Static variable in class com.opendxl.client.Constants
-
The system property for specifying the maximum reconnect delay
- SYSPROP_MQTT_KEEP_ALIVE_INTERVAL - Static variable in class com.opendxl.client.Constants
-
The system property for a keep alive interval (minutes) (client pings broker at interval)
- SYSPROP_RECONNECT_BACK_OFF_MULTIPLIER - Static variable in class com.opendxl.client.Constants
-
The system property for specifying the reconnect back off multiplier
- SYSPROP_RECONNECT_DELAY - Static variable in class com.opendxl.client.Constants
-
The system property for the amount of time (in ms) for the first connect retry
- SYSPROP_RECONNECT_DELAY_RANDOM - Static variable in class com.opendxl.client.Constants
-
The system property for specifying the reconnect delay randomness
- SYSPROP_SERVICE_TTL_DEFAULT - Static variable in class com.opendxl.client.Constants
-
This system property defines the default Time-To-Live (TTL) of the service registration
- SYSPROP_SERVICE_TTL_GRACE_PERIOD - Static variable in class com.opendxl.client.Constants
-
This system property defines the Time-To-Live (TTL) grace period of the service registration
- SYSPROP_SERVICE_TTL_LOWER_LIMIT - Static variable in class com.opendxl.client.Constants
-
This system property defines the minimum Time-To-Live (TTL) of the service registration
- SYSPROP_SERVICE_TTL_RESOLUTION - Static variable in class com.opendxl.client.Constants
-
This system property defines the Time-To-Live (TTL) resolution (FOR TESTING ONLY)