com.webmethods.jms.admin
Interface WmJMSAdmin

public interface WmJMSAdmin

The administration interface to the Broker.

Field Summary

static int	LIFECYCLE_DESTROY_ON_DISCONNECT Destroy on disconnect lifecycle
static int	LIFECYCLE_EXPLICIT_DESTROY Explicit destroy lifecycle
static int	RECOVER_GLOBAL Global recover mode.
static int	RECOVER_RESTRICTED Restricted recover mode.
static int	STORAGE_GUARANTEED Guaranteed storage
static int	STORAGE_VOLATILE Volatile storage
static int	TRANSACTION_COMMIT Commit a transaction.
static int	TRANSACTION_ROLLBACK Abort a transaction.
static int	VALIDATION_FULL Full event type validation
static int	VALIDATION_NONE No event type validation
static int	VALIDATION_OPEN Open event type validation

Method Summary

void	addReceivePermission(javax.jms.ConnectionFactory factory, javax.jms.Destination destination) Add a JMS destination to a connection factory's receive permissions.
void	addReceivePermission(java.lang.String clientGroup, java.lang.String eventType) Add an event type to a client group's receive permissions.
void	addSendPermission(javax.jms.ConnectionFactory factory, javax.jms.Destination destination) Add a JMS destination to a connection factory's send permissions.
void	addSendPermission(java.lang.String clientGroup, java.lang.String eventType) Add an event type to a client group's send permissions.
void	clearClientQueue(java.lang.String client) Clear a client's queue on the Broker.
void	clearDurableSubscriber(java.lang.String clientID, java.lang.String name) Clear all messages for a JMS durable subscriber on the Broker.
void	clearQueue(javax.jms.Queue queue) Clear all messages for a JMS queue on the Broker.
void	clearQueue(java.lang.String name) Clear all messages for a JMS queue on the Broker.
boolean	clientExists(java.lang.String client) Determine if a client exists on the Broker.
boolean	clientGroupExists(java.lang.String clientGroup) Determine if the specified client group exists on the Broker.
void	close() Closes the administration connection to the Broker.
void	closeClient(java.lang.String client) Close a client on the Broker.
boolean	connectionFactoryExists(javax.jms.ConnectionFactory factory) Determines if the JMS connection factory exists on the Broker.
void	createBroker(java.lang.String broker, java.lang.String description, boolean makeDefault) Create a Broker on the current Broker Server.
void	createClientGroup(java.lang.String clientGroup, int storage) Create a client group on the Broker.
void	createConnectionFactory(javax.jms.ConnectionFactory factory) Create the JMS connection factory on the Broker.
void	createDestination(javax.jms.Destination destination) Create a JMS destination on the Broker.
void	createDurableSubscriber(javax.jms.ConnectionFactory factory, javax.jms.Topic topic, java.lang.String name) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(javax.jms.ConnectionFactory factory, javax.jms.Topic topic, java.lang.String name, java.lang.String selector, boolean noLocal) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(javax.jms.ConnectionFactory factory, javax.jms.Topic topic, java.lang.String name, java.lang.String selector, boolean noLocal, java.lang.String userDN, java.lang.String issuerDN) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(java.lang.String clientID, java.lang.String clientGroup, java.lang.String application, javax.jms.Topic topic, java.lang.String name, java.lang.String selector, boolean noLocal, boolean priorityOrdering) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(java.lang.String clientID, java.lang.String clientGroup, java.lang.String application, javax.jms.Topic topic, java.lang.String name, java.lang.String selector, boolean noLocal, boolean priorityOrdering, java.lang.String userDN, java.lang.String issuerDN) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(java.lang.String clientID, java.lang.String clientGroup, javax.jms.Topic topic, java.lang.String name, boolean priorityOrdering) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(java.lang.String clientID, java.lang.String clientGroup, javax.jms.Topic topic, java.lang.String name, java.lang.String selector, boolean noLocal, boolean priorityOrdering) Create a JMS durable subscriber on the Broker.
void	createDurableSubscriber(java.lang.String clientID, java.lang.String clientGroup, javax.jms.Topic topic, java.lang.String name, java.lang.String selector, boolean noLocal, boolean priorityOrdering, java.lang.String userDN, java.lang.String issuerDN) Create a JMS durable subscriber on the Broker.
void	createEventType(java.lang.String eventType, java.lang.String description, int storage, int ttl, int validation) Create an event type on the Broker.
void	createQueue(javax.jms.ConnectionFactory factory, javax.jms.Queue queue) Create the physical JMS queue on the Broker.
void	createQueue(javax.jms.ConnectionFactory factory, javax.jms.Queue queue, java.lang.String userDN, java.lang.String issuerDN) Create the physical JMS queue on the Broker.
void	createQueue(java.lang.String name, java.lang.String clientGroup, java.lang.String application, boolean sharedState, int sharedStateOrdering, boolean priorityOrdering) Create the physical JMS queue on the Broker.
void	createQueue(java.lang.String name, java.lang.String clientGroup, java.lang.String application, boolean sharedState, int sharedStateOrdering, boolean priorityOrdering, java.lang.String userDN, java.lang.String issuerDN) Create the physical JMS queue on the Broker.
void	createTerritory(java.lang.String territory) Create a territory and add the Broker.
void	createTopic(java.lang.String topic) Create a JMS topic on the Broker.
boolean	destinationExists(javax.jms.Destination destination) Determine if the JMS destination exists on the Broker.
void	destroyBroker() Destroy the current Broker.
void	destroyClient(java.lang.String client) Destory a client on the Broker.
void	destroyClientGroup(java.lang.String clientGroup) Destroy a client group from the Broker.
void	destroyDestination(javax.jms.Destination destination) Destroy a JMS destination on the Broker.
void	destroyDurableSubscriber(java.lang.String clientID, java.lang.String name) Destroy a JMS durable subscriber from the Broker.
void	destroyEventType(java.lang.String eventType) Destroy an event type on the Broker.
void	destroyQueue(javax.jms.Queue queue) Remove the physical JMS queue from the Broker.
void	destroyQueue(java.lang.String name) Remove the physical JMS queue from the Broker.
void	destroyTopic(java.lang.String topic) Destroy a JMS topic on the Broker.
boolean	durableSubscriberExists(java.lang.String clientID, java.lang.String name) Determine if a JMS durable subscriber exists on the Broker.
boolean	eventTypeExists(java.lang.String eventType) Determine if the event type exists on the Broker.
java.lang.String	getBroker() Get the fully qualified Broker address to which the administration connection is connected.
java.lang.String	getBrokerHost() Get the Broker Server host to which the administration connection is connected.
java.lang.String	getBrokerName() Get the Broker name to which the administration connection is connected.
int	getBrokerPort() Get the Broker Server port to which the administration connection is connected.
java.lang.String[]	getBrokers() Get a list of Brokers on the current Broker Server.
java.lang.String[]	getClientGroups() Get the list of client groups on the Broker.
java.lang.String[]	getClientGroups(java.lang.String sendPermission, java.lang.String receivePermission) Get the list of client groups on the Broker.
java.lang.String[]	getClients() Return the list of Broker clients.
java.lang.String[]	getClients(java.lang.String clientGroup, java.lang.String eventType) Return the list of Broker clients.
java.lang.String[]	getClientSubscriptions(java.lang.String client) Get the list of event types to which the client is subscribed.
java.lang.String	getDefaultBroker() Get the default Broker on the current Broker Server.
java.lang.String[]	getEventTypes() Get the list of event types on the Broker.
java.lang.String[]	getEventTypes(java.lang.String scope) Get the list of event types on the Broker.
int	getPrepareTimeout() Get the default prepare timeout.
int	getPrepareTimeoutAction() Get the prepare timeout action.
java.lang.String[]	getReceivePermissions(java.lang.String clientGroup) Get a client group's receive permissions.
int	getRecoverMode() Gets the global recover mode of the Broker.
java.lang.String[]	getSendPermissions(java.lang.String clientGroup) Get a client group's send permissions.
java.lang.String	getTerritory() Get the Broker's territory.
java.lang.String[]	getTerritoryBrokerFullNames() Get a list of Brokers in the current Broker's territory.
java.lang.String[]	getTerritoryBrokers() Get a list of Brokers in the current Broker's territory.
int	getTransactionTimeout() Get the default transaction timeout.
java.lang.String	getVersion() Get the Broker Server version.
void	joinTerritory(java.lang.String brokerHost, java.lang.String brokerName) Join the Broker to the specified Broker's territory.
void	leaveTerritory() Cause the Broker to leave its current territory.
boolean	queueExists(javax.jms.Queue queue) Determine if the JMS queue exists on the Broker.
boolean	queueExists(java.lang.String name) Determine if the JMS queue exists on the Broker.
void	removeReceivePermission(javax.jms.ConnectionFactory factory, javax.jms.Destination destination) Remove a JMS destination from a connection factory's receive permissions.
void	removeReceivePermission(java.lang.String clientGroup, java.lang.String eventType) Remove an event type from a client group's receive permissions.
void	removeSendPermission(javax.jms.ConnectionFactory factory, javax.jms.Destination destination) Remove a JMS destination from a connection factory's send permissions.
void	removeSendPermission(java.lang.String clientGroup, java.lang.String eventType) Remove an event type from a client group's send permissions.
void	setDefaultBroker(java.lang.String broker) Set the default Broker on the current Broker Server.
void	setPrepareTimeout(int seconds) Set the default prepare timeout.
void	setPrepareTimeoutAction(int action) Set the prepare timeout action.
void	setReceivePermissions(java.lang.String clientGroup, java.lang.String[] permissions) Set a client group's receive permissions.
void	setRecoverMode(int mode) Sets the global recover mode of the Broker to either restricted (the default) or global.
void	setSendPermissions(java.lang.String clientGroup, java.lang.String[] permissions) Set a client group's send permissions.
void	setTransactionTimeout(int seconds) Set the default transaction timeout.
boolean	topicExists(java.lang.String topic) Determine if the JMS topic exists on the Broker.

Field Detail

RECOVER_GLOBAL

static final int RECOVER_GLOBAL

Global recover mode. Allows access to all current transactions.

See Also:

Constant Field Values

RECOVER_RESTRICTED

static final int RECOVER_RESTRICTED

Restricted recover mode. Restricts access to only the user's current transactions.

See Also:

Constant Field Values

TRANSACTION_COMMIT

static final int TRANSACTION_COMMIT

Commit a transaction.

See Also:

Constant Field Values

TRANSACTION_ROLLBACK

static final int TRANSACTION_ROLLBACK

Abort a transaction.

See Also:

Constant Field Values

LIFECYCLE_DESTROY_ON_DISCONNECT

static final int LIFECYCLE_DESTROY_ON_DISCONNECT

Destroy on disconnect lifecycle

See Also:

Constant Field Values

LIFECYCLE_EXPLICIT_DESTROY

static final int LIFECYCLE_EXPLICIT_DESTROY

Explicit destroy lifecycle

See Also:

Constant Field Values

STORAGE_VOLATILE

static final int STORAGE_VOLATILE

Volatile storage

See Also:

Constant Field Values

STORAGE_GUARANTEED

static final int STORAGE_GUARANTEED

Guaranteed storage

See Also:

Constant Field Values

VALIDATION_FULL

static final int VALIDATION_FULL

Full event type validation

See Also:

Constant Field Values

VALIDATION_OPEN

static final int VALIDATION_OPEN

Open event type validation

See Also:

Constant Field Values

VALIDATION_NONE

static final int VALIDATION_NONE

No event type validation

See Also:

Constant Field Values

Method Detail

close

void close()
           throws WmJMSAdminException

Closes the administration connection to the Broker.

Throws:

WmJMSAdminException - if an error occurs closing the connection to the Broker

getBrokerName

java.lang.String getBrokerName()
                               throws WmJMSAdminException

Get the Broker name to which the administration connection is connected.

Returns:

the Broker name

Throws:

WmJMSAdminException - if there are communication problems with the Broker

getBrokerHost

java.lang.String getBrokerHost()
                               throws WmJMSAdminException

Get the Broker Server host to which the administration connection is connected.

Returns:

the Broker Server host

Throws:

WmJMSAdminException - if there are communication problems with the Broker

getBrokerPort

int getBrokerPort()
                  throws WmJMSAdminException

Get the Broker Server port to which the administration connection is connected.

Returns:

the Broker Server port

Throws:

WmJMSAdminException - if there are communication problems with the Broker

getBroker

java.lang.String getBroker()
                           throws WmJMSAdminException

Get the fully qualified Broker address to which the administration connection is connected.

Returns:

the fully qualified Broker address

Throws:

WmJMSAdminException

getVersion

java.lang.String getVersion()
                            throws WmJMSAdminException

Get the Broker Server version.

Returns:

the Broker Server version

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

getBrokers

java.lang.String[] getBrokers()
                              throws WmJMSAdminException

Get a list of Brokers on the current Broker Server.

Returns:

a list of Brokers on the current Broker Server

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

createBroker

void createBroker(java.lang.String broker,
                  java.lang.String description,
                  boolean makeDefault)
                  throws WmJMSAdminException

Create a Broker on the current Broker Server.

Parameters:

broker - the Broker name

description - the Broker description

makeDefault - true to make the Broker the default Broker

Throws:

WmJMSAdminAlreadyExistsException - if the Broker already exists

WmJMSAdminInvalidNameException - if the Broker name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

destroyBroker

void destroyBroker()
                   throws WmJMSAdminException

Destroy the current Broker.

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the Broker.

WmJMSAdminException

getDefaultBroker

java.lang.String getDefaultBroker()
                                  throws WmJMSAdminException

Get the default Broker on the current Broker Server.

Throws:

WmJMSAdminDoesNotExistException - if there is no default Broker

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

See Also:

setDefaultBroker(java.lang.String)

setDefaultBroker

void setDefaultBroker(java.lang.String broker)
                      throws WmJMSAdminException

Set the default Broker on the current Broker Server.

Parameters:

broker - the Broker to make default, or null to make no Broker default

Throws:

WmJMSAdminDoesNotExistException - if the Broker does not exist

WmJMSAdminInvalidNameException - if the Broker name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

See Also:

getDefaultBroker()

getClientGroups

java.lang.String[] getClientGroups()
                                   throws WmJMSAdminException

Get the list of client groups on the Broker.

Returns:

the list of client group names on the Broker

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

getClientGroups

java.lang.String[] getClientGroups(java.lang.String sendPermission,
                                   java.lang.String receivePermission)
                                   throws WmJMSAdminException

Get the list of client groups on the Broker. The search can be refined by searching for only those client groups with a specifc send and/or receive permission.

Parameters:

sendPermission - an event type to search on

receivePermission - an event type to search on

Returns:

the list of client group names on the Broker

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

clientGroupExists

boolean clientGroupExists(java.lang.String clientGroup)
                          throws WmJMSAdminException

Determine if the specified client group exists on the Broker.

Parameters:

clientGroup - the client group name

Returns:

true if the client group exists

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the client group

WmJMSAdminException

createClientGroup

void createClientGroup(java.lang.String clientGroup,
                       int storage)
                       throws WmJMSAdminException

Create a client group on the Broker. A client group may be created with either persistent storage or volatile storage.

Parameters:

clientGroup - the client group name to create

storage - either STORAGE_VOLATILE or STORAGE_GUARANTEED

Throws:

WmJMSAdminAlreadyExistsException - if the client group already exists

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the client group

WmJMSAdminException

destroyClientGroup

void destroyClientGroup(java.lang.String clientGroup)
                        throws WmJMSAdminException

Destroy a client group from the Broker.

Parameters:

clientGroup - the client group name

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminDependsException - if there are client's that depend on this client group

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the client group

WmJMSAdminException

getSendPermissions

java.lang.String[] getSendPermissions(java.lang.String clientGroup)
                                      throws WmJMSAdminException

Get a client group's send permissions. The send permissions are the event type names that the client group has permission to send.

Parameters:

clientGroup - the client group name

Returns:

the client group's send permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to get the client group's send permissions

WmJMSAdminException

setSendPermissions

void setSendPermissions(java.lang.String clientGroup,
                        java.lang.String[] permissions)
                        throws WmJMSAdminException

Set a client group's send permissions. The send permissions are the event type names that the client group has permission to send.

Note: you cannot use multiple threads to simultaneously update permissions for document types on the same client group.

Parameters:

clientGroup - the client group name

permissions - the client group's send permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name or permission name is invalid

WmJMSAdminDoesNotExistException - if the client group or event type does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to set the client group's send permissions

WmJMSAdminException

getReceivePermissions

java.lang.String[] getReceivePermissions(java.lang.String clientGroup)
                                         throws WmJMSAdminException

Get a client group's receive permissions. The receive permissions are the event type names that the client group has permission to receive.

Parameters:

clientGroup - the client group name

Returns:

the client group's receive permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to get the client group's receive permissions

WmJMSAdminException

setReceivePermissions

void setReceivePermissions(java.lang.String clientGroup,
                           java.lang.String[] permissions)
                           throws WmJMSAdminException

Set a client group's receive permissions. The receive permissions are the event type names that the client group has permission to receive.

Note: you cannot use multiple threads to simultaneously update permissions for document types on the same client group.

Parameters:

clientGroup - the client group name

permissions - the client group's receive permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name or permission name is invalid

WmJMSAdminDoesNotExistException - if the client group or event type does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to set the client group's receive permissions

WmJMSAdminException

addSendPermission

void addSendPermission(java.lang.String clientGroup,
                       java.lang.String eventType)
                       throws WmJMSAdminException

Add an event type to a client group's send permissions.

Note: you cannot use multiple threads to simultaneously update permissions for document types on the same client group.

Parameters:

clientGroup - the client group name

eventType - the event type name to add

Throws:

WmJMSAdminInvalidNameException - if the client group name or event type is invalid

WmJMSAdminDoesNotExistException - if the client group or event type does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to add to the client group's send permissions

WmJMSAdminException

removeSendPermission

void removeSendPermission(java.lang.String clientGroup,
                          java.lang.String eventType)
                          throws WmJMSAdminException

Remove an event type from a client group's send permissions.

Note: you cannot use multiple threads to simultaneously update permissions for document types on the same client group.

Parameters:

clientGroup - the client group name

eventType - the event type name to remove

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to remove to the client group's send permissions

WmJMSAdminException

addReceivePermission

void addReceivePermission(java.lang.String clientGroup,
                          java.lang.String eventType)
                          throws WmJMSAdminException

Add an event type to a client group's receive permissions.

Note: you cannot use multiple threads to simultaneously update permissions for document types on the same client group.

Parameters:

clientGroup - the client group name

eventType - the event type name to add

Throws:

WmJMSAdminInvalidNameException - if the client group name or event type is invalid

WmJMSAdminDoesNotExistException - if the client group or event type does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to add to the client group's receive permissions

WmJMSAdminException

removeReceivePermission

void removeReceivePermission(java.lang.String clientGroup,
                             java.lang.String eventType)
                             throws WmJMSAdminException

Remove an event type from a client group's receive permissions.

Note: you cannot use multiple threads to simultaneously update permissions for document types on the same client group.

Parameters:

clientGroup - the client group name

eventType - the event type name to remove

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to remove to the client group's receive permissions

WmJMSAdminException

getEventTypes

java.lang.String[] getEventTypes()
                                 throws WmJMSAdminException

Get the list of event types on the Broker.

Returns:

the list of event types on the Broker

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions to get the list of event types on the Broker

WmJMSAdminException

getEventTypes

java.lang.String[] getEventTypes(java.lang.String scope)
                                 throws WmJMSAdminException

Get the list of event types on the Broker. The list can be refined by specifying an optional scope to which the event types belong.

Parameters:

scope - the optional event type scope, or null for all event types

Returns:

the list of event types on the Broker

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions to get the list of event types on the Broker

WmJMSAdminException

eventTypeExists

boolean eventTypeExists(java.lang.String eventType)
                        throws WmJMSAdminException

Determine if the event type exists on the Broker.

Parameters:

eventType - the event type name

Returns:

true if the event type exists

Throws:

WmJMSAdminInvalidNameException - if the event type name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the event type on the Broker

WmJMSAdminException

createEventType

void createEventType(java.lang.String eventType,
                     java.lang.String description,
                     int storage,
                     int ttl,
                     int validation)
                     throws WmJMSAdminException

Create an event type on the Broker.

Parameters:

eventType - the event type name

description - the event type description

storage - either STORAGE_VOLATILE or STORAGE_GUARANTEED

ttl - time-to-live of the event, or 0 to disable event expiration

validation - one of VALIDATION_FULL, VALIDATION_OPEN or VALIDATION_NONE

Throws:

WmJMSAdminAlreadyExistsException - if the event type already exists

WmJMSAdminInvalidNameException - if the event type name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the event type on the Broker

WmJMSAdminException

destroyEventType

void destroyEventType(java.lang.String eventType)
                      throws WmJMSAdminException

Destroy an event type on the Broker.

Parameters:

eventType - the event type name

Throws:

WmJMSAdminInvalidNameException - if the event type name is invalid

WmJMSAdminDoesNotExistException - if the event type does not exist

WmJMSAdminDependsException - if there are permissions that depend on this event type

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the event type on the Broker

WmJMSAdminException

getClients

java.lang.String[] getClients()
                              throws WmJMSAdminException

Return the list of Broker clients.

Returns:

the list of Broker clients

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions to get the list of Broker clients

WmJMSAdminException

getClients

java.lang.String[] getClients(java.lang.String clientGroup,
                              java.lang.String eventType)
                              throws WmJMSAdminException

Return the list of Broker clients. The search can be be refined by specifying only a certain client group and or subscription.

Parameters:

clientGroup - the optional client group to search on, or null to search on all client groups

eventType - the optional subscription to search on, or null to search on all subscriptions

Returns:

the list of Broker clients

Throws:

WmJMSAdminSecurityException - if there are not sufficient permissions to get the list of Broker clients

WmJMSAdminException

getClientSubscriptions

java.lang.String[] getClientSubscriptions(java.lang.String client)
                                          throws WmJMSAdminException

Get the list of event types to which the client is subscribed.

Parameters:

client - the name of the client

Returns:

the list of subscriptions

Throws:

WmJMSAdminInvalidNameException - if the client name is invalid

WmJMSAdminDoesNotExistException - if the client does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

clientExists

boolean clientExists(java.lang.String client)
                     throws WmJMSAdminException

Determine if a client exists on the Broker.

Parameters:

client - the name of the client

Returns:

true if the client exists

Throws:

WmJMSAdminInvalidNameException - if the client name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the client

WmJMSAdminException

clearClientQueue

void clearClientQueue(java.lang.String client)
                      throws WmJMSAdminException

Clear a client's queue on the Broker.

Parameters:

client - the name of the client to clear

Throws:

WmJMSAdminInvalidNameException - if the client name is invalid

WmJMSAdminDoesNotExistException - if the client does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to clear the client's queue

WmJMSAdminException

closeClient

void closeClient(java.lang.String client)
                 throws WmJMSAdminException

Close a client on the Broker.

Parameters:

client - the name of the client to close on the Broker

Throws:

WmJMSAdminInvalidNameException - if the client name is invalid

WmJMSAdminDoesNotExistException - if the client does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to close the client

WmJMSAdminException

destroyClient

void destroyClient(java.lang.String client)
                   throws WmJMSAdminException

Destory a client on the Broker.

Parameters:

client - the name of the client to destroy on the Broker

Throws:

WmJMSAdminInvalidNameException - if the client name is invalid

WmJMSAdminDoesNotExistException - if the client does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the client

WmJMSAdminException

getTerritory

java.lang.String getTerritory()
                              throws WmJMSAdminException

Get the Broker's territory.

Returns:

the Broker's territory

Throws:

WmJMSAdminDoesNotExistException - if the Broker is not in a territory

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

createTerritory

void createTerritory(java.lang.String territory)
                     throws WmJMSAdminException

Create a territory and add the Broker.

Parameters:

territory - the territory to create

Throws:

WmJMSAdminInvalidNameException - if the territory name is invalid

WmJMSAdminAlreadyExistsException - if the Broker is already in a territory

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

joinTerritory

void joinTerritory(java.lang.String brokerHost,
                   java.lang.String brokerName)
                   throws WmJMSAdminException

Join the Broker to the specified Broker's territory.

Parameters:

brokerHost - the host of the Broker whose territory is to be joined

brokerName - the name of the Broker whose territory is to be joined

Throws:

WmJMSAdminInvalidNameException - if the Broker name is invalid

WmJMSAdminAlreadyExistsException - if the Broker is already in a territory

WmJMSAdminException - if the territory cannot be joined

WmJMSAdminSecurityException - if there are not sufficient permissions

leaveTerritory

void leaveTerritory()
                    throws WmJMSAdminException

Cause the Broker to leave its current territory.

Throws:

WmJMSAdminDoesNotExistException - if the Broker is not currently in a territory

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

getTerritoryBrokers

java.lang.String[] getTerritoryBrokers()
                                       throws WmJMSAdminException

Get a list of Brokers in the current Broker's territory.

Returns:

a list of Brokers in the current territory

Throws:

WmJMSAdminDoesNotExistException - if the Broker is not currently in a territory

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException

setRecoverMode

void setRecoverMode(int mode)
                    throws WmJMSAdminException

Sets the global recover mode of the Broker to either restricted (the default) or global. Restricted mode only allows a client to recover transactions to which it participated. Global mode allows a client to recover all recoverable transactions.

Parameters:

mode - The recover mode to set; either RECOVER_GLOBAL or RECOVER_RESTRICTED.

Throws:

WmJMSAdminException - if the recover mode could not be set

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

getRecoverMode()

getRecoverMode

int getRecoverMode()
                   throws WmJMSAdminException

Gets the global recover mode of the Broker.

Returns:

The recover mode; either RECOVER_GLOBAL or RECOVER_RESTRICTED.

Throws:

WmJMSAdminException - if the recover mode could not be retrieved

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

setRecoverMode(int)

setPrepareTimeoutAction

void setPrepareTimeoutAction(int action)
                             throws WmJMSAdminException

Set the prepare timeout action. This is the action the Broker will take when a prepared transaction times out.

Parameters:

action - The action to set; either TRANSACTION_ROLLBACK or TRANSACTION_COMMIT.

Throws:

WmJMSAdminException - if the timeout action could not be set

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

getPrepareTimeoutAction()

getPrepareTimeoutAction

int getPrepareTimeoutAction()
                            throws WmJMSAdminException

Get the prepare timeout action. This is the action the Broker will take when a prepared transaction times out.

Returns:

The prepare timeout action; either TRANSACTION_ROLLBACK or TRANSACTION_COMMIT.

Throws:

WmJMSAdminException - if the timeout action could not be retrieved

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

setPrepareTimeoutAction(int)

setPrepareTimeout

void setPrepareTimeout(int seconds)
                       throws WmJMSAdminException

Set the default prepare timeout. This is the default timeout period between when a transaction is prepared and before it is committed.

Parameters:

seconds - The prepare timeout in seconds, or -1 for infinite timeout.

Throws:

WmJMSAdminException - if the timeout could not be set

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

getPrepareTimeout()

getPrepareTimeout

int getPrepareTimeout()
                      throws WmJMSAdminException

Get the default prepare timeout. This is the default timeout period between when a transaction is prepared and before it is committed.

Returns:

The default prepare timeout in seconds.

Throws:

WmJMSAdminException - if the timeout could not be retrieved

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

setPrepareTimeout(int)

setTransactionTimeout

void setTransactionTimeout(int seconds)
                           throws WmJMSAdminException

Set the default transaction timeout.

Parameters:

seconds - The default transaction timeout to set.

Throws:

WmJMSAdminException - if the timeout could not be set

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

getTransactionTimeout()

getTransactionTimeout

int getTransactionTimeout()
                          throws WmJMSAdminException

Get the default transaction timeout.

Returns:

The default transaction timeout in seconds.

Throws:

WmJMSAdminException - if the timeout could not be retrieved

WmJMSAdminSecurityException - if there are not sufficient permissions

See Also:

setTransactionTimeout(int)

createConnectionFactory

void createConnectionFactory(javax.jms.ConnectionFactory factory)
                             throws WmJMSAdminException

Create the JMS connection factory on the Broker. This method will create the required client group on the Broker.

Parameters:

factory - the factory to create on the Broker

Throws:

WmJMSAdminInvalidNameException - if the connection factory's client group name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the client group

WmJMSAdminException

connectionFactoryExists

boolean connectionFactoryExists(javax.jms.ConnectionFactory factory)
                                throws WmJMSAdminException

Determines if the JMS connection factory exists on the Broker. This method determines if the connection factory's client group exists on the Broker.

Parameters:

factory - the connection factory

Returns:

true if the connection factory exists

Throws:

WmJMSAdminInvalidNameException - if the connection factory's client group name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the connection factory on the Broker.

WmJMSAdminException

destinationExists

boolean destinationExists(javax.jms.Destination destination)
                          throws WmJMSAdminException

Determine if the JMS destination exists on the Broker. This method determines if the destination's event type exists on the Broker.

Parameters:

destination - the destination

Returns:

true if the destination exists

Throws:

WmJMSAdminInvalidNameException - if the destination name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the destination on the Broker.

WmJMSAdminException

createDestination

void createDestination(javax.jms.Destination destination)
                       throws WmJMSAdminException

Create a JMS destination on the Broker. This method will create the required event type on the Broker. If the destination is a queue the physical queue will NOT be created. Use createQueue(javax.jms.ConnectionFactory, javax.jms.Queue, java.lang.String, java.lang.String) to create the physical queue.

Parameters:

destination - the destination to create on the Broker

Throws:

WmJMSAdminAlreadyExistsException - if the destination already exists

WmJMSAdminInvalidNameException - if the destination name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the destination on the Broker.

WmJMSAdminException

See Also:

createQueue(javax.jms.ConnectionFactory, javax.jms.Queue, java.lang.String, java.lang.String)

destroyDestination

void destroyDestination(javax.jms.Destination destination)
                        throws WmJMSAdminException

Destroy a JMS destination on the Broker. This method will destroy the destination's event type on the Broker.

Parameters:

destination - the destination to destroy on the Broker

Throws:

WmJMSAdminInvalidNameException - if the destination name is invalid

WmJMSAdminDoesNotExistException - if the destination does not exist

WmJMSAdminDependsException - if there are permissions that depend on this destination

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the destination on the Broker.

WmJMSAdminException

topicExists

boolean topicExists(java.lang.String topic)
                    throws WmJMSAdminException

Determine if the JMS topic exists on the Broker. This method determines if the topic's event type exists on the Broker.

Parameters:

topic - the topic

Returns:

true if the topic exists

Throws:

WmJMSAdminInvalidNameException - if the topic name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the topic on the Broker.

WmJMSAdminException

createTopic

void createTopic(java.lang.String topic)
                 throws WmJMSAdminException

Create a JMS topic on the Broker. This method will create the required event type on the Broker. If the topic is a queue the physical queue will NOT be created. Use createQueue(javax.jms.ConnectionFactory, javax.jms.Queue, java.lang.String, java.lang.String) to create the physical queue.

Parameters:

topic - the topic to create on the Broker

Throws:

WmJMSAdminAlreadyExistsException - if the topic already exists

WmJMSAdminInvalidNameException - if the topic name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the topic on the Broker.

WmJMSAdminException

See Also:

createQueue(javax.jms.ConnectionFactory, javax.jms.Queue, java.lang.String, java.lang.String)

destroyTopic

void destroyTopic(java.lang.String topic)
                  throws WmJMSAdminException

Destroy a JMS topic on the Broker. This method will destroy the topic's event type on the Broker.

Parameters:

topic - the topic to destroy on the Broker

Throws:

WmJMSAdminInvalidNameException - if the topic name is invalid

WmJMSAdminDoesNotExistException - if the topic does not exist

WmJMSAdminDependsException - if there are permissions that depend on this topic

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the topic on the Broker.

WmJMSAdminException

addSendPermission

void addSendPermission(javax.jms.ConnectionFactory factory,
                       javax.jms.Destination destination)
                       throws WmJMSAdminException

Add a JMS destination to a connection factory's send permissions. This method will add the destination's event type to the connection factory client group's send permissions.

Parameters:

factory - the connection factory

destination - the destination to add to the permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name or destination is invalid

WmJMSAdminDoesNotExistException - if the client group or destination does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to modify to the client group's send permissions

WmJMSAdminException

removeSendPermission

void removeSendPermission(javax.jms.ConnectionFactory factory,
                          javax.jms.Destination destination)
                          throws WmJMSAdminException

Remove a JMS destination from a connection factory's send permissions. This method will remove the destination's event type from the connection factory client group's send permissions.

Parameters:

factory - the connection factory

destination - the destination to remove from the permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to modify to the client group's send permissions

WmJMSAdminException

addReceivePermission

void addReceivePermission(javax.jms.ConnectionFactory factory,
                          javax.jms.Destination destination)
                          throws WmJMSAdminException

Add a JMS destination to a connection factory's receive permissions. This method will add the destination's event type to the connection factory client group's receive permissions.

Parameters:

factory - the connection factory

destination - the destination to add to the permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name or destination is invalid

WmJMSAdminDoesNotExistException - if the client group or destination does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to modify to the client group's send permissions

WmJMSAdminException

removeReceivePermission

void removeReceivePermission(javax.jms.ConnectionFactory factory,
                             javax.jms.Destination destination)
                             throws WmJMSAdminException

Remove a JMS destination from a connection factory's receive permissions. This method will remove the destination's event type from the connection factory client group's receive permissions.

Parameters:

factory - the connection factory

destination - the destination to remove from the permissions

Throws:

WmJMSAdminInvalidNameException - if the client group name is invalid

WmJMSAdminDoesNotExistException - if the client group does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to modify to the client group's send permissions

WmJMSAdminException

durableSubscriberExists

boolean durableSubscriberExists(java.lang.String clientID,
                                java.lang.String name)
                                throws WmJMSAdminException

Determine if a JMS durable subscriber exists on the Broker.

Parameters:

clientID - the client ID of the connection

name - the subscription name

Returns:

true if the durable subscription exists

Throws:

WmJMSAdminInvalidNameException - if the client ID or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(javax.jms.ConnectionFactory factory,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             java.lang.String selector,
                             boolean noLocal)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker. The connection factory provides the location, client group and the client ID of the durable subscriber to create.

Parameters:

factory - the connection factory to use to create the durable subscriber

topic - the topic on which to subscribe

name - the subscription name

selector - an optional selector, or null

noLocal - the no local flag

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(javax.jms.ConnectionFactory factory,
                             javax.jms.Topic topic,
                             java.lang.String name)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker. The connection factory provides the location, client group and the client ID of the durable subscriber to create.

Parameters:

factory - the connection factory to use to create the durable subscriber

topic - the topic on which to subscribe

name - the subscription name

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(javax.jms.ConnectionFactory factory,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             java.lang.String selector,
                             boolean noLocal,
                             java.lang.String userDN,
                             java.lang.String issuerDN)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker. The connection factory provides the location, client group and the client ID of the durable subscriber to create.

Parameters:

factory - the connection factory to use to create the durable subscriber

topic - the topic on which to subscribe

name - the subscription name

selector - an optional selector, or null

noLocal - the no local flag

userDN - the distinguished name of the intended user

issuerDN - the distinguished name of the intended user's issuer

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(java.lang.String clientID,
                             java.lang.String clientGroup,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             java.lang.String selector,
                             boolean noLocal,
                             boolean priorityOrdering,
                             java.lang.String userDN,
                             java.lang.String issuerDN)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker.

Parameters:

clientID - the client ID to use to create the durable subscriber

clientGroup - the client group to use to create the durable subscriber

topic - the topic on which to subscribe

name - the subscription name

selector - an optional selector, or null

noLocal - the no local flag

priorityOrdering - true to create a durable subscriber with priority ordering

userDN - the distinguished name of the intended user

issuerDN - the distinguished name of the intended user's issuer

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(java.lang.String clientID,
                             java.lang.String clientGroup,
                             java.lang.String application,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             java.lang.String selector,
                             boolean noLocal,
                             boolean priorityOrdering,
                             java.lang.String userDN,
                             java.lang.String issuerDN)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker.

Parameters:

clientID - the client ID to use to create the durable subscriber

clientGroup - the client group to use to create the durable subscriber

application - an optional application name for display purposes

topic - the topic on which to subscribe

name - the subscription name

selector - an optional selector, or null

noLocal - the no local flag

priorityOrdering - true to create a durable subscriber with priority ordering

userDN - the distinguished name of the intended user

issuerDN - the distinguished name of the intended user's issuer

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(java.lang.String clientID,
                             java.lang.String clientGroup,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             java.lang.String selector,
                             boolean noLocal,
                             boolean priorityOrdering)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker.

Parameters:

clientID - the client ID to use to create the durable subscriber

clientGroup - the client group to use to create the durable subscriber

topic - the topic on which to subscribe

name - the subscription name

selector - an optional selector, or null

noLocal - the no local flag

priorityOrdering - true to create a durable subscriber with priority ordering

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(java.lang.String clientID,
                             java.lang.String clientGroup,
                             java.lang.String application,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             java.lang.String selector,
                             boolean noLocal,
                             boolean priorityOrdering)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker.

Parameters:

clientID - the client ID to use to create the durable subscriber

clientGroup - the client group to use to create the durable subscriber

application - an optional application name for display purposes

topic - the topic on which to subscribe

name - the subscription name

selector - an optional selector, or null

noLocal - the no local flag

priorityOrdering - true to create a durable subscriber with priority ordering

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

createDurableSubscriber

void createDurableSubscriber(java.lang.String clientID,
                             java.lang.String clientGroup,
                             javax.jms.Topic topic,
                             java.lang.String name,
                             boolean priorityOrdering)
                             throws WmJMSAdminException

Create a JMS durable subscriber on the Broker.

Parameters:

clientID - the client ID to use to create the durable subscriber

clientGroup - the client group to use to create the durable subscriber

topic - the topic on which to subscribe

name - the subscription name

priorityOrdering - true to create a durable subscriber with priority ordering

Throws:

WmJMSAdminAlreadyExistsException - if the durable subscription already exists

WmJMSAdminInvalidNameException - if the client ID, destination name or subscription name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to create the durable subscriber on the Broker.

WmJMSAdminException

destroyDurableSubscriber

void destroyDurableSubscriber(java.lang.String clientID,
                              java.lang.String name)
                              throws WmJMSAdminException

Destroy a JMS durable subscriber from the Broker.

Parameters:

clientID - the client ID of the connection

name - the subscription name

Throws:

WmJMSAdminInvalidNameException - if the client ID or subscription name is invalid

WmJMSAdminDoesNotExistException - if the durable subscription does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to destroy the durable subscriber on the Broker.

WmJMSAdminException

clearDurableSubscriber

void clearDurableSubscriber(java.lang.String clientID,
                            java.lang.String name)
                            throws WmJMSAdminException

Clear all messages for a JMS durable subscriber on the Broker.

Parameters:

clientID - the client ID of the connection

name - the subscription name

Throws:

WmJMSAdminInvalidNameException - if the client ID or subscription name is invalid

WmJMSAdminDoesNotExistException - if the durable subscription does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to clear the durable subscriber on the Broker.

WmJMSAdminException

queueExists

boolean queueExists(java.lang.String name)
                    throws WmJMSAdminException

Determine if the JMS queue exists on the Broker.

Parameters:

name - the queue name

Returns:

true if the queue exists

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the queue on the Broker.

WmJMSAdminException

queueExists

boolean queueExists(javax.jms.Queue queue)
                    throws WmJMSAdminException

Determine if the JMS queue exists on the Broker.

Parameters:

queue - the queue

Returns:

true if the queue exists

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminSecurityException - if there are not sufficient permissions to get the queue on the Broker.

WmJMSAdminException

createQueue

void createQueue(javax.jms.ConnectionFactory factory,
                 javax.jms.Queue queue,
                 java.lang.String userDN,
                 java.lang.String issuerDN)
                 throws WmJMSAdminException

Create the physical JMS queue on the Broker. The connection factory provides the location and client group of the queue to create.

Parameters:

factory - the connection factory to use to create the queue

queue - the queue

userDN - the distinguished name of the intended user

issuerDN - the distinguished name of the intended user's issuer

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminAlreadyExistsException - if the queue already exists

WmJMSAdminSecurityException - if there are not sufficient permissions to create the queue on the Broker.

WmJMSAdminException

createQueue

void createQueue(javax.jms.ConnectionFactory factory,
                 javax.jms.Queue queue)
                 throws WmJMSAdminException

Create the physical JMS queue on the Broker. The connection factory provides the location and client group of the queue to create.

Parameters:

factory - the connection factory to use to create the queue

queue - the queue

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminAlreadyExistsException - if the queue already exists

WmJMSAdminSecurityException - if there are not sufficient permissions to create the queue on the Broker.

WmJMSAdminException

createQueue

void createQueue(java.lang.String name,
                 java.lang.String clientGroup,
                 java.lang.String application,
                 boolean sharedState,
                 int sharedStateOrdering,
                 boolean priorityOrdering,
                 java.lang.String userDN,
                 java.lang.String issuerDN)
                 throws WmJMSAdminException

Create the physical JMS queue on the Broker.

Parameters:

name - the queue to create

clientGroup - the client group to use to create the queue

application - an optional application name for display purposes

sharedState - true to create a shared state queue

sharedStateOrdering - either WmDestination.SHARED_STATE_ORDERING_NONE or WmDestination.SHARED_STATE_ORDERING_PUBLISHER

priorityOrdering - true to create a queue with priority ordering

userDN - the distinguished name of the intended user

issuerDN - the distinguished name of the intended user's issuer

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminAlreadyExistsException - if the queue already exists

WmJMSAdminSecurityException - if there are not sufficient permissions to create the queue on the Broker.

WmJMSAdminException

createQueue

void createQueue(java.lang.String name,
                 java.lang.String clientGroup,
                 java.lang.String application,
                 boolean sharedState,
                 int sharedStateOrdering,
                 boolean priorityOrdering)
                 throws WmJMSAdminException

Create the physical JMS queue on the Broker.

Parameters:

name - the queue to create

clientGroup - the client group to use to create the queue

application - an optional application name for display purposes

sharedState - true to create a shared state queue

sharedStateOrdering - either WmDestination.SHARED_STATE_ORDERING_NONE or WmDestination.SHARED_STATE_ORDERING_PUBLISHER

priorityOrdering - true to create a queue with priority ordering

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminAlreadyExistsException - if the queue already exists

WmJMSAdminSecurityException - if there are not sufficient permissions to create the queue on the Broker.

WmJMSAdminException

destroyQueue

void destroyQueue(javax.jms.Queue queue)
                  throws WmJMSAdminException

Remove the physical JMS queue from the Broker.

Parameters:

queue - the queue to remove

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminDoesNotExistException - if the queue does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to remove the queue from the Broker.

WmJMSAdminException

destroyQueue

void destroyQueue(java.lang.String name)
                  throws WmJMSAdminException

Remove the physical JMS queue from the Broker.

Parameters:

name - the queue name to remove

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminDoesNotExistException - if the queue does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to remove the queue from the Broker.

WmJMSAdminException

clearQueue

void clearQueue(java.lang.String name)
                throws WmJMSAdminException

Clear all messages for a JMS queue on the Broker.

Parameters:

name - the queue name

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminDoesNotExistException - if the queue does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to clear the queue on the Broker.

WmJMSAdminException

clearQueue

void clearQueue(javax.jms.Queue queue)
                throws WmJMSAdminException

Clear all messages for a JMS queue on the Broker.

Parameters:

queue - the queue to clear

Throws:

WmJMSAdminInvalidNameException - if the queue name is invalid

WmJMSAdminDoesNotExistException - if the queue does not exist

WmJMSAdminSecurityException - if there are not sufficient permissions to clear the queue on the Broker.

WmJMSAdminException

getTerritoryBrokerFullNames

java.lang.String[] getTerritoryBrokerFullNames()
                                               throws WmJMSAdminException

Get a list of Brokers in the current Broker's territory.

Returns:

a list of full names of Brokers (Ex BrokerA@localhost:6849) in the current territory

Throws:

WmJMSAdminDoesNotExistException - if the Broker is not currently in a territory

WmJMSAdminSecurityException - if there are not sufficient permissions

WmJMSAdminException