io.openmessaging

Interface ResourceManager

public interface ResourceManager

The ResourceManager is to provide a unified interface of resource management, allowing developers to manage the namespace, queue and routing resources.

Create, set, get and delete are the four basic operations of ResourceManager.

ResourceManager also supports dynamic fetch and update of resource attributes.

MessagingAccessPoint.resourceManager() ()} is the unique method to obtain a ResourceManager instance. Changes made through this instance will immediately apply to the message-oriented middleware (MOM) behind MessagingAccessPoint.

Since:

OMS 1.0.0

Version:

OMS 1.0.0

Method Summary

Modifier and Type	Method and Description
void	createNamespace(String nsName, KeyValue attributes) Creates a Namespace resource with some preset attributes.
void	createQueue(String queueName, KeyValue attributes) Creates a Queue resource in the configured namespace with some preset attributes.
void	createRouting(String routingName, KeyValue attributes) Creates a Routing resource in the configured namespace with some preset attributes.
void	deleteNamespace(String nsName) Deletes an existing namespace resource.
void	deleteQueue(String queueName) Deletes an existing queue resource.
void	deleteRouting(String routingName) Deletes an existing routing resource.
KeyValue	getNamespaceAttributes(String nsName) Gets the attributes of the specific namespace.
KeyValue	getQueueAttributes(String queueName) Gets the attributes of the specified queue.
KeyValue	getRoutingAttributes(String routingName) Gets the attributes of the specified routing.
List<String>	listNamespaces() Gets the namespace list in the current MessagingAccessPoint.
List<String>	listQueues(String nsName) Gets the queue list in the specific namespace.
List<String>	listRoutings(String nsName) Gets the routing list in the specific namespace.
List<String>	listStreams(String queueName) Gets the stream list behind the specified queue.
void	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	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	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	updateMessage(String queueName, String messageId, KeyValue headers) Updates some system headers of a message in the configured namespace.

Method Detail

createNamespace

void createNamespace(String nsName,
                     KeyValue attributes)

Creates a Namespace resource with some preset attributes.

A namespace wraps the OMS resources in an abstract concept that makes it appear to the users within the namespace that they have their own isolated instance of the global OMS resources.

Parameters:

nsName - the name of the new namespace

attributes - the preset attributes

setNamespaceAttributes

void setNamespaceAttributes(String nsName,
                            KeyValue attributes)
                     throws OMSResourceNotExistException

Sets the attributes of the specific namespace, the old attributes will be replaced by the provided attributes, only the provided key will be updated.

Parameters:

nsName - the specific namespace

attributes - the new attributes

Throws:

OMSResourceNotExistException - if the specific namespace does not exist

getNamespaceAttributes

KeyValue getNamespaceAttributes(String nsName)
                         throws OMSResourceNotExistException

Gets the attributes of the specific namespace.

Parameters:

nsName - the specific namespace

Returns:

the attributes of namespace

Throws:

OMSResourceNotExistException - if the specific namespace does not exist

deleteNamespace

void deleteNamespace(String nsName)
              throws OMSResourceNotExistException

Deletes an existing namespace resource.

Parameters:

nsName - the namespace needs to be deleted

Throws:

OMSResourceNotExistException - if the specified namespace does not exist

listNamespaces

List<String> listNamespaces()

Gets the namespace list in the current MessagingAccessPoint.

Returns:

the list of all namespaces

createQueue

void createQueue(String queueName,
                 KeyValue attributes)
          throws OMSResourceNotExistException

Creates a Queue resource in the configured namespace with some preset attributes.

The standard OMS Queue schema must start with the Namespace prefix:

<namespace_name>://<queue_name>

Parameters:

queueName - the name of the new queue

attributes - the preset attributes

Throws:

OMSResourceNotExistException - if the configured namespace does not exist or specified queue name is not available

setQueueAttributes

void setQueueAttributes(String queueName,
                        KeyValue attributes)
                 throws OMSResourceNotExistException

Sets the attributes of the specified queue, the old attributes will be replaced by the provided attributes, only the provided key will be updated.

Parameters:

queueName - the queue name

attributes - the new attributes

Throws:

OMSResourceNotExistException - if the specified queue or namespace does not exist

getQueueAttributes

KeyValue getQueueAttributes(String queueName)
                     throws OMSResourceNotExistException

Gets the attributes of the specified queue.

Parameters:

queueName - the queue name

Returns:

the attributes of namespace

Throws:

OMSResourceNotExistException - if the specified queue or namespace does not exist

deleteQueue

void deleteQueue(String queueName)
          throws OMSResourceNotExistException

Deletes an existing queue resource.

Parameters:

queueName - the queue needs to be deleted

Throws:

OMSResourceNotExistException - if the specified queue or namespace does not exist

listQueues

List<String> listQueues(String nsName)
                 throws OMSResourceNotExistException

Gets the queue list in the specific namespace.

Parameters:

nsName - the specific namespace

Returns:

the list of all queues

Throws:

OMSResourceNotExistException - if the specific namespace does not exist

createRouting

void createRouting(String routingName,
                   KeyValue attributes)
            throws OMSResourceNotExistException

Creates a Routing resource in the configured namespace with some preset attributes.

The standard OMS Routing schema must start with the Namespace prefix:

<namespace_name>://<routing_name>

Parameters:

routingName - the name of the new routing

attributes - the preset attributes

Throws:

OMSResourceNotExistException - if the configured namespace does not exist or specified routing name is not available

setRoutingAttributes

void setRoutingAttributes(String routingName,
                          KeyValue attributes)
                   throws OMSResourceNotExistException

Sets the attributes of the specified routing, the old attributes will be replaced by the provided attributes, only the provided key will be updated.

Parameters:

routingName - the routing name

attributes - the new attributes

Throws:

OMSResourceNotExistException - if the specified routing or namespace does not exist

getRoutingAttributes

KeyValue getRoutingAttributes(String routingName)
                       throws OMSResourceNotExistException

Gets the attributes of the specified routing.

Parameters:

routingName - the routing name

Returns:

the attributes of routing

Throws:

OMSResourceNotExistException - if the specified routing or namespace does not exist

deleteRouting

void deleteRouting(String routingName)
            throws OMSResourceNotExistException

Deletes an existing routing resource.

Parameters:

routingName - the routing needs to be deleted

Throws:

OMSResourceNotExistException - if the specified routing or namespace does not exist

listRoutings

List<String> listRoutings(String nsName)
                   throws OMSResourceNotExistException

Gets the routing list in the specific namespace.

Parameters:

nsName - the specific namespace

Returns:

the list of all routings

Throws:

OMSResourceNotExistException - if the specific namespace does not exist

listStreams

List<String> listStreams(String queueName)
                  throws OMSResourceNotExistException

Gets the stream list behind the specified queue.

Parameters:

queueName - the queue name

Returns:

the list of all streams

Throws:

OMSResourceNotExistException - if the specified queue or namespace does not exist

updateMessage

void updateMessage(String queueName,
                   String messageId,
                   KeyValue headers)
            throws OMSResourceNotExistException

Updates some system headers of a message in the configured namespace.

Below system headers are allowed to be changed dynamically:

• Message.BuiltinKeys.START_TIME
• Message.BuiltinKeys.STOP_TIME
• Message.BuiltinKeys.TIMEOUT
• Message.BuiltinKeys.PRIORITY
• Message.BuiltinKeys.SCHEDULE_EXPRESSION

Parameters:

queueName - the specific queue the message resides in

messageId - the id of message

headers - the new headers

Throws:

OMSResourceNotExistException - if the specified queue, namespace or message does not exist