Index (openmessaging-api 0.3.1-alpha 0.3.1-alpha API)

A B C D E F G H I K L M N O P R S T U

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() - Method in interface io.openmessaging.consumer.MessageListener.Context: Acknowledges the specified and consumed message, which is related to this MessageContext.
ack(String) - Method in interface io.openmessaging.consumer.PullConsumer: Acknowledges the specified and consumed message with the unique message receipt handle.
ack(String, KeyValue) - Method in interface io.openmessaging.consumer.PullConsumer: Acknowledges the specified and consumed message with the specified attributes.
addInterceptor(ConsumerInterceptor) - Method in interface io.openmessaging.consumer.PushConsumer: 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.
attachQueue(String) - Method in interface io.openmessaging.consumer.PullConsumer: Attaches the PullConsumer to a specified queue.
attachQueue(String, KeyValue) - Method in interface io.openmessaging.consumer.PullConsumer: Attaches the PullConsumer to a specified queue with some specified attributes..
attachQueue(String, MessageListener) - Method in interface io.openmessaging.consumer.PushConsumer: Attaches the PushConsumer to a specified queue, with a MessageListener.
attachQueue(String, MessageListener, KeyValue) - Method in interface io.openmessaging.consumer.PushConsumer: Attaches the PushConsumer to a specified queue, with a MessageListener and some specified attributes.
attributes() - Method in interface io.openmessaging.consumer.MessageListener.Context: Returns the attributes of this MessageContext instance.
attributes() - Method in interface io.openmessaging.consumer.PullConsumer: Returns the attributes of this PullConsumer instance.
attributes() - Method in interface io.openmessaging.consumer.PushConsumer: Returns the attributes of this PushConsumer instance.
attributes() - Method in interface io.openmessaging.consumer.StreamingConsumer: Returns the attributes of this StreamingConsumer instance.
attributes() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns the attributes of this StreamingIterator instance.
attributes() - Method in interface io.openmessaging.MessagingAccessPoint: Returns the attributes of this MessagingAccessPoint instance.
attributes() - Method in interface io.openmessaging.producer.Producer: Returns the attributes of this Producer instance.

B

BatchMessageSender - Interface in io.openmessaging.producer: A message sender created through Producer.createBatchMessageSender(), to send messages in batch manner, and commit or roll back at the appropriate time.
BORN_HOST - Static variable in interface io.openmessaging.Message.BuiltinKeys: The BORN_HOST header field contains the born host info of a message in client side.
BORN_TIMESTAMP - Static variable in interface io.openmessaging.Message.BuiltinKeys: The BORN_TIMESTAMP header field contains the time a message was handed off to a Producer to be sent.
BytesMessage - Interface in io.openmessaging: The BytesMessage contains a stream of uninterpreted bytes.

C

cancel(boolean) - Method in interface io.openmessaging.Promise: Attempts to cancel execution of this task.
check(Message, LocalTransactionExecutor.CheckContext) - Method in interface io.openmessaging.producer.LocalTransactionExecutor: Checks the status of the local transaction branch.
close() - Method in interface io.openmessaging.producer.BatchMessageSender: Close this sender.
commit() - Method in interface io.openmessaging.producer.BatchMessageSender: Commits all the uncommitted messages in this sender.
commit() - Method in interface io.openmessaging.producer.LocalTransactionExecutor.CheckContext: Commits a transaction.
commit() - Method in interface io.openmessaging.producer.LocalTransactionExecutor.ExecutionContext: Commits a transaction.
CONSUMER_ID - Static variable in interface io.openmessaging.OMSBuiltinKeys: The CONSUMER_ID key represents the the unique consumer id of a consumer instance.
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.
createBatchMessageSender() - Method in interface io.openmessaging.producer.Producer: Creates a BatchMessageSender to send message in batch manner.
createBytesMessage(String, byte[]) - Method in interface io.openmessaging.MessageFactory: Creates a BytesMessage object.
createNamespace(String, KeyValue) - Method in interface io.openmessaging.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(KeyValue) - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new Producer for the specified MessagingAccessPoint with some preset attributes.
createPullConsumer() - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new PullConsumer for the specified MessagingAccessPoint.
createPullConsumer(KeyValue) - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new PullConsumer for the specified MessagingAccessPoint with some preset attributes.
createPushConsumer() - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new PushConsumer for the specified MessagingAccessPoint.
createPushConsumer(KeyValue) - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new PushConsumer for the specified MessagingAccessPoint with some preset attributes.
createQueue(String, KeyValue) - Method in interface io.openmessaging.ResourceManager: Creates a Queue resource in the configured namespace with some preset attributes.
createRouting(String, KeyValue) - Method in interface io.openmessaging.ResourceManager: Creates a Routing resource in the configured namespace with some preset attributes.
createStreamingConsumer() - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new StreamingConsumer for the specified MessagingAccessPoint.
createStreamingConsumer(KeyValue) - Method in interface io.openmessaging.MessagingAccessPoint: Creates a new StreamingConsumer for the specified MessagingAccessPoint with some preset attributes.

D

deleteNamespace(String) - Method in interface io.openmessaging.ResourceManager: Deletes an existing namespace resource.
deleteQueue(String) - Method in interface io.openmessaging.ResourceManager: Deletes an existing queue resource.
deleteRouting(String) - Method in interface io.openmessaging.ResourceManager: Deletes an existing routing resource.
DESTINATION - Static variable in interface io.openmessaging.Message.BuiltinKeys: The DESTINATION header field contains the destination to which the message is being sent.
detachQueue(String) - Method in interface io.openmessaging.consumer.PullConsumer: Detaches the PullConsumer from a specified queue.
detachQueue(String) - Method in interface io.openmessaging.consumer.PushConsumer: Detaches the PushConsumer from a specified queue.
DRIVER_IMPL - Static variable in interface io.openmessaging.OMSBuiltinKeys: The DRIVER_IMPL key represents the vendor implementation entry of MessagingAccessPoint.

E

execute(Message, LocalTransactionExecutor.ExecutionContext) - Method in interface io.openmessaging.producer.LocalTransactionExecutor: Executes the local transaction branch after the message is sent successfully, and submits the status whether the transaction was successfully committed or rolled back.

F

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

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.
getBody(Class<T>) - Method in interface io.openmessaging.Message: Get message body
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.
getErrorCode() - Method in exception io.openmessaging.exception.OMSException: Returns the error code of this OMSException object.
getErrorCode() - Method in exception io.openmessaging.exception.OMSRuntimeException: Returns the error code of this OMSRuntimeException object.
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.
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.
getNamespaceAttributes(String) - Method in interface io.openmessaging.ResourceManager: Gets the attributes of the specific namespace.
getQueueAttributes(String) - Method in interface io.openmessaging.ResourceManager: Gets the attributes of the specified queue.
getRoutingAttributes(String) - Method in interface io.openmessaging.ResourceManager: Gets the attributes of the specified routing.
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

H

hasNext() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns true if this iterator has more messages when traversing the iterator in the forward direction.
hasPrevious() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns true if this partition iterator has more messages when traversing the iterator in the reverse direction.

I

implVersion() - Method in interface io.openmessaging.MessagingAccessPoint: Returns the target OMS specification version of the specified vendor implementation.
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.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.PushConsumer: This method is used to find out whether the PushConsumer 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.ResourceManager: Gets the namespace list in the current MessagingAccessPoint.
listQueues(String) - Method in interface io.openmessaging.ResourceManager: Gets the queue list in the specific namespace.
listRoutings(String) - Method in interface io.openmessaging.ResourceManager: Gets the routing list in the specific namespace.
listStreams(String) - Method in interface io.openmessaging.ResourceManager: Gets the stream list behind the specified queue.
LocalTransactionExecutor - 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).
LocalTransactionExecutor.CheckContext - Interface in io.openmessaging.producer
LocalTransactionExecutor.ExecutionContext - Interface in io.openmessaging.producer

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 BytesMessage.
Message.BuiltinKeys - Interface in io.openmessaging
MESSAGE_ID - Static variable in interface io.openmessaging.Message.BuiltinKeys: The MESSAGE_ID header field contains a value that uniquely identifies each message sent by a Producer.
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.
next() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns the next message in the iteration and advances the offset position.
nextPosition() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns the position of the message that would be returned by a subsequent call to StreamingIterator.next().

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.
OMSException - Exception in io.openmessaging.exception: This is the root class of all checked exceptions in the OMS API.
OMSException(String, String) - Constructor for exception io.openmessaging.exception.OMSException: Constructs a OMSException with the specified detail message and error code.
OMSException(String, Throwable) - Constructor for exception io.openmessaging.exception.OMSException: Constructs a OMSException with the specified error code and cause.
OMSException(String, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSException: Constructs a OMSException with the specified detail message, error code and cause.
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(String, String) - Constructor for exception io.openmessaging.exception.OMSMessageFormatException
OMSMessageFormatException(String, Throwable) - Constructor for exception io.openmessaging.exception.OMSMessageFormatException
OMSMessageFormatException(String, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSMessageFormatException
OMSNotSupportedException - Exception in io.openmessaging.exception: The OMSNotSupportedException must be thrown when the OMS vendor can't provide some feature defined by the standard.
OMSNotSupportedException(String, String) - Constructor for exception io.openmessaging.exception.OMSNotSupportedException
OMSNotSupportedException(String, Throwable) - Constructor for exception io.openmessaging.exception.OMSNotSupportedException
OMSNotSupportedException(String, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSNotSupportedException
OMSResourceNotExistException - Exception in io.openmessaging.exception: The OMSResourceNotExistException occurs if requested resource is not exist.
OMSResourceNotExistException(String, String) - Constructor for exception io.openmessaging.exception.OMSResourceNotExistException
OMSResourceNotExistException(String, Throwable) - Constructor for exception io.openmessaging.exception.OMSResourceNotExistException
OMSResourceNotExistException(String, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSResourceNotExistException
OMSRuntimeException - Exception in io.openmessaging.exception: This is the root class of all unchecked exceptions in the OMS API.
OMSRuntimeException(String, String) - Constructor for exception io.openmessaging.exception.OMSRuntimeException: Constructs a OMSRuntimeException with the specified detail message and error code.
OMSRuntimeException(String, Throwable) - Constructor for exception io.openmessaging.exception.OMSRuntimeException: Constructs a OMSRuntimeException with the specified error code and cause.
OMSRuntimeException(String, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSRuntimeException: Constructs a OMSRuntimeException with the specified detail message, error code and cause.
OMSTimeOutException - Exception in io.openmessaging.exception: The OMSTimeOutException must be thrown when a blocking operation times out.
OMSTimeOutException(String, String) - Constructor for exception io.openmessaging.exception.OMSTimeOutException
OMSTimeOutException(String, Throwable) - Constructor for exception io.openmessaging.exception.OMSTimeOutException
OMSTimeOutException(String, String, Throwable) - Constructor for exception io.openmessaging.exception.OMSTimeOutException
onReceived(Message, MessageListener.Context) - Method in interface io.openmessaging.consumer.MessageListener: Callback method to receive incoming messages.
OPERATION_TIMEOUT - Static variable in interface io.openmessaging.OMSBuiltinKeys: The OPERATION_TIMEOUT key defines the timeout of almost all the method calls in OMS.
operationComplete(Future<V>) - Method in interface io.openmessaging.FutureListener: Invoked when the operation completes, be the associated Promise successful or not.

P

postReceive(Message, KeyValue) - Method in interface io.openmessaging.interceptor.ConsumerInterceptor: Invoked after the invocation of MessageListener.onReceived(Message, MessageListener.Context).
postSend(Message, KeyValue) - Method in interface io.openmessaging.interceptor.ProducerInterceptor: Invoked immediately after the successful send invocation.
postSend(Message, KeyValue, OMSException) - Method in interface io.openmessaging.interceptor.ProducerInterceptor: Invoked immediately after the failed send invocation.
preReceive(Message, KeyValue) - Method in interface io.openmessaging.interceptor.ConsumerInterceptor: Invoked before the invocation of MessageListener.onReceived(Message, MessageListener.Context).
preSend(Message, KeyValue) - Method in interface io.openmessaging.interceptor.ProducerInterceptor: Invoked before the message is actually sent to the network.
previous() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns the previous message in the iteration and moves the offset position backwards.
previousPosition() - Method in interface io.openmessaging.consumer.StreamingIterator: Returns the position of the message that would be returned by a subsequent call to StreamingIterator.previous().
PRIORITY - Static variable in interface io.openmessaging.Message.BuiltinKeys: The PRIORITY header field contains the priority level of a message, a message with a higher priority value should be delivered preferentially.
Producer - Interface in io.openmessaging.producer: A Producer is a simple object used to send messages on behalf of a MessagingAccessPoint.
PRODUCER_ID - Static variable in interface io.openmessaging.OMSBuiltinKeys: The PRODUCER_ID key represents the the unique producer id of a producer instance.
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.
PullConsumer - Interface in io.openmessaging.consumer: A PullConsumer pulls messages from the specified queue, and supports submit the consume result by acknowledgement.
PushConsumer - Interface in io.openmessaging.consumer: A PushConsumer receives messages from multiple queues, these messages are pushed from MOM server to PushConsumer client.
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.
putSysHeaders(String, int) - Method in interface io.openmessaging.Message: Puts a String-int KeyValue entry to the system headers of a Message.
putSysHeaders(String, long) - Method in interface io.openmessaging.Message: Puts a String-long KeyValue entry to the system headers of a Message.
putSysHeaders(String, double) - Method in interface io.openmessaging.Message: Puts a String-double KeyValue entry to the system headers of a Message.
putSysHeaders(String, String) - Method in interface io.openmessaging.Message: Puts a String-String KeyValue entry to the system headers of a Message.
putUserHeaders(String, int) - Method in interface io.openmessaging.Message: Puts a String-int KeyValue entry to the user headers of a Message.
putUserHeaders(String, long) - Method in interface io.openmessaging.Message: Puts a String-long KeyValue entry to the user headers of a Message.
putUserHeaders(String, double) - Method in interface io.openmessaging.Message: Puts a String-double KeyValue entry to the user headers of a Message.
putUserHeaders(String, String) - Method in interface io.openmessaging.Message: Puts a String-String KeyValue entry to the user headers of a Message.

R

RECEIPT_HANDLE - Static variable in interface io.openmessaging.Message.BuiltinKeys: The RECEIPT_HANDLE header field contains an identifier associated with the act of receiving a message.
receive() - Method in interface io.openmessaging.consumer.PullConsumer: Receives the next message from the attached queues of this consumer.
receive(KeyValue) - Method in interface io.openmessaging.consumer.PullConsumer: Receives the next message from the attached queues of this consumer, using the specified attributes.
REDELIVERED_NUMBER - Static variable in interface io.openmessaging.Message.BuiltinKeys: The REDELIVERED_NUMBER header field contains a number, which represents the number of message delivery.
REDELIVERED_REASON - Static variable in interface io.openmessaging.Message.BuiltinKeys: The REDELIVERED_REASON header field contains the text description of the reason that causes the last message delivery retry.
REGION - Static variable in interface io.openmessaging.OMSBuiltinKeys: The REGION key shows the specified region in OMS driver schema.
RELIABILITY - Static variable in interface io.openmessaging.Message.BuiltinKeys: The RELIABILITY header field contains the reliability level of a message, the vendor should guarantee the reliability level for a message.
removeInterceptor(ConsumerInterceptor) - Method in interface io.openmessaging.consumer.PushConsumer: Removes an interceptor from this consumer.
removeInterceptor(ProducerInterceptor) - Method in interface io.openmessaging.producer.Producer: Removes a ProducerInterceptor
resourceManager() - Method in interface io.openmessaging.MessagingAccessPoint: Gets a lightweight ResourceManager instance from the specified MessagingAccessPoint.
ResourceManager - Interface in io.openmessaging: The ResourceManager is to provide a unified interface of resource management, allowing developers to manage the namespace, queue and routing resources.
resume() - Method in interface io.openmessaging.consumer.PushConsumer: Resumes the PushConsumer after a suspend.
rollback() - Method in interface io.openmessaging.producer.BatchMessageSender: Discards all the uncommitted messages in this sender.
rollback() - Method in interface io.openmessaging.producer.LocalTransactionExecutor.CheckContext: Rolls back a transaction.
rollback() - Method in interface io.openmessaging.producer.LocalTransactionExecutor.ExecutionContext: Rolls back a transaction.
ROUTING_DESTINATION - Static variable in interface io.openmessaging.OMSBuiltinKeys: The ROUTING_DESTINATION key shows the destination queue of a Routing instance.
ROUTING_EXPRESSION - Static variable in interface io.openmessaging.OMSBuiltinKeys: The ROUTING_EXPRESSION key shows the expression of a Routing instance.
ROUTING_SOURCE - Static variable in interface io.openmessaging.OMSBuiltinKeys: The ROUTING_SOURCE key shows the source queue of a Routing instance.

S

SCHEDULE_EXPRESSION - Static variable in interface io.openmessaging.Message.BuiltinKeys: The SCHEDULE_EXPRESSION header field contains schedule expression of a message.
SEARCH_KEYS - Static variable in interface io.openmessaging.Message.BuiltinKeys: The SEARCH_KEYS header field contains the multiple search keys of a message.
seek(String, String) - Method in interface io.openmessaging.consumer.StreamingConsumer: Creates a StreamingIterator from the fixed position of the specified stream.
seekToBeginning(String) - Method in interface io.openmessaging.consumer.StreamingConsumer: Creates a StreamingIterator from the begin position of the specified stream.
seekToEnd(String) - Method in interface io.openmessaging.consumer.StreamingConsumer: Creates a StreamingIterator from the end position of the specified stream.
send(Message) - Method in interface io.openmessaging.producer.BatchMessageSender: Submits a message to this sender
send(Message) - Method in interface io.openmessaging.producer.Producer: Sends a message to the specified destination synchronously, the destination should be preset to Message.sysHeaders(), other header fields as well.
send(Message, KeyValue) - Method in interface io.openmessaging.producer.Producer: Sends a message to the specified destination synchronously, using the specified attributes, the destination should be preset to Message.sysHeaders(), other header fields as well.
send(Message, LocalTransactionExecutor, KeyValue) - Method in interface io.openmessaging.producer.Producer: Sends a transactional message to the specified destination synchronously, using the specified attributes, the destination should be preset to Message.sysHeaders(), other header fields as well.
sendAsync(Message) - Method in interface io.openmessaging.producer.Producer: Sends a message to the specified destination asynchronously, the destination should be preset to Message.sysHeaders(), other header fields as well.
sendAsync(Message, KeyValue) - Method in interface io.openmessaging.producer.Producer: Sends a message to the specified destination asynchronously, using the specified attributes, the destination should be preset to Message.sysHeaders(), other header fields as well.
sendOneway(Message) - Method in interface io.openmessaging.producer.Producer: Sends a message to the specified destination in one way, the destination should be preset to Message.BuiltinKeys, other header fields as well.
sendOneway(Message, KeyValue) - Method in interface io.openmessaging.producer.Producer: Sends a message to the specified destination in one way, using the specified attributes, the destination should be preset to Message.BuiltinKeys, other header fields as well.
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, PushConsumer, and so on.
set(V) - Method in interface io.openmessaging.Promise: Set the value to this promise and mark it completed if set successfully.
setBody(byte[]) - Method in interface io.openmessaging.BytesMessage: Sets the bytes message body.
setFailure(Throwable) - Method in interface io.openmessaging.Promise: Marks this promise as a failure and notifies all listeners.
setNamespaceAttributes(String, KeyValue) - Method in interface io.openmessaging.ResourceManager: Sets the attributes of the specific namespace, the old attributes will be replaced by the provided attributes, only the provided key will be updated.
setQueueAttributes(String, KeyValue) - Method in interface io.openmessaging.ResourceManager: Sets the attributes of the specified queue, the old attributes will be replaced by the provided attributes, only the provided key will be updated.
setRoutingAttributes(String, KeyValue) - Method in interface io.openmessaging.ResourceManager: Sets the attributes of the specified routing, the old attributes will be replaced by the provided attributes, only the provided key will be updated.
shutdown() - Method in interface io.openmessaging.ServiceLifecycle: Notify a service instance of the end of its life cycle.
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_TIME - Static variable in interface io.openmessaging.Message.BuiltinKeys: The START_TIME header field contains the startup timestamp that a message can be delivered to consumer client.
startup() - Method in interface io.openmessaging.ServiceLifecycle: Used for startup or initialization of a service endpoint.
STOP_TIME - Static variable in interface io.openmessaging.Message.BuiltinKeys: The STOP_TIME header field contains the stop timestamp that a message should be discarded after this timestamp, and no consumer can consume this message.
STORE_HOST - Static variable in interface io.openmessaging.Message.BuiltinKeys: The STORE_HOST header field contains the store host info of a message in server side.
STORE_TIMESTAMP - Static variable in interface io.openmessaging.Message.BuiltinKeys: The STORE_TIMESTAMP header field contains the store timestamp of a message in server side.
STREAM_KEY - Static variable in interface io.openmessaging.Message.BuiltinKeys: The STREAM_KEY header field contains the stream key of a message.
StreamingConsumer - Interface in io.openmessaging.consumer: A StreamingConsumer provides low level APIs to open multiple streams from a specified queue and then retrieve messages from them through @{code StreamingIterator}.
StreamingIterator - Interface in io.openmessaging.consumer: A StreamingIterator is provided by Stream and is used to retrieve messages a specified stream like a read-only iterator.
suspend() - Method in interface io.openmessaging.consumer.PushConsumer: Suspends the PushConsumer for later resumption.
suspend(long) - Method in interface io.openmessaging.consumer.PushConsumer: Suspends the PushConsumer for later resumption.
sysHeaders() - Method in interface io.openmessaging.Message: Returns all the system header fields of the Message object as a KeyValue.

T

TIMEOUT - Static variable in interface io.openmessaging.Message.BuiltinKeys: The TIMEOUT header field contains the expiration time, it represents a time-to-live value.
TRACE_ID - Static variable in interface io.openmessaging.Message.BuiltinKeys: 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.

U

updateMessage(String, String, KeyValue) - Method in interface io.openmessaging.ResourceManager: Updates some system headers of a message in the configured namespace.
userHeaders() - Method in interface io.openmessaging.Message: Returns all the customized user header fields of the Message object as a KeyValue.

A B C D E F G H I K L M N O P R S T U