TIBCO Enterprise Message Service
Version 4.3.0

com.tibco.tibjms.admin
Class TibjmsAdmin

java.lang.Object
  extended bycom.tibco.tibjms.admin.TibjmsAdmin

public class TibjmsAdmin
extends java.lang.Object

This is the main class for administering a TIBCO Enterprise Message Service server. To use this API, first create an instance of this class using one of the constructors. With that instance, one can retrieve information about the server and its components, as well as modify the server's configuration.
All modifications to the server configuration are made through this class. For example, to change the description of a group, one would do the following:

 GroupInfo groupInfo = tibjmsAdmin.getGroup("groupName");
 groupInfo.setDescription("New Description");
 tibjmsAdmin.updateGroup(groupInfo);
 


Field Summary
static int STORE_ASYNC
          The server's asynchronous store file.
static int STORE_SYNC
          The server's synchronous store file.
 
Constructor Summary
TibjmsAdmin(java.lang.String url, java.lang.String userName, java.lang.String password)
          Creates an administrative connection.
TibjmsAdmin(java.lang.String url, java.lang.String userName, java.lang.String password, java.util.Map sslParams)
          This constructor is used to create an administrative connection to the server.
 
Method Summary
 void addUsersToGroup(java.lang.String groupName, java.lang.String[] userNames)
          Add the users for the given array of userNames to the group for the given groupName.
 void addUserToGroup(java.lang.String groupName, java.lang.String userName)
          Add the user for the given userName to the group for the given groupName.
 void bind(java.lang.String newName, java.lang.String existingName)
          Bind an object already bound to an existing JNDI name to a new JNDI name.
 void bindQueue(java.lang.String name, java.lang.String queueName)
          Bind the queue for the given queue name to the given JNDI name.
 void bindTopic(java.lang.String name, java.lang.String topicName)
          Bind the topic for the given topic name to the given JNDI name.
 void close()
          Close connection to the server.
 void commitTransaction(TransactionInfo transaction)
          Commit the xa transaction.
 boolean compact(int store, long timeout)
          Compact one of the server's store files until either no more compaction can be done or timeout seconds have elapsed, whichever occurs first.
 void createCMListener(CMListenerInfo cmListener)
          Create (pre-register) TIBCO Rendezvous certified listener.
 void createConnectionFactory(java.lang.String jndiName, ConnectionFactoryInfo cfi)
          Create a connection factory based on the given ConnectionFactoryInfo and bind it to the given name in the internal JNDI implementation.
 DestinationBridgeInfo createDestinationBridge(DestinationBridgeInfo destBridge)
          Creates a destination bridge as specified by the DestinationBridgeInfo object.
 void createDurable(java.lang.String topicName, java.lang.String durableName, java.lang.String clientID, java.lang.String selector, boolean nolocal, boolean route)
          Create the durable with given name and client ID.
 GroupInfo createGroup(GroupInfo group)
          Create a group based on the information in the given GroupInfo.
 QueueInfo createQueue(QueueInfo queue)
          Create a queue based on the parameters from the given QueueInfo.
 RouteInfo createRoute(RouteInfo routeInfo)
          Create a new route.
 TopicInfo createTopic(TopicInfo topic)
          Create a topic based on the parameters from the given TopicInfo.
 UserInfo createUser(UserInfo user)
          Create a user based on the information in the given UserInfo.
 void deleteCMListener(CMListenerInfo cmListener)
          Delete TIBCO Rendezvous certified listener.
 void destroyConnection(long connectionID)
          Destoy the client connection for the given connectionID.
 void destroyConnectionFactory(java.lang.String jndiName)
          Destroy the connection factory bound to the given JNDI name.
 void destroyDestinationBridge(int sourceType, java.lang.String sourceName, int targetType, java.lang.String targetName)
          Destroy the destination bridge between a source and a target
 void destroyDurable(java.lang.String durableName, java.lang.String clientID)
          Destroy the durable with given name and client ID.
 void destroyGroup(java.lang.String groupName)
          Destroy the group for the given groupName.
 void destroyMessage(java.lang.String messageID)
          Destroy the message for the given message ID.
 void destroyQueue(java.lang.String queueName)
          Destroy the queue for the given queue name.
 void destroyRoute(java.lang.String name)
          Destroy the route with specified name.
 void destroyTopic(java.lang.String topicName)
          Destroy the topic for the given topic name.
 void destroyUser(java.lang.String userName)
          Destroy the user for the given userName.
 ACLEntry[] getACLEntries()
          Get all ACL entries for destinations.
 BridgeInfo getBridge(int type, java.lang.String name)
          Get the bridge from a given destination.
 BridgeInfo[] getBridges()
          Get all the bridges known to the server.
 BridgeInfo[] getBridges(int type, java.lang.String pattern)
          Get all the bridges known to the server where the source destination is of a given type and the source destination name matches the given pattern.
 CMLedgerSubjectInfo[] getCMLedger(java.lang.String pattern)
          Returns a summary of the contents of the ledger file of the server's default TIBCO Rendezvous certified messaging transport.
 CMLedgerSubjectInfo[] getCMLedger(java.lang.String transport, java.lang.String pattern)
          Returns a summary of the contents of the transport's ledger file.
 CMListenerInfo[] getCMListeners()
          Get the TIBCO Rendezvous certified listeners explicitly created in the server configuration.
 long getCommandTimeout()
          Gets the command timeout in milliseconds.
 ConnectionFactoryInfo[] getConnectionFactories()
          Get all connection factories in the server configuration.
 long getConnectionId()
          Get the connection id of the TibjmsAdmin object's connection to the server.
 ConnectionInfo[] getConnections()
          Returns all connections except system connections.
 ConsumerInfo[] getConsumersStatistics()
          Get statistical information about all consumers.
 ConsumerInfo[] getConsumersStatistics(java.lang.Long connectionID, java.lang.String username, DestinationInfo destination)
          Get statistical information about consumers with specified parameters.
 DestinationBridgeInfo getDestinationBridge(int sourceType, java.lang.String sourceName, int targetType, java.lang.String targetName)
          Returns the destination bridge between a source and a target
 DestinationBridgeInfo[] getDestinationBridges(int sourceType, java.lang.String sourcePattern)
          Get the destination bridges for all source destinations that match the given source type and source pattern.
 DurableInfo getDurable(java.lang.String durableName, java.lang.String clientID)
          Get the durable subscription information for the given durable name and clientID.
 DurableInfo[] getDurables()
          Get the durable subscription information for all durables known to the server.
 DurableInfo[] getDurables(java.lang.String topicName)
          Get the durable subscription information for the given topic name.
 GroupInfo getGroup(java.lang.String groupName)
          Get the group for the given name.
 ACLEntry[] getGroupACLEntries(java.lang.String groupName)
          Get all permissions on destinations for specified group.
 GroupInfo[] getGroups()
          Get all the groups known to the server.
 ServerInfo getInfo()
          Get the current set of server configuration and metrics.
 Message getMessage(java.lang.String messageID)
          Get the message for the given message ID.
 Message[] getMessages(java.lang.String correlationID)
          Get the messages that have the given correlation ID.
 java.lang.Object[] getPermissions()
          Get all permission entries.
 java.lang.Object[] getPermissions(java.lang.Object target)
          Get all permission entries for specified target.
 ProducerInfo[] getProducersStatistics()
          Returns statistical information about all producers.
 ProducerInfo[] getProducersStatistics(java.lang.Long connectionID, java.lang.String username, DestinationInfo destination)
          Get the statistical information about producers with specified parameters.
 QueueInfo getQueue(java.lang.String queueName)
          Get the queue for the given queue name.
 ACLEntry[] getQueueACLEntries(java.lang.String queueName)
          Get all ACL entries pertaining to the queue with the given queueName.
 QueueInfo[] getQueues()
          Get the info for all the queues that are known to the server.
 QueueInfo[] getQueues(java.lang.String pattern)
          Get the info for the queues that match the given pattern.
 QueueInfo[] getQueuesStatistics()
          Get the statistical information about all queues.
 QueueInfo[] getQueuesStatistics(java.lang.String pattern)
          Get the statistical information for the queues that match the given pattern.
 RouteInfo getRoute(java.lang.String name)
          Returns route information or null if such route does not exist.
 RouteInfo[] getRoutes()
          Returns all routes known to the server.
 RouteInfo getRouteStatistics(java.lang.String name)
          Returns statistical information about the route with specified name.
 StoreInfo getStoreInfo(int store)
          Get a summary of the usage of a store file.
 ConnectionInfo[] getSystemConnections()
          Returns all system connections.
 TopicInfo getTopic(java.lang.String topicName)
          Get the topic for the given topic name.
 ACLEntry[] getTopicACLEntries(java.lang.String topicName)
          Get all ACL entries pertaining to the topic with the given topicName.
 TopicInfo[] getTopics()
          Get the info for all the topics that are known to the server.
 TopicInfo[] getTopics(java.lang.String pattern)
          Get the info for the topics that match the given pattern.
 TopicInfo[] getTopicsStatistics()
          Get the statistical information for all topics.
 TopicInfo[] getTopicsStatistics(java.lang.String pattern)
          Get the statistical information for the topics that match the given pattern.
 TransactionInfo[] getTransactions()
          Get all the xa transactions known to the server.
 TransportInfo getTransport(java.lang.String transportName)
          Get the transport with a given name.
 TransportInfo[] getTransports()
          Get all the transports known to the server.
 UserInfo getUser(java.lang.String userName)
          Get the user for the given username.
 ACLEntry[] getUserACLEntries(java.lang.String userName)
          Get all ACL entries pertaining to the user with the given userName.
 UserInfo[] getUsers()
          Get the array of all UserInfos known to the server.
 void grant(ACLEntry entry)
          Grant the permissions specified in the given ACLEntry.
 void grant(ACLEntry[] acls)
          Grant the permissions specified in the given ACLEntries.
 void grant(AdminACLEntry entry)
          Grant the administrative permissions.
 boolean isAutoSave()
          Returns true if server configuration is saved in the configuration files on disk after each change.
 java.lang.Object lookup(java.lang.String name)
          Retrieve that administrative object bound to the given JNDI name.
 void purgeDurable(java.lang.String durableName, java.lang.String clientID)
          Purge pending messages for the durable with given name and client ID.
 void purgeQueue(java.lang.String queueName)
          Purge pending messages from the queue for the given name.
 void purgeTopic(java.lang.String topicName)
          Purge pending messages from the topic for the given name.
 void removeUserFromGroup(java.lang.String groupName, java.lang.String userName)
          Remove the user for the given userName from the group for the given groupName.
 void removeUsersFromGroup(java.lang.String groupName, java.lang.String[] userNames)
          Remove the users for the given array of userNames from the group for the given groupName.
 void revoke(ACLEntry entry)
          Revoke the permissions specified in the given ACLEntry.
 void revoke(ACLEntry[] acls)
          Revoke the permissions specified in the given ACLEntries.
 void revoke(AdminACLEntry entry)
          Revoke the administrative permissions.
 void rollbackTransaction(TransactionInfo transaction)
          Roll the xa transaction back.
 void rotateLog()
          Rotate server's log file.
 void saveConfiguration()
          Save any configuration changes to the server's config files.
 void setAutoSave(boolean enabled)
          Set if configuration changes should be immediately saved by the server into the configuration files on disk.
 void setCommandTimeout(long value)
          Sets the command timeout.
 void setExceptionListener(ExceptionListener listener)
          Sets an exception listener for the connection used by the admin api to communicate with the EMS server.
 void shutdown()
          Shutdown the server.
 void unbind(java.lang.String name)
          Remove the binding between the given JNDI name and the object bound to it.
 void updateConnectionFactory(java.lang.String jndiName, ConnectionFactoryInfo cfi)
          Save changes to the connection factory stored at the given JNDI name using information from the given ConnectionFactoryInfo.
 void updateCRL()
          Update server's CRL.
 void updateGroup(GroupInfo groupInfo)
          Save changes made to the given GroupInfo.
 void updateQueue(QueueInfo queue)
          Change the properties of the queue corresponding to the given QueueInfo.
 void updateRoute(RouteInfo routeInfo)
          Update route parameters.
 void updateServer(ServerInfo info)
          Update the server configuration.
 void updateTopic(TopicInfo topic)
          Change the properties of the topic corresponding to the given TopicInfo.
 void updateUser(UserInfo userInfo)
          Save changes made to the given UserInfo.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STORE_SYNC

public static final int STORE_SYNC
The server's synchronous store file.

See Also:
Constant Field Values

STORE_ASYNC

public static final int STORE_ASYNC
The server's asynchronous store file.

See Also:
Constant Field Values
Constructor Detail

TibjmsAdmin

public TibjmsAdmin(java.lang.String url,
                   java.lang.String userName,
                   java.lang.String password)
            throws TibjmsAdminException
Creates an administrative connection.

Parameters:
url - The URL of the server to administer.
userName - Name of the administrator user.
password - User password.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

TibjmsAdmin

public TibjmsAdmin(java.lang.String url,
                   java.lang.String userName,
                   java.lang.String password,
                   java.util.Map sslParams)
            throws TibjmsAdminException
This constructor is used to create an administrative connection to the server. Use this constructor if the connection to the server needs to use SSL.

Parameters:
url - The URL of the server to administer.
userName - Name of the administrator user.
password - User password.
sslParams - The parameters used for the SSL connection. See the documentation of the com.tibco.tibjms.TibjmsSSL class for details of valid SLL parameters.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
Method Detail

close

public void close()
           throws TibjmsAdminException
Close connection to the server. After connection is closed the TibjmsAdmin object should no longer be used.

Throws:
TibjmsAdminException - if an error occurred.

getCommandTimeout

public long getCommandTimeout()
Gets the command timeout in milliseconds. If the server does not respond to a command within specified timeout the command thows exception. Default value is 60000 (60 seconds).

Returns:
the current timeout in milliseconds.

setCommandTimeout

public void setCommandTimeout(long value)
                       throws java.lang.IllegalArgumentException
Sets the command timeout. If the server does not respond to a command within specified timeout the command thows exception. Default value is 60000 (60 seconds). Minimum value accepted is 5000 (5 seconds).

Parameters:
value - new timeout in milliseconds.
Throws:
java.lang.IllegalArgumentException - if value is less than 5000ms.

saveConfiguration

public void saveConfiguration()
                       throws TibjmsAdminException
Save any configuration changes to the server's config files. This call is necessary when auto save mode is not set.

Throws:
TibjmsAdminException - if not authorized or an error occurred.

setAutoSave

public void setAutoSave(boolean enabled)
Set if configuration changes should be immediately saved by the server into the configuration files on disk. If auto save is turned off, the application should call saveConfiguration() method in order to save all changes in the configuration files. If auto save is turned on, the server updates the configuration files on disk after every change and calls to saveConfiguration() are not required.

Parameters:
enabled - true if chages should be saved after every change in the configuration.

isAutoSave

public boolean isAutoSave()
Returns true if server configuration is saved in the configuration files on disk after each change. If auto save mode is turned off, the application should call saveConfiguration() method in order to save the changes in the configuration files.

Returns:
true if configuration is saved in the files after every change.

getInfo

public ServerInfo getInfo()
                   throws TibjmsAdminException
Get the current set of server configuration and metrics.

Returns:
a ServerInfo object containing the current configuration and metrics for the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

updateServer

public void updateServer(ServerInfo info)
                  throws TibjmsAdminException,
                         java.lang.IllegalArgumentException
Update the server configuration.

Parameters:
info - a ServerInfo object containing the changed configuration parameters.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if ServerInfo object is null.

shutdown

public void shutdown()
              throws TibjmsAdminException
Shutdown the server. This causes the connection to the server to be lost, so subsequent calls to this object will fail with the exception of close() method.

Throws:
TibjmsAdminException - if not authorized or an error occurred.

rotateLog

public void rotateLog()
               throws TibjmsAdminException
Rotate server's log file.

Throws:
TibjmsAdminException - if not authorized or an error occurred.

updateCRL

public void updateCRL()
               throws TibjmsAdminException
Update server's CRL.

Throws:
TibjmsAdminException - if an error occurred.

createCMListener

public void createCMListener(CMListenerInfo cmListener)
                      throws TibjmsAdminException,
                             java.lang.IllegalArgumentException
Create (pre-register) TIBCO Rendezvous certified listener.

Parameters:
cmListener - the certified listener to be created (pre-registered).
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if CMListenerInfo object is null.

deleteCMListener

public void deleteCMListener(CMListenerInfo cmListener)
                      throws TibjmsAdminException,
                             java.lang.IllegalArgumentException
Delete TIBCO Rendezvous certified listener.

Parameters:
cmListener - the certified listener to be deleted.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if cmListener is null.

getCMListeners

public CMListenerInfo[] getCMListeners()
                                throws TibjmsAdminException
Get the TIBCO Rendezvous certified listeners explicitly created in the server configuration.

Returns:
array of CMListenerInfo objects.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getCMLedger

public CMLedgerSubjectInfo[] getCMLedger(java.lang.String pattern)
                                  throws TibjmsAdminException
Returns a summary of the contents of the ledger file of the server's default TIBCO Rendezvous certified messaging transport. If the server uses multiple named transports then use the getCMLedger(String transport, String pattern) method to query the ledger for the given transport. Specifying a pattern limits the scope of the query to only those Rendezvous subjects matching the pattern. The pattern may contain the wildcards "*" and ">". See the Tibjms documentation for how wildcards work. A pattern of "", ">", or null will return information on all the subjects in the ledger file.

Parameters:
pattern - a pattern indicating which subjects are of interest.
Returns:
array of CMLedgerSubjectInfo objects that match the given pattern.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getCMLedger

public CMLedgerSubjectInfo[] getCMLedger(java.lang.String transport,
                                         java.lang.String pattern)
                                  throws TibjmsAdminException
Returns a summary of the contents of the transport's ledger file. Specifying a pattern limits the scope of the query to only those Rendezvous subjects matching the pattern. The pattern may contain the wildcards "*" and ">". See the Tibjms documentation for how wildcards work. A pattern of "", ">", or null will return information on all the subjects in the ledger file.

Parameters:
transport - the name of the transport whose ledger file is to be summarized.
pattern - a pattern indicating which subjects are of interest.
Returns:
array of CMLedgerSubjectInfo objects that match the given pattern.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getRoute

public RouteInfo getRoute(java.lang.String name)
                   throws TibjmsAdminException,
                          TibjmsAdminInvalidNameException
Returns route information or null if such route does not exist. Notice returned object does not contain statistical data for the route. Use getRouteStatistics() method to obtain statistical information about the route.

Parameters:
name - name of the route.
Returns:
RouteInfo object or null if route with such name does not exist.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if name is not a legal route name.

getRoutes

public RouteInfo[] getRoutes()
                      throws TibjmsAdminException
Returns all routes known to the server. Notice returned objects do not contain statistical data for the routes. Use getRouteStatistics() method to obtain statistical information about the route.

Returns:
all routes known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

createRoute

public RouteInfo createRoute(RouteInfo routeInfo)
                      throws TibjmsAdminException,
                             java.lang.IllegalArgumentException
Create a new route.

Parameters:
routeInfo - The parameters for the new route.
Returns:
the fully configured RouteInfo from the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if routeInfo is null.
TibjmsAdminInvalidNameException - if RouteInfo object does not have a legal name and url.

updateRoute

public void updateRoute(RouteInfo routeInfo)
                 throws TibjmsAdminException,
                        java.lang.IllegalArgumentException
Update route parameters. This method can only be used to update a route that already exists on the server. To create a new route use the createRoute(com.tibco.tibjms.admin.RouteInfo) method.

Parameters:
routeInfo - The route info to save.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException

destroyRoute

public void destroyRoute(java.lang.String name)
                  throws TibjmsAdminException,
                         TibjmsAdminInvalidNameException
Destroy the route with specified name.

Parameters:
name - The name of the route to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if name is not a legal route name.

getConnections

public ConnectionInfo[] getConnections()
                                throws TibjmsAdminException
Returns all connections except system connections. System connections are connections to other servers.

Returns:
all the (non-system) connections known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getSystemConnections

public ConnectionInfo[] getSystemConnections()
                                      throws TibjmsAdminException
Returns all system connections. System connections are connections to other servers.

Returns:
all the system connections known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
Since:
Version 4.2

destroyConnection

public void destroyConnection(long connectionID)
                       throws TibjmsAdminException
Destoy the client connection for the given connectionID. This will disconnect the client using the connection from the server, so this method should be used with caution.

Parameters:
connectionID - The connection ID of the connection to be destroyed.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

createQueue

public QueueInfo createQueue(QueueInfo queue)
                      throws TibjmsAdminException
Create a queue based on the parameters from the given QueueInfo.

Parameters:
queue - The description of the queue to be created.
Returns:
The fully configured QueueInfo from the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the name of the queue is not a legal queue name.
TibjmsAdminNameExistsException - if a queue already exists with the given name.

updateQueue

public void updateQueue(QueueInfo queue)
                 throws TibjmsAdminException,
                        java.lang.IllegalArgumentException
Change the properties of the queue corresponding to the given QueueInfo. This method can only be used to update a queue that already exists on the server. To create a new queue use the createQueue(com.tibco.tibjms.admin.QueueInfo) method.

Parameters:
queue - The QueueInfo for the queue to be modified.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if QueueInfo object is null.

destroyQueue

public void destroyQueue(java.lang.String queueName)
                  throws TibjmsAdminException,
                         TibjmsAdminInvalidNameException
Destroy the queue for the given queue name.

Parameters:
queueName - The name of the queue to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if queueName is not a legal queue name.

getQueue

public QueueInfo getQueue(java.lang.String queueName)
                   throws TibjmsAdminException,
                          TibjmsAdminInvalidNameException
Get the queue for the given queue name.

Parameters:
queueName - The name of the queue to get.
Returns:
The QueueInfo for the given name or null if the name is not found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if queueName is not a legal name

getQueues

public QueueInfo[] getQueues(java.lang.String pattern)
                      throws TibjmsAdminException
Get the info for the queues that match the given pattern. The pattern may contain the wildcards "*" and ">". See the Tibjms documentation for how wildcards work in queue names. A pattern of "", ">", or null will return all the queues.

Parameters:
pattern - The pattern that must be matched
Returns:
The QueueInfos that match the pattern.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getQueues

public QueueInfo[] getQueues()
                      throws TibjmsAdminException
Get the info for all the queues that are known to the server.

Returns:
the QueueInfos for all the queues that are known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

purgeQueue

public void purgeQueue(java.lang.String queueName)
                throws TibjmsAdminException,
                       TibjmsAdminInvalidNameException
Purge pending messages from the queue for the given name.

Parameters:
queueName - The name of the queue to purge.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if queueName is not a legal queue name.

createTopic

public TopicInfo createTopic(TopicInfo topic)
                      throws TibjmsAdminException
Create a topic based on the parameters from the given TopicInfo.

Parameters:
topic - The description of the topic to be created.
Returns:
The fully configured TopicInfo from the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the name of the topic is not a legal topic name.
TibjmsAdminNameExistsException - if a topic already exists with the given name.

updateTopic

public void updateTopic(TopicInfo topic)
                 throws TibjmsAdminException,
                        java.lang.IllegalArgumentException
Change the properties of the topic corresponding to the given TopicInfo. This method can only be used to update a topic that already exists on the server. To create a new topic use the createTopic(com.tibco.tibjms.admin.TopicInfo) method.

Parameters:
topic - The TopicInfo for the queue to be modified.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if TopicInfo object is null.

destroyTopic

public void destroyTopic(java.lang.String topicName)
                  throws TibjmsAdminException,
                         TibjmsAdminInvalidNameException
Destroy the topic for the given topic name.

Parameters:
topicName - The name of the topic to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if topicName is not a legal topic name.

getTopic

public TopicInfo getTopic(java.lang.String topicName)
                   throws TibjmsAdminException,
                          TibjmsAdminInvalidNameException
Get the topic for the given topic name.

Parameters:
topicName - The name of the topic to get.
Returns:
The TopicInfo for the given name or null if the name is not found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if topicName is not a legal topic name

getTopics

public TopicInfo[] getTopics(java.lang.String pattern)
                      throws TibjmsAdminException
Get the info for the topics that match the given pattern. The pattern may contain the wildcards "*" and ">" . See the Tibjms documentation for how wildcards work in topic names. A pattern of "", ">", or null will return all the topics.

Parameters:
pattern - The pattern that must be matched
Returns:
The TopicInfos that match the pattern.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getTopics

public TopicInfo[] getTopics()
                      throws TibjmsAdminException
Get the info for all the topics that are known to the server.

Returns:
the TopicInfos for all the topics that are known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

purgeTopic

public void purgeTopic(java.lang.String topicName)
                throws TibjmsAdminException,
                       TibjmsAdminInvalidNameException
Purge pending messages from the topic for the given name.

Parameters:
topicName - The name of the topic to purge.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if topicName is not a legal topic name.

createUser

public UserInfo createUser(UserInfo user)
                    throws TibjmsAdminException,
                           TibjmsAdminInvalidNameException,
                           TibjmsAdminNameExistsException
Create a user based on the information in the given UserInfo.

Parameters:
user - The information for the user to be created.
Returns:
the fully configured UserInfo from the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the name of the user is not a legal user name.
TibjmsAdminNameExistsException - if a user already exists with the given name.

destroyUser

public void destroyUser(java.lang.String userName)
                 throws TibjmsAdminException,
                        TibjmsAdminInvalidNameException
Destroy the user for the given userName.

Parameters:
userName - The name of the user to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if userName is not a legal user name.

updateUser

public void updateUser(UserInfo userInfo)
                throws TibjmsAdminException,
                       java.lang.IllegalArgumentException
Save changes made to the given UserInfo. This method can only be used to update a user that already exists on the server. To create a new user use the createUser(com.tibco.tibjms.admin.UserInfo) method.

Parameters:
userInfo - The user information to save.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if UserInfo object is null.

getUser

public UserInfo getUser(java.lang.String userName)
                 throws TibjmsAdminException,
                        TibjmsAdminInvalidNameException
Get the user for the given username.

Parameters:
userName - The name of the user to retrieve info for.
Returns:
the UserInfo object for the given username or null if the name is not found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if userName is not a legal user name.

getUsers

public UserInfo[] getUsers()
                    throws TibjmsAdminException
Get the array of all UserInfos known to the server.

Returns:
the array of all UserInfos known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

createGroup

public GroupInfo createGroup(GroupInfo group)
                      throws TibjmsAdminException,
                             TibjmsAdminInvalidNameException,
                             TibjmsAdminNameExistsException
Create a group based on the information in the given GroupInfo.

Parameters:
group - The info for the group to be created.
Returns:
The fully configured GroupInfo from the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the name of the group is not a legal group name.
TibjmsAdminNameExistsException - if a user aleady exists with the given name.

destroyGroup

public void destroyGroup(java.lang.String groupName)
                  throws TibjmsAdminException,
                         TibjmsAdminInvalidNameException
Destroy the group for the given groupName.

Parameters:
groupName - The name of the group to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if groupName is not a legal name.

updateGroup

public void updateGroup(GroupInfo groupInfo)
                 throws TibjmsAdminException,
                        java.lang.IllegalArgumentException
Save changes made to the given GroupInfo. This method can only be used to update a group that already exists on the server. To create a new group use the createGroup(com.tibco.tibjms.admin.GroupInfo) method.

Parameters:
groupInfo - The group to save configuration changes for.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if GroupInfo object is null.

getGroup

public GroupInfo getGroup(java.lang.String groupName)
                   throws TibjmsAdminException,
                          TibjmsAdminInvalidNameException
Get the group for the given name.

Parameters:
groupName - The name of the group to retrieve.
Returns:
the GroupInfo for the given name or null if the name is not found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if groupName is not a legal group name.

getGroups

public GroupInfo[] getGroups()
                      throws TibjmsAdminException
Get all the groups known to the server.

Returns:
all the groups known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

addUserToGroup

public void addUserToGroup(java.lang.String groupName,
                           java.lang.String userName)
                    throws TibjmsAdminException
Add the user for the given userName to the group for the given groupName.

Parameters:
groupName - The group that the user will be added to.
userName - The user to be added.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the names of the group or the user are not legal.

addUsersToGroup

public void addUsersToGroup(java.lang.String groupName,
                            java.lang.String[] userNames)
                     throws TibjmsAdminException,
                            TibjmsAdminInvalidNameException,
                            java.lang.IllegalArgumentException
Add the users for the given array of userNames to the group for the given groupName.

Parameters:
groupName - The group that the users will be added to.
userNames - The users to be added.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the names of the group or users are not legal.
java.lang.IllegalArgumentException - if the array of user names is null.

removeUserFromGroup

public void removeUserFromGroup(java.lang.String groupName,
                                java.lang.String userName)
                         throws TibjmsAdminException,
                                TibjmsAdminInvalidNameException
Remove the user for the given userName from the group for the given groupName.

Parameters:
groupName - The group that the user will be removed from.
userName - The user to be removed.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if groupName or userName are not legal names.

removeUsersFromGroup

public void removeUsersFromGroup(java.lang.String groupName,
                                 java.lang.String[] userNames)
                          throws TibjmsAdminException,
                                 TibjmsAdminInvalidNameException,
                                 java.lang.IllegalArgumentException
Remove the users for the given array of userNames from the group for the given groupName.

Parameters:
groupName - The group that the users will be removed from.
userNames - The users to be removed.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if groupName or one of the user names is not a legal name.
java.lang.IllegalArgumentException - if userNames is null;

getPermissions

public java.lang.Object[] getPermissions()
                                  throws TibjmsAdminException
Get all permission entries.

Returns:
all ACL entries known to the server. Array elements are ACLEntry and AdminACLEntry objects.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getPermissions

public java.lang.Object[] getPermissions(java.lang.Object target)
                                  throws TibjmsAdminException
Get all permission entries for specified target. Target parameter can be UserInfo, GroupInfo, TopicInfo or QueueInfo. If target parameter is null, this method returns all permissions.

Parameters:
target - the object
Returns:
all ACL entries for specified target object
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getACLEntries

public ACLEntry[] getACLEntries()
                         throws TibjmsAdminException
Get all ACL entries for destinations.

Returns:
all ACL entries for destinations known to the server
Throws:
TibjmsAdminException - if not authorized or some error occurred.

getQueueACLEntries

public ACLEntry[] getQueueACLEntries(java.lang.String queueName)
                              throws TibjmsAdminException,
                                     TibjmsAdminInvalidNameException
Get all ACL entries pertaining to the queue with the given queueName.

Parameters:
queueName - Queue name.
Returns:
the array of ACLEntries for the given queue.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
TibjmsAdminInvalidNameException - if queueName is not a legal queue name.

getTopicACLEntries

public ACLEntry[] getTopicACLEntries(java.lang.String topicName)
                              throws TibjmsAdminException,
                                     TibjmsAdminInvalidNameException
Get all ACL entries pertaining to the topic with the given topicName.

Parameters:
topicName - Topic name.
Returns:
the array of ACLEntries for the given topic.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
TibjmsAdminInvalidNameException - if topicName is not a legal topic name.

getUserACLEntries

public ACLEntry[] getUserACLEntries(java.lang.String userName)
                             throws TibjmsAdminException,
                                    TibjmsAdminInvalidNameException
Get all ACL entries pertaining to the user with the given userName.

Parameters:
userName - User name.
Returns:
the array of ACLEntries for the given user.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
TibjmsAdminInvalidNameException - if userName is not a legal user name.

getGroupACLEntries

public ACLEntry[] getGroupACLEntries(java.lang.String groupName)
                              throws TibjmsAdminException,
                                     TibjmsAdminInvalidNameException
Get all permissions on destinations for specified group.

Parameters:
groupName - the name of the group.
Returns:
array of ACLEntry objects for the specified group.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
TibjmsAdminInvalidNameException - if groupName is not a legal group name.

grant

public void grant(ACLEntry entry)
           throws TibjmsAdminException,
                  java.lang.IllegalArgumentException
Grant the permissions specified in the given ACLEntry.

Parameters:
entry - The description of the permissions to grant.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
java.lang.IllegalArgumentException - if entry is null.

grant

public void grant(ACLEntry[] acls)
           throws TibjmsAdminException,
                  java.lang.IllegalArgumentException
Grant the permissions specified in the given ACLEntries.

Parameters:
acls - The descriptions of the permissions to grant.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
java.lang.IllegalArgumentException - if acls is null.

grant

public void grant(AdminACLEntry entry)
           throws TibjmsAdminException,
                  java.lang.IllegalArgumentException
Grant the administrative permissions.

Parameters:
entry - the AdminACLEntry to grant.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
java.lang.IllegalArgumentException - if entry is null.

revoke

public void revoke(ACLEntry entry)
            throws TibjmsAdminException,
                   java.lang.IllegalArgumentException
Revoke the permissions specified in the given ACLEntry.

Parameters:
entry - the ACLEntry to revoke.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
java.lang.IllegalArgumentException - if ACLEntry is null.

revoke

public void revoke(ACLEntry[] acls)
            throws TibjmsAdminException,
                   java.lang.IllegalArgumentException
Revoke the permissions specified in the given ACLEntries.

Parameters:
acls - an array of ACLEntry objects containing the positive permissions to be revoked.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
java.lang.IllegalArgumentException - if ACLEntry array is null.

revoke

public void revoke(AdminACLEntry entry)
            throws TibjmsAdminException,
                   java.lang.IllegalArgumentException
Revoke the administrative permissions. Only permissions specified as positive in the AdminPermissions member of supplied AdminAclEntry are taken into account and revoked. The negative permissions of participating AdminPermissions are ignored.

Parameters:
entry - the AdminACLEntry containing the positive permissions to be revoked.
Throws:
TibjmsAdminException - if not authorized or some error occurred.
java.lang.IllegalArgumentException - if AdminACLEntry is null.

getDurable

public DurableInfo getDurable(java.lang.String durableName,
                              java.lang.String clientID)
                       throws TibjmsAdminException,
                              TibjmsAdminInvalidNameException
Get the durable subscription information for the given durable name and clientID.

Parameters:
durableName - name of the durable subsription.
clientID - client ID associated with the durable (can be null).
Returns:
the DurableInfo.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if durableName is not a legal name.

getDurables

public DurableInfo[] getDurables(java.lang.String topicName)
                          throws TibjmsAdminException
Get the durable subscription information for the given topic name.

Parameters:
topicName - The name of topic to get durable information on.
Returns:
the array of DurableInfos for the given topic.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getDurables

public DurableInfo[] getDurables()
                          throws TibjmsAdminException
Get the durable subscription information for all durables known to the server.

Returns:
the array of DurableInfos for the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

purgeDurable

public void purgeDurable(java.lang.String durableName,
                         java.lang.String clientID)
                  throws TibjmsAdminException,
                         TibjmsAdminInvalidNameException
Purge pending messages for the durable with given name and client ID.

Parameters:
durableName - The name of the durable to purge.
clientID - The client ID associated with the durable (can be null).
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if durableName is not a legal durable name.

createDurable

public void createDurable(java.lang.String topicName,
                          java.lang.String durableName,
                          java.lang.String clientID,
                          java.lang.String selector,
                          boolean nolocal,
                          boolean route)
                   throws TibjmsAdminException,
                          TibjmsAdminInvalidNameException
Create the durable with given name and client ID.

Parameters:
topicName - The name of topic on which to create durable.
durableName - The name of the durable to create.
clientID - The client ID associated with the durable (can be null).
selector - The selector associated with the durable (can be null).
nolocal - Prevents reception of messages sent on this session.
route - Designates this as a durable for another server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if durableName is not a legal name.

destroyDurable

public void destroyDurable(java.lang.String durableName,
                           java.lang.String clientID)
                    throws TibjmsAdminException,
                           TibjmsAdminInvalidNameException
Destroy the durable with given name and client ID.

Parameters:
durableName - The name of the durable to destroy.
clientID - The client ID associated with the durable (can be null).
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if durableName is not a legal name.

getMessage

public Message getMessage(java.lang.String messageID)
                   throws TibjmsAdminException,
                          java.lang.IllegalArgumentException
Get the message for the given message ID.

Parameters:
messageID - The ID of the message to retrieve.
Returns:
the message for the given ID or null if none is found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if messageID is not a legal ID.

destroyMessage

public void destroyMessage(java.lang.String messageID)
                    throws TibjmsAdminException
Destroy the message for the given message ID.

Parameters:
messageID - The ID of the message to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if messageID is not a legal ID.

getMessages

public Message[] getMessages(java.lang.String correlationID)
                      throws TibjmsAdminException,
                             java.lang.IllegalArgumentException
Get the messages that have the given correlation ID.

Parameters:
correlationID - The correlation ID of the messages to retrieve.
Returns:
The array of messages with the given correlation ID.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if correlationID is not a legal ID.

getConnectionFactories

public ConnectionFactoryInfo[] getConnectionFactories()
                                               throws TibjmsAdminException
Get all connection factories in the server configuration.

Returns:
array of ConnectionFactoryInfo objects.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

createConnectionFactory

public void createConnectionFactory(java.lang.String jndiName,
                                    ConnectionFactoryInfo cfi)
                             throws TibjmsAdminException,
                                    TibjmsAdminInvalidNameException,
                                    java.lang.IllegalArgumentException,
                                    TibjmsAdminNameExistsException
Create a connection factory based on the given ConnectionFactoryInfo and bind it to the given name in the internal JNDI implementation.

Parameters:
jndiName - The JNDI name to which the new factory will be bound.
cfi - The info for the factory to create.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if the JNDI name is not legal.
java.lang.IllegalArgumentException - if ConnectionFactoryInfo object is null.
TibjmsAdminNameExistsException - if the JNDI name is already in use.

updateConnectionFactory

public void updateConnectionFactory(java.lang.String jndiName,
                                    ConnectionFactoryInfo cfi)
                             throws TibjmsAdminException,
                                    TibjmsAdminInvalidNameException,
                                    java.lang.IllegalArgumentException
Save changes to the connection factory stored at the given JNDI name using information from the given ConnectionFactoryInfo. This method can only be used to update a factory that already exists on the server. To create a new factory use the createConnectionFactory(java.lang.String, com.tibco.tibjms.admin.ConnectionFactoryInfo) method.

Parameters:
jndiName - The JNDI name of the factory that will be updated.
cfi - The updated info for the factory.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if jndiName is not a legal JNDI name.
java.lang.IllegalArgumentException - if ConnectionFactoryInfo object is null.

destroyConnectionFactory

public void destroyConnectionFactory(java.lang.String jndiName)
                              throws TibjmsAdminException,
                                     TibjmsAdminInvalidNameException
Destroy the connection factory bound to the given JNDI name.

Parameters:
jndiName - A JNDI name for the factory to destroy.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if jndiName is not a legal name.

bindQueue

public void bindQueue(java.lang.String name,
                      java.lang.String queueName)
               throws TibjmsAdminException,
                      TibjmsAdminNameExistsException,
                      TibjmsAdminInvalidNameException
Bind the queue for the given queue name to the given JNDI name.

Parameters:
name - The JNDI name to which the queue will be bound.
queueName - The name of the queue to bind.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminNameExistsException - if the JNDI name is already in use.
TibjmsAdminInvalidNameException - if name or queueName are not legal names.

bindTopic

public void bindTopic(java.lang.String name,
                      java.lang.String topicName)
               throws TibjmsAdminException,
                      TibjmsAdminNameExistsException,
                      TibjmsAdminInvalidNameException
Bind the topic for the given topic name to the given JNDI name.

Parameters:
name - The JNDI name to which the topic will be bound.
topicName - The name of the topic to bind.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminNameExistsException - if the JNDI name is already in use.
TibjmsAdminInvalidNameException - if name and topicName are legal names.

bind

public void bind(java.lang.String newName,
                 java.lang.String existingName)
          throws TibjmsAdminException,
                 TibjmsAdminNameExistsException,
                 TibjmsAdminInvalidNameException
Bind an object already bound to an existing JNDI name to a new JNDI name. The object will be bound to both names after this call.

Parameters:
newName - The new name that will be bound to the object currently bound to the existing name.
existingName - The name that is currently bound to the object.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminNameExistsException - if the JNDI name is already in use.
TibjmsAdminInvalidNameException - if the JNDI names are not legal.

unbind

public void unbind(java.lang.String name)
            throws TibjmsAdminException,
                   TibjmsAdminInvalidNameException
Remove the binding between the given JNDI name and the object bound to it. Note that removing the last JNDI name for a connection factory results in the destruction of that factory.

Parameters:
name - The JNDI name to unbind.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if name is not a legal JNDI name.

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws TibjmsAdminException,
                               TibjmsAdminInvalidNameException
Retrieve that administrative object bound to the given JNDI name.

Parameters:
name - The JNDI name to lookup.
Returns:
the ConnectionFactoryInfo, TopicInfo, or QueueInfo bound to the given name or null if nothing is bound to the name.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if name is not a legal name.

getConsumersStatistics

public ConsumerInfo[] getConsumersStatistics()
                                      throws TibjmsAdminException
Get statistical information about all consumers.

Returns:
array of ConsumerInfo objects with statistical data or null if no consumers found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getConsumersStatistics

public ConsumerInfo[] getConsumersStatistics(java.lang.Long connectionID,
                                             java.lang.String username,
                                             DestinationInfo destination)
                                      throws TibjmsAdminException
Get statistical information about consumers with specified parameters.

Parameters:
connectionID - consumer connection ID or null.
username - consumer user name or null.
destination - consumer destination pattern or null.
Returns:
array of ConsumerInfo objects with statistical data or null if no consumers found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getProducersStatistics

public ProducerInfo[] getProducersStatistics()
                                      throws TibjmsAdminException
Returns statistical information about all producers.

Returns:
array of ProducerInfo objects with statistical data or null if no producers found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getProducersStatistics

public ProducerInfo[] getProducersStatistics(java.lang.Long connectionID,
                                             java.lang.String username,
                                             DestinationInfo destination)
                                      throws TibjmsAdminException
Get the statistical information about producers with specified parameters.

Parameters:
connectionID - producer connection ID or null.
username - producer user name or null.
destination - producer destination pattern or null.
Returns:
array of ProducerInfo objects with statistical data or null if no producers found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getTopicsStatistics

public TopicInfo[] getTopicsStatistics()
                                throws TibjmsAdminException
Get the statistical information for all topics.

Returns:
array of TopicInfo objects with statistical data or null if no topics found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getTopicsStatistics

public TopicInfo[] getTopicsStatistics(java.lang.String pattern)
                                throws TibjmsAdminException
Get the statistical information for the topics that match the given pattern. The pattern may contain the wildcards "*" and ">". See the Tibjms documentation for how wildcards work in topic names. A pattern of "", ">", or null will return statistics for all the topics.

Parameters:
pattern - The pattern that must be matched
Returns:
array of TopicInfo objects with statistical data or null if no topics found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getQueuesStatistics

public QueueInfo[] getQueuesStatistics()
                                throws TibjmsAdminException
Get the statistical information about all queues.

Returns:
array of QueueInfo objects with statistical data or null if no queues found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getQueuesStatistics

public QueueInfo[] getQueuesStatistics(java.lang.String pattern)
                                throws TibjmsAdminException
Get the statistical information for the queues that match the given pattern. The wildcards "*" and ">" may be included in the pattern. See the Tibjms documentation for how wildcards work in queue names. A pattern of "", ">", or null will return statistics for all the queues.

Parameters:
pattern - The pattern that must be matched
Returns:
array of QueueInfo objects with statistical data or null if no queues found or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getRouteStatistics

public RouteInfo getRouteStatistics(java.lang.String name)
                             throws TibjmsAdminException,
                                    TibjmsAdminInvalidNameException
Returns statistical information about the route with specified name.

Parameters:
name - name of the route.
Returns:
RouteInfo object or null if route with such name does not exist or statistics is disabled.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if name is not a legal route name.

getTransactions

public TransactionInfo[] getTransactions()
                                  throws TibjmsAdminException
Get all the xa transactions known to the server.

Returns:
all the xa transactions known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

commitTransaction

public void commitTransaction(TransactionInfo transaction)
                       throws TibjmsAdminException,
                              java.lang.IllegalArgumentException
Commit the xa transaction.

Parameters:
transaction - The TransactionInfo object for the transaction to be committed.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if transaction is null.

rollbackTransaction

public void rollbackTransaction(TransactionInfo transaction)
                         throws TibjmsAdminException,
                                java.lang.IllegalArgumentException
Roll the xa transaction back.

Parameters:
transaction - The TransactionInfo object for the transaction to be rolled back.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if TransactionInfo object is null.

getTransports

public TransportInfo[] getTransports()
                              throws TibjmsAdminException
Get all the transports known to the server.

Returns:
all the transports known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getTransport

public TransportInfo getTransport(java.lang.String transportName)
                           throws TibjmsAdminException,
                                  TibjmsAdminInvalidNameException
Get the transport with a given name.

Parameters:
transportName - the name of the transport.
Returns:
the transport or null if not found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
TibjmsAdminInvalidNameException - if transportName is not a legal transport name

setExceptionListener

public void setExceptionListener(ExceptionListener listener)
                          throws TibjmsAdminException
Sets an exception listener for the connection used by the admin api to communicate with the EMS server. See the EMS API documentation for more information about exception listeners.

Parameters:
listener - the exception listener.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getBridges

public BridgeInfo[] getBridges()
                        throws TibjmsAdminException
Get all the bridges known to the server.

Returns:
all the bridges known to the server.
Throws:
TibjmsAdminException - if not authorized or an error occurred.

getBridges

public BridgeInfo[] getBridges(int type,
                               java.lang.String pattern)
                        throws TibjmsAdminException,
                               java.lang.IllegalArgumentException
Get all the bridges known to the server where the source destination is of a given type and the source destination name matches the given pattern.

Parameters:
type - the type of source destination, either DestinationInfo.QUEUE_TYPE to return only bridges from queues, DestinationInfo.TOPIC_TYPE to return only bridges from topics, or DestinationInfo.ALL_TYPE types to return bridges from both queues and topics.
pattern - a filter to restrict the bridges that are returned to only those whose name matches the pattern, null indicates all bridges.
Returns:
all the matching bridges.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if type is invalid

getBridge

public BridgeInfo getBridge(int type,
                            java.lang.String name)
                     throws TibjmsAdminException,
                            java.lang.IllegalArgumentException
Get the bridge from a given destination.

Parameters:
type - the type of source destination, either DestinationInfo.QUEUE_TYPE or DestinationInfo.TOPIC_TYPE.
name - the name of the source destination
Returns:
the BridgeInfo object representing the bridge or null if one wasn't found.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - type is invalid or name is null

createDestinationBridge

public DestinationBridgeInfo createDestinationBridge(DestinationBridgeInfo destBridge)
                                              throws TibjmsAdminException,
                                                     java.lang.IllegalArgumentException,
                                                     TibjmsAdminInvalidNameException,
                                                     TibjmsAdminNameExistsException
Creates a destination bridge as specified by the DestinationBridgeInfo object.

Parameters:
destBridge - the destination bridge to be created
Returns:
the newly created destination bridge
Throws:
TibjmsAdminException - if not authorized or some other error occurred
java.lang.IllegalArgumentException - if the DestinationBridgeInfo object is null
TibjmsAdminInvalidNameException - if the DestinationBridgeInfo object is not valid
TibjmsAdminNameExistsException - if a destination bridge already exists between the specified source and target.
Since:
Version 4.2

destroyDestinationBridge

public void destroyDestinationBridge(int sourceType,
                                     java.lang.String sourceName,
                                     int targetType,
                                     java.lang.String targetName)
                              throws TibjmsAdminException,
                                     TibjmsAdminInvalidNameException
Destroy the destination bridge between a source and a target

Parameters:
sourceType - the type of the source destination, either DestinationInfo.QUEUE_TYPE or DestinationInfo.TOPIC_TYPE
sourceName - the name of the source destination
targetType - the type of the target destination, either DestinationInfo.QUEUE_TYPE or DestinationInfo.TOPIC_TYPE
targetName - the name of the target destination
Throws:
TibjmsAdminException - if not authorized or some other error occurred
TibjmsAdminInvalidNameException - if the source our target names or types are not valid
Since:
Version 4.2

getDestinationBridge

public DestinationBridgeInfo getDestinationBridge(int sourceType,
                                                  java.lang.String sourceName,
                                                  int targetType,
                                                  java.lang.String targetName)
                                           throws TibjmsAdminException,
                                                  TibjmsAdminInvalidNameException
Returns the destination bridge between a source and a target

Parameters:
sourceType - the type of the source destination, either DestinationInfo.QUEUE_TYPE or DestinationInfo.TOPIC_TYPE
sourceName - the name of the source destination
targetType - the type of the target destination, either DestinationInfo.QUEUE_TYPE or DestinationInfo.TOPIC_TYPE
targetName - the name of the target destination
Throws:
TibjmsAdminException - if not authorized or some other error occurred
TibjmsAdminInvalidNameException - if the source our target names or types are not valid
Since:
Version 4.2

getDestinationBridges

public DestinationBridgeInfo[] getDestinationBridges(int sourceType,
                                                     java.lang.String sourcePattern)
                                              throws TibjmsAdminException,
                                                     TibjmsAdminInvalidNameException
Get the destination bridges for all source destinations that match the given source type and source pattern. The source type can be either DestinationInfo.QUEUE_TYPE, DestinationInfo.TOPIC_TYPE or DestinationInfo.ALL_TYPE. The source pattern may contain the wildcards "*" and ">" . See the Tibjms documentation for how wildcards work in destination names. A pattern of "", ">", or null will return the destination bridges from all the queues if sourceType is DestinationInfo.QUEUE_TYPE or from all the topics if sourceType is DestinationInfo.TOPIC_TYPE.

Parameters:
sourceType - the type of the source, either DestinationInfo.QUEUE_TYPE, DestinationInfo.TOPIC_TYPE or DestinationInfo.ALL_TYPE
sourcePattern - a pattern or destination name
Returns:
an array of DestinationBridgeInfo objects that match the source pattern and type
Throws:
TibjmsAdminException - if not authorized or an error occurred
TibjmsAdminInvalidNameException - if sourcePattern or sourceType are not valid
Since:
Version 4.2

getConnectionId

public long getConnectionId()
Get the connection id of the TibjmsAdmin object's connection to the server.

Returns:
the connection id of the TibjmsAdmin's connection to the server, or zero if the connection is closed or broken.

compact

public boolean compact(int store,
                       long timeout)
                throws TibjmsAdminException,
                       java.lang.IllegalArgumentException
Compact one of the server's store files until either no more compaction can be done or timeout seconds have elapsed, whichever occurs first.

Parameters:
store - the store file to compact, either STORE_SYNC or STORE_ASYNC
timeout - time in seconds allowed for compaction or 0 for no timeout.
Returns:
true if the store file was fully compacted before the timeout expired, false otherwise.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if store is invalid

getStoreInfo

public StoreInfo getStoreInfo(int store)
                       throws TibjmsAdminException,
                              java.lang.IllegalArgumentException
Get a summary of the usage of a store file.

Parameters:
store - the store file to summarize, either STORE_SYNC or STORE_ASYNC
Returns:
a StoreInfo object detailing the usage of the store file.
Throws:
TibjmsAdminException - if not authorized or an error occurred.
java.lang.IllegalArgumentException - if store is invalid

TIBCO Enterprise Message Service
Version 4.3.0

Copyright © TIBCO Software Inc. All rights reserved