Uses of Interface
io.openmessaging.KeyValue

Packages that use KeyValue

Package	Description
io.openmessaging
io.openmessaging.consumer
io.openmessaging.interceptor
io.openmessaging.producer

Uses of KeyValue in io.openmessaging

Methods in io.openmessaging that return KeyValue

Modifier and Type	Method and Description
KeyValue	MessagingAccessPoint.attributes() Returns the attributes of this MessagingAccessPoint instance.
KeyValue	ResourceManager.getNamespaceAttributes(String nsName) Gets the attributes of the specific namespace.
KeyValue	ResourceManager.getQueueAttributes(String queueName) Gets the attributes of the specified queue.
KeyValue	ResourceManager.getRoutingAttributes(String routingName) Gets the attributes of the specified routing.
static KeyValue	OMS.newKeyValue() Returns a default and internal KeyValue implementation instance.
KeyValue	KeyValue.put(String key, double value) Inserts or replaces double value for the specified key.
KeyValue	KeyValue.put(String key, int value) Inserts or replaces int value for the specified key.
KeyValue	KeyValue.put(String key, long value) Inserts or replaces long value for the specified key.
KeyValue	KeyValue.put(String key, String value) Inserts or replaces String value for the specified key.
KeyValue	Message.sysHeaders() Returns all the system header fields of the Message object as a KeyValue.
KeyValue	Message.userHeaders() Returns all the customized user header fields of the Message object as a KeyValue.

Methods in io.openmessaging with parameters of type KeyValue

Modifier and Type	Method and Description
void	ResourceManager.createNamespace(String nsName, KeyValue attributes) Creates a Namespace resource with some preset attributes.
Producer	MessagingAccessPoint.createProducer(KeyValue attributes) Creates a new Producer for the specified MessagingAccessPoint with some preset attributes.
PullConsumer	MessagingAccessPoint.createPullConsumer(KeyValue attributes) Creates a new PullConsumer for the specified MessagingAccessPoint with some preset attributes.
PushConsumer	MessagingAccessPoint.createPushConsumer(KeyValue attributes) Creates a new PushConsumer for the specified MessagingAccessPoint with some preset attributes.
void	ResourceManager.createQueue(String queueName, KeyValue attributes) Creates a Queue resource in the configured namespace with some preset attributes.
void	ResourceManager.createRouting(String routingName, KeyValue attributes) Creates a Routing resource in the configured namespace with some preset attributes.
StreamingConsumer	MessagingAccessPoint.createStreamingConsumer(KeyValue attributes) Creates a new StreamingConsumer for the specified MessagingAccessPoint with some preset attributes.
static MessagingAccessPoint	OMS.getMessagingAccessPoint(String url, KeyValue attributes) 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.
void	ResourceManager.setNamespaceAttributes(String nsName, KeyValue attributes) Sets the attributes of the specific namespace, the old attributes will be replaced by the provided attributes, only the provided key will be updated.
void	ResourceManager.setQueueAttributes(String queueName, KeyValue attributes) Sets the attributes of the specified queue, the old attributes will be replaced by the provided attributes, only the provided key will be updated.
void	ResourceManager.setRoutingAttributes(String routingName, KeyValue attributes) Sets the attributes of the specified routing, the old attributes will be replaced by the provided attributes, only the provided key will be updated.
void	ResourceManager.updateMessage(String queueName, String messageId, KeyValue headers) Updates some system headers of a message in the configured namespace.

Uses of KeyValue in io.openmessaging.consumer

Methods in io.openmessaging.consumer that return KeyValue

Modifier and Type	Method and Description
KeyValue	StreamingConsumer.attributes() Returns the attributes of this StreamingConsumer instance.
KeyValue	StreamingIterator.attributes() Returns the attributes of this StreamingIterator instance.
KeyValue	PushConsumer.attributes() Returns the attributes of this PushConsumer instance.
KeyValue	MessageListener.Context.attributes() Returns the attributes of this MessageContext instance.
KeyValue	PullConsumer.attributes() Returns the attributes of this PullConsumer instance.

Methods in io.openmessaging.consumer with parameters of type KeyValue

Modifier and Type	Method and Description
void	PullConsumer.ack(String receiptHandle, KeyValue attributes) Acknowledges the specified and consumed message with the specified attributes.
PullConsumer	PullConsumer.attachQueue(String queueName, KeyValue attributes) Attaches the PullConsumer to a specified queue with some specified attributes..
PushConsumer	PushConsumer.attachQueue(String queueName, MessageListener listener, KeyValue attributes) Attaches the PushConsumer to a specified queue, with a MessageListener and some specified attributes.
Message	PullConsumer.receive(KeyValue attributes) Receives the next message from the attached queues of this consumer, using the specified attributes.

Uses of KeyValue in io.openmessaging.interceptor

Methods in io.openmessaging.interceptor with parameters of type KeyValue

Modifier and Type	Method and Description
void	ConsumerInterceptor.postReceive(Message message, KeyValue attributes) Invoked after the invocation of MessageListener.onReceived(Message, MessageListener.Context).
void	ProducerInterceptor.postSend(Message message, KeyValue attributes) Invoked immediately after the successful send invocation.
void	ProducerInterceptor.postSend(Message message, KeyValue attributes, OMSException sendException) Invoked immediately after the failed send invocation.
void	ConsumerInterceptor.preReceive(Message message, KeyValue attributes) Invoked before the invocation of MessageListener.onReceived(Message, MessageListener.Context).
void	ProducerInterceptor.preSend(Message message, KeyValue attributes) Invoked before the message is actually sent to the network.

Uses of KeyValue in io.openmessaging.producer

Methods in io.openmessaging.producer that return KeyValue

Modifier and Type	Method and Description
KeyValue	Producer.attributes() Returns the attributes of this Producer instance.

Methods in io.openmessaging.producer with parameters of type KeyValue

Modifier and Type	Method and Description
SendResult	Producer.send(Message message, KeyValue attributes) 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.
SendResult	Producer.send(Message message, LocalTransactionExecutor branchExecutor, KeyValue attributes) 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.
Future<SendResult>	Producer.sendAsync(Message message, KeyValue attributes) 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.
void	Producer.sendOneway(Message message, KeyValue properties) 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.