Skip navigation links
A B C D F G H I K L M N O P R S T U V 

A

ACCESS_POINTS - Static variable in interface io.openmessaging.OMSBuiltinKeys
The ACCESS_POINTS key shows the specified access points in OMS driver schema.
ACCOUNT_ID - Static variable in interface io.openmessaging.OMSBuiltinKeys
The ACCOUNT_ID key shows the specified account info in OMS driver schema.
ack(String) - Method in interface io.openmessaging.consumer.Consumer
Acknowledges the specified and consumed message with the unique message receipt handle, in the scenario of using manual commit.
ack() - Method in interface io.openmessaging.consumer.MessageListener.Context
Acknowledges the specified and consumed message, which is related to this MessageContext.
addInterceptor(ConsumerInterceptor) - Method in interface io.openmessaging.consumer.Consumer
Adds a ConsumerInterceptor instance to this consumer.
addInterceptor(ProducerInterceptor) - Method in interface io.openmessaging.producer.Producer
Adds a ProducerInterceptor to intercept send operations of producer.
addListener(FutureListener<V>) - Method in interface io.openmessaging.Future
Adds the specified listener to this future.
attributes() - Method in interface io.openmessaging.interceptor.Context
Returns the attributes of this Context instance.
attributes() - Method in interface io.openmessaging.MessagingAccessPoint
Returns the attributes of this MessagingAccessPoint instance.

B

bindQueue(String) - Method in interface io.openmessaging.consumer.Consumer
Bind the Consumer to a specified queue in pull model, user can use Consumer.receive(long) to get message from bind queue.
bindQueue(String, MessageListener) - Method in interface io.openmessaging.consumer.Consumer
Bind the Consumer to a specified queue, with a MessageListener.

C

cancel(boolean) - Method in interface io.openmessaging.Promise
Attempts to cancel execution of this task.
check(Message, TransactionStateCheckListener.TransactionalContext) - Method in interface io.openmessaging.producer.TransactionStateCheckListener
Checks the status of the local transaction branch.
commit() - Method in interface io.openmessaging.producer.TransactionalResult
Commits a transaction.
commit() - Method in interface io.openmessaging.producer.TransactionStateCheckListener.TransactionalContext
Commits a transaction.
Consumer - Interface in io.openmessaging.consumer
A PushConsumer receives messages from multiple queues, these messages are pushed from MOM server to PushConsumer client.
ConsumerInterceptor - Interface in io.openmessaging.interceptor
A ConsumerInterceptor is used to intercept consume operations of push consumer.
containsKey(String) - Method in interface io.openmessaging.KeyValue
Tests if the specified String is a key in this KeyValue.
Context - Interface in io.openmessaging.interceptor
A Context is used to transfer user's business data in the interceptor.
createConsumer() - Method in interface io.openmessaging.MessagingAccessPoint
Creates a new PushConsumer for the specified MessagingAccessPoint.
createMessage(String, byte[]) - Method in interface io.openmessaging.MessageFactory
Creates a Message object.
createNamespace(String) - Method in interface io.openmessaging.manager.ResourceManager
Creates a Namespace resource with some preset attributes.
createProducer() - Method in interface io.openmessaging.MessagingAccessPoint
Creates a new Producer for the specified MessagingAccessPoint.
createProducer(TransactionStateCheckListener) - Method in interface io.openmessaging.MessagingAccessPoint
Creates a new transactional Producer for the specified MessagingAccessPoint, the producer is able to respond to requests from the server to check the status of the transaction.
createQueue(String) - Method in interface io.openmessaging.manager.ResourceManager
Creates a Queue resource in the configured namespace with some preset attributes.
currentState() - Method in interface io.openmessaging.ServiceLifecycle
Used for get service current state, for execution of some operations is dependent on the current service state.

D

deleteNamespace(String) - Method in interface io.openmessaging.manager.ResourceManager
Deletes an existing namespace.
deleteQueue(String) - Method in interface io.openmessaging.manager.ResourceManager
Deletes an existing queue resource.
DRIVER_IMPL - Static variable in interface io.openmessaging.OMSBuiltinKeys
The DRIVER_IMPL key represents the vendor implementation entry of MessagingAccessPoint.

F

filter(String, String) - Method in interface io.openmessaging.manager.ResourceManager
In order to enable consumers to get the message in the specified mode, the filter rule follows the sql standard to filter out messages.
Future<V> - Interface in io.openmessaging
A Future represents the result of an asynchronous computation.
FutureListener<V> - Interface in io.openmessaging
A listener that is called back when a Promise is done.

G

generateException(OMSResponseStatus, String...) - Static method in enum io.openmessaging.OMSResponseStatus
 
generateException(OMSResponseStatus) - Static method in enum io.openmessaging.OMSResponseStatus
 
generateException(int, String) - Static method in enum io.openmessaging.OMSResponseStatus
 
generateReasonLocation(int, String) - Static method in enum io.openmessaging.OMSResponseStatus
 
get() - Method in interface io.openmessaging.Future
Waits if necessary for the computation to complete, and then retrieves its result.
get(long) - Method in interface io.openmessaging.Future
Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
getBornHost() - Method in interface io.openmessaging.Message.Headers
getBornTimestamp() - Method in interface io.openmessaging.Message.Headers
getCompression() - Method in interface io.openmessaging.Message.Headers
getCorrelationId() - Method in interface io.openmessaging.Message.Headers
getData() - Method in interface io.openmessaging.Message
Get data from message body
getDelayTime() - Method in interface io.openmessaging.Message.Headers
getDeliveryCount() - Method in interface io.openmessaging.Message.Headers
getDestination() - Method in interface io.openmessaging.Message.Headers
getDouble(String) - Method in interface io.openmessaging.KeyValue
Searches for the double property with the specified key in this KeyValue object.
getDouble(String, double) - Method in interface io.openmessaging.KeyValue
Searches for the double property with the specified key in this KeyValue object.
getDurability() - Method in interface io.openmessaging.Message.Headers
getErrorCode() - Method in exception io.openmessaging.exception.OMSRuntimeException
Returns the error code of this OMSRuntimeException object.
getExpireTime() - Method in interface io.openmessaging.Message.Headers
getInt(String) - Method in interface io.openmessaging.KeyValue
Searches for the int property with the specified key in this KeyValue object.
getInt(String, int) - Method in interface io.openmessaging.KeyValue
Searches for the int property with the specified key in this KeyValue object.
getLong(String) - Method in interface io.openmessaging.KeyValue
Searches for the long property with the specified key in this KeyValue object.
getLong(String, long) - Method in interface io.openmessaging.KeyValue
Searches for the long property with the specified key in this KeyValue object.
getMessageId() - Method in interface io.openmessaging.Message.Headers
getMessageKey() - Method in interface io.openmessaging.Message.Headers
getMessagingAccessPoint(String) - Static method in class io.openmessaging.OMS
Returns a MessagingAccessPoint instance from the specified OMS driver url.
getMessagingAccessPoint(String, KeyValue) - Static method in class io.openmessaging.OMS
Returns a MessagingAccessPoint instance from the specified OMS driver url with some preset attributes, which will be passed to MessagingAccessPoint's implementation class as a unique constructor parameter.
getMore() - Method in enum io.openmessaging.OMSResponseStatus
 
getPriority() - Method in interface io.openmessaging.Message.Headers
getReasonPhrase() - Method in enum io.openmessaging.OMSResponseStatus
 
getShort(String) - Method in interface io.openmessaging.KeyValue
Searches for the short property with the specified key in this KeyValue object.
getShort(String, short) - Method in interface io.openmessaging.KeyValue
Searches for the short property with the specified key in this KeyValue object.
getStatusCode() - Method in enum io.openmessaging.OMSResponseStatus
 
getStoreHost() - Method in interface io.openmessaging.Message.Headers
getStoreTimestamp() - Method in interface io.openmessaging.Message.Headers
getString(String) - Method in interface io.openmessaging.KeyValue
Searches for the String property with the specified key in this KeyValue object.
getString(String, String) - Method in interface io.openmessaging.KeyValue
Searches for the String property with the specified key in this KeyValue object.
getThrowable() - Method in interface io.openmessaging.Future
Returns the cause of the failed future
getTraceId() - Method in interface io.openmessaging.Message.Headers
getTransactionId() - Method in interface io.openmessaging.Message.Headers

H

headers() - Method in interface io.openmessaging.Message
Returns all the system header fields of the Message object as a KeyValue.

I

io.openmessaging - package io.openmessaging
 
io.openmessaging.consumer - package io.openmessaging.consumer
 
io.openmessaging.exception - package io.openmessaging.exception
 
io.openmessaging.interceptor - package io.openmessaging.interceptor
 
io.openmessaging.manager - package io.openmessaging.manager
 
io.openmessaging.producer - package io.openmessaging.producer
 
isCancelled() - Method in interface io.openmessaging.Future
Returns true if this task was cancelled before it completed normally.
isDone() - Method in interface io.openmessaging.Future
Returns true if this task completed.
isSuspended() - Method in interface io.openmessaging.consumer.Consumer
This method is used to find out whether the Consumer in push model is suspended.

K

keySet() - Method in interface io.openmessaging.KeyValue
Returns a Set view of the keys contained in this KeyValue object.
KeyValue - Interface in io.openmessaging
The KeyValue class represents a persistent set of attributes, which supports method chaining.

L

listNamespaces() - Method in interface io.openmessaging.manager.ResourceManager
Gets the namespace list in the current MessagingAccessPoint.
listQueues(String) - Method in interface io.openmessaging.manager.ResourceManager
Gets the queue list in the specific namespace.

M

Message - Interface in io.openmessaging
The Message interface is the root interface of all OMS messages, and the most commonly used OMS message is Message.
Message.Headers - Interface in io.openmessaging
 
MessageFactory - Interface in io.openmessaging
A factory interface for creating Message objects.
messageId() - Method in interface io.openmessaging.producer.SendResult
The unique message id related to the SendResult instance.
MessageListener - Interface in io.openmessaging.consumer
A message listener must implement this MessageListener interface and register itself to a consumer instance to asynchronously receive messages.
MessageListener.Context - Interface in io.openmessaging.consumer
 
MessagingAccessPoint - Interface in io.openmessaging
An instance of MessagingAccessPoint may be obtained from OMS, which is capable of creating Producer, Consumer, ResourceManager, and other facility entities.

N

newKeyValue() - Static method in class io.openmessaging.OMS
Returns a default and internal KeyValue implementation instance.

O

OMS - Class in io.openmessaging
The oms class provides some static methods to create a MessagingAccessPoint from the specified OMS driver url and some useful util methods.
OMSBuiltinKeys - Interface in io.openmessaging
This is the centralized source for keys that are used for OMS standard attributes.
OMSDestinationException - Exception in io.openmessaging.exception
The OMSDestinationException must be thrown when the specified destination does not exist or the destination is not readable or writable
OMSDestinationException(int, String) - Constructor for exception io.openmessaging.exception.OMSDestinationException
 
OMSDestinationException(int, Throwable) - Constructor for exception io.openmessaging.exception.OMSDestinationException
 
OMSDestinationException(int, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSDestinationException
 
OMSMessageFormatException - Exception in io.openmessaging.exception
The OMSMessageFormatException must be thrown when the provided message is not supported or the attributes are the wrong type.
OMSMessageFormatException(int, String) - Constructor for exception io.openmessaging.exception.OMSMessageFormatException
 
OMSMessageFormatException(int, Throwable) - Constructor for exception io.openmessaging.exception.OMSMessageFormatException
 
OMSMessageFormatException(int, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSMessageFormatException
 
OMSResponseStatus - Enum in io.openmessaging
This class defined OpenMessaging response status code:
OMSRuntimeException - Exception in io.openmessaging.exception
This is the root class of all unchecked exceptions in the OMS API.
OMSRuntimeException(int, String) - Constructor for exception io.openmessaging.exception.OMSRuntimeException
Constructs a OMSRuntimeException with the specified detail message and error code.
OMSRuntimeException(int, Throwable) - Constructor for exception io.openmessaging.exception.OMSRuntimeException
Constructs a OMSRuntimeException with the specified error code and cause.
OMSRuntimeException(int, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSRuntimeException
Constructs a OMSRuntimeException with the specified detail message, error code and cause.
OMSSecurityException - Exception in io.openmessaging.exception
The OMSSecurityException must be thrown when the client have no enough authority to operate an resource.
OMSSecurityException(int, String) - Constructor for exception io.openmessaging.exception.OMSSecurityException
 
OMSSecurityException(int, Throwable) - Constructor for exception io.openmessaging.exception.OMSSecurityException
 
OMSSecurityException(int, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSSecurityException
 
OMSTimeOutException - Exception in io.openmessaging.exception
The OMSTimeOutException must be thrown when a blocking operation times out.
OMSTimeOutException(int, String) - Constructor for exception io.openmessaging.exception.OMSTimeOutException
 
OMSTimeOutException(int, Throwable) - Constructor for exception io.openmessaging.exception.OMSTimeOutException
 
OMSTimeOutException(int, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSTimeOutException
 
OMSTransactionException - Exception in io.openmessaging.exception
The OMSTransactionException must be thrown when the client execute a transaction error.
OMSTransactionException(int, String) - Constructor for exception io.openmessaging.exception.OMSTransactionException
 
OMSTransactionException(int, Throwable) - Constructor for exception io.openmessaging.exception.OMSTransactionException
 
OMSTransactionException(int, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSTransactionException
 
onReceived(Message, MessageListener.Context) - Method in interface io.openmessaging.consumer.MessageListener
Callback method to receive incoming messages.
operationComplete(Future<V>) - Method in interface io.openmessaging.FutureListener
Invoked when the operation completes, be the associated Promise successful or not.

P

postReceive(Message, Context) - Method in interface io.openmessaging.interceptor.ConsumerInterceptor
postSend(Message, Context) - Method in interface io.openmessaging.interceptor.ProducerInterceptor
Invoked immediately after the successful send invocation.
prepare(Message) - Method in interface io.openmessaging.producer.Producer
Sends a transactional message to the specified destination synchronously, the destination should be preset to Message.headers(), other header fields as well.
preReceive(Message, Context) - Method in interface io.openmessaging.interceptor.ConsumerInterceptor
preSend(Message, Context) - Method in interface io.openmessaging.interceptor.ProducerInterceptor
Invoked before the message is actually sent to the network.
Producer - Interface in io.openmessaging.producer
A Producer is a simple object used to send messages on behalf of a MessagingAccessPoint.
ProducerInterceptor - Interface in io.openmessaging.interceptor
A ProducerInterceptor is used to intercept send operations of producer.
Promise<V> - Interface in io.openmessaging
Special Future which is writable.
properties() - Method in interface io.openmessaging.Message
Returns all the customized user header fields of the Message object as a KeyValue.
put(String, short) - Method in interface io.openmessaging.KeyValue
Inserts or replaces short value for the specified key.
put(String, int) - Method in interface io.openmessaging.KeyValue
Inserts or replaces int value for the specified key.
put(String, long) - Method in interface io.openmessaging.KeyValue
Inserts or replaces long value for the specified key.
put(String, double) - Method in interface io.openmessaging.KeyValue
Inserts or replaces double value for the specified key.
put(String, String) - Method in interface io.openmessaging.KeyValue
Inserts or replaces String value for the specified key.

R

receive(long) - Method in interface io.openmessaging.consumer.Consumer
Receives the next message from the bind queues of this consumer in pull model.
REGION - Static variable in interface io.openmessaging.OMSBuiltinKeys
The REGION key shows the specified region in OMS driver schema.
removeInterceptor(ConsumerInterceptor) - Method in interface io.openmessaging.consumer.Consumer
Removes an interceptor from this consumer.
removeInterceptor(ProducerInterceptor) - Method in interface io.openmessaging.producer.Producer
Removes a ProducerInterceptor.
ResourceManager - Interface in io.openmessaging.manager
The ResourceManager is to provide a unified interface of resource management, allowing developers to manage the namespace, queue and routing resources.
resourceManager() - Method in interface io.openmessaging.MessagingAccessPoint
Gets a lightweight ResourceManager instance from the specified MessagingAccessPoint.
resume() - Method in interface io.openmessaging.consumer.Consumer
Resumes the Consumer in push model after a suspend.
rollback() - Method in interface io.openmessaging.producer.TransactionalResult
Rolls back a transaction.
rollback() - Method in interface io.openmessaging.producer.TransactionStateCheckListener.TransactionalContext
Rolls back a transaction.
routing(String, String) - Method in interface io.openmessaging.manager.ResourceManager
Routing from sourceQueue to targetQueue.

S

send(Message) - Method in interface io.openmessaging.producer.Producer
Sends a message to the specified destination synchronously, the destination should be preset to Message.headers(), other header fields as well.
send(List<Message>) - Method in interface io.openmessaging.producer.Producer
Send batch messages to server.
sendAsync(Message) - Method in interface io.openmessaging.producer.Producer
Sends a message to the specified destination asynchronously, the destination should be preset to Message.headers(), other header fields as well.
sendOneway(Message) - Method in interface io.openmessaging.producer.Producer
There is no Promise related or RuntimeException thrown.
SendResult - Interface in io.openmessaging.producer
The result of sending a OMS message to server with the message id and some attributes.
ServiceLifecycle - Interface in io.openmessaging
The ServiceLifecycle defines a lifecycle interface for a OMS related service endpoint, like Producer, Consumer, and so on.
ServiceLifeState - Enum in io.openmessaging
A collection of all service states.
set(V) - Method in interface io.openmessaging.Promise
Set the value to this promise and mark it completed if set successfully.
setBornHost(String) - Method in interface io.openmessaging.Message.Headers
The BORN_HOST header field contains the born host info of a message in client side.
setBornTimestamp(long) - Method in interface io.openmessaging.Message.Headers
The BORN_TIMESTAMP header field contains the time a message was handed off to a Producer to be sent.
setCompression(short) - Method in interface io.openmessaging.Message.Headers
The field COMPRESSION in headers represents the message body compress algorithm.
setCorrelationId(String) - Method in interface io.openmessaging.Message.Headers
A client can use the CORRELATION_ID field to link one message with another.
setData(byte[]) - Method in interface io.openmessaging.Message
Set data to message body
setDelayTime(long) - Method in interface io.openmessaging.Message.Headers
The DELAY_TIME header field contains a number that represents the delayed times in milliseconds.
setDeliveryCount(int) - Method in interface io.openmessaging.Message.Headers
The DELIVERY_COUNT header field contains a number, which represents the count of the message delivery.
setDestination(String) - Method in interface io.openmessaging.Message.Headers
The DESTINATION header field contains the destination to which the message is being sent.
setDurability(short) - Method in interface io.openmessaging.Message.Headers
The RELIABILITY header field contains the reliability level of a message, the vendor should guarantee the reliability level for a message.
setExpireTime(long) - Method in interface io.openmessaging.Message.Headers
The EXPIRE_TIME header field contains the expiration time, it represents a time-to-live value.
setFailure(Throwable) - Method in interface io.openmessaging.Promise
Marks this promise as a failure and notifies all listeners.
setMessageId(String) - Method in interface io.openmessaging.Message.Headers
The MESSAGE_ID header field contains a value that uniquely identifies each message sent by a Producer.
setMessageKey(String) - Method in interface io.openmessaging.Message.Headers
The messagekey header field contains the custom key of a message.
setPriority(short) - Method in interface io.openmessaging.Message.Headers
The PRIORITY header field contains the priority level of a message, a message with a higher priority value should be delivered preferentially.
setStoreHost(String) - Method in interface io.openmessaging.Message.Headers
The STORE_HOST header field contains the store host info of a message in server side.
setStoreTimestamp(long) - Method in interface io.openmessaging.Message.Headers
The STORE_TIMESTAMP header field contains the store timestamp of a message in server side.
setTraceId(String) - Method in interface io.openmessaging.Message.Headers
The TRACE_ID header field contains the trace ID of a message, which represents a global and unique identification, to associate key events in the whole lifecycle of a message, like sent by who, stored at where, and received by who.
setTransactionId(String) - Method in interface io.openmessaging.Message.Headers
This field TRANSACTION_ID is used in transactional message, and it can be used to trace a transaction.
specVersion - Static variable in class io.openmessaging.OMS
The version format is X.Y.Z (Major.Minor.Patch), a pre-release version may be denoted by appending a hyphen and a series of dot-separated identifiers immediately following the patch version, like X.Y.Z-alpha.
start() - Method in interface io.openmessaging.ServiceLifecycle
Used for startup or initialization of a service endpoint.
stop() - Method in interface io.openmessaging.ServiceLifecycle
Notify a service instance of the end of its life cycle.
suspend() - Method in interface io.openmessaging.consumer.Consumer
Suspends the Consumer in push model for later resumption.
suspend(long) - Method in interface io.openmessaging.consumer.Consumer
Suspends the Consumer in push model for later resumption.
switchNamespace(String) - Method in interface io.openmessaging.manager.ResourceManager
Switch to an existing namespace.

T

TransactionalResult - Interface in io.openmessaging.producer
The result of sending a OMS prepare message to server with the message id, this result can be used to commits or or rolls back a prepare message.
transactionId() - Method in interface io.openmessaging.producer.TransactionalResult
The unique transactionId id related to the TransactionResult instance.
TransactionStateCheckListener - Interface in io.openmessaging.producer
Each executor will be associated with a transactional message, can be used to execute local transaction branch and submit the transaction status(commit or rollback).
TransactionStateCheckListener.TransactionalContext - Interface in io.openmessaging.producer
 

U

unbindQueue(String) - Method in interface io.openmessaging.consumer.Consumer
Unbind the Consumer from a specified queue.
unknown() - Method in interface io.openmessaging.producer.TransactionStateCheckListener.TransactionalContext
Unknown transaction status, may be this transaction still on going.

V

valueOf(String) - Static method in enum io.openmessaging.OMSResponseStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.openmessaging.ServiceLifeState
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.openmessaging.OMSResponseStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.openmessaging.ServiceLifeState
Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in interface io.openmessaging.MessagingAccessPoint
Returns the target OMS specification version of the specified vendor implementation.
A B C D F G H I K L M N O P R S T U V 
Skip navigation links

Copyright © 2017–2018 OpenMessaging. All rights reserved.