|
TIBCO Enterprise Message Service | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tibco.tibjms.admin.TibjmsAdmin
public class TibjmsAdmin
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);It is important to note that public constructors (such as those for TopicInfo and GroupInfo), will initialize internal variables. When updating the server be sure to populate objects entirely or retrieve them from the server first as in the example above to avoid any unintentional updates.
Field Summary | |
---|---|
static int |
DEST_CURSOR_FIRST
First cursorPosition for requested destinations. |
static int |
DEST_CURSOR_LAST
Last cursorPosition for requested destinations. |
static int |
DEST_CURSOR_NEXT
Next cursorPosition for requested destinations. |
static int |
GET_DETAILED_STAT
Flag requesting both overall and detailed statistics to be returned by methods such as getConsumers(Long,String,DestinationInfo,boolean,int) . |
static int |
GET_SELECTOR
Flag requesting consumer's selector to be included into ConsumerInfo objects returned by getConsumers()
method. |
static int |
GET_STAT
Flag requesting overall statistics to be returned by methods such as getConsumers(Long,String,DestinationInfo,boolean,int) . |
static int |
PERMISSIONS_ALL
This is mainly used in conjunction with TibjmsAdmin#getPermissions(UserInfo, flags). |
static int |
PERMISSIONS_ALL_ADMIN
This is mainly used in conjunction with TibjmsAdmin#getPermissions(UserInfo, flags). |
static int |
PERMISSIONS_ALL_DEST
This is mainly used in conjunction with TibjmsAdmin#getPermissions(UserInfo, flags). |
static int |
PERMISSIONS_DIRECT
This is mainly used in conjunction with TibjmsAdmin#getPermissions(UserInfo, flags). |
static int |
PERMISSIONS_DIRECT_ADMIN
This is mainly used in conjunction with TibjmsAdmin#getPermissions(UserInfo, flags). |
static int |
PERMISSIONS_DIRECT_DEST
This is mainly used in conjunction with TibjmsAdmin#getPermissions(UserInfo, flags). |
static int |
SESSION_AUTO_ACKNOWLEDGE
AUTO acknowledgement mode. |
static int |
SESSION_CLIENT_ACKNOWLEDGE
CLIENT acknowledgement mode. |
static int |
SESSION_DUPS_OK_ACKNOWLEDGE
DUPS_OK acknowledgement mode. |
static int |
SESSION_NO_ACKNOWLEDGE
No acknowledgement mode. |
static int |
SESSION_TRANSACTED
Acknowledgement mode describing transacted session. |
static int |
SESSION_UNKNOWN_ACKNOWLEDGE
Unknown session acknowledge mode. |
static int |
SESSION_XA
Acknowledgement mode describing XA session. |
static int |
STORE_ASYNC
The server's default non-failsafe store. |
static int |
STORE_SYNC
The server's default failsafe store. |
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 |
clearJACICache()
Clear all entries out of the JACI results cache. |
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. |
boolean |
compact(java.lang.String name,
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. |
Configuration |
createConfiguration()
Creates an empty configuration object that can be used to load configuration updates. |
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 |
destroyQueues(java.lang.String pattern)
Destroy queues matching the given pattern. |
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 |
destroyTopics(java.lang.String pattern)
Destroy topics matching the given pattern. |
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. |
ChannelInfo |
getChannel(java.lang.String name)
Returns the multicast channel with specified name. |
ChannelInfo[] |
getChannels()
Returns all multicast channels in the server. |
ChannelInfo |
getChannelStatistics(java.lang.String name)
Returns statistical information about the multicast channel with specified name. |
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. |
Configuration |
getConfiguration()
Returns the current server configuration in its entirety. |
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. |
ConnectionInfo[] |
getConnections(java.lang.String username,
java.lang.String hostname)
Returns all client connections matching specified filters. |
ConsumerInfo |
getConsumer(long consumerID)
Returns consumer with specified ID. |
ConsumerInfo[] |
getConsumers()
Returns all consumers in the server. |
ConsumerInfo[] |
getConsumers(java.lang.Long connectionID,
java.lang.String username,
DestinationInfo destination,
boolean durable,
int dataFlags)
Returns consumers matching specified filters. |
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)
Deprecated. this method remains fully functional but in EMS 4.4 the preferred way to obtain consumer information is via method getConsumers(Long,String,DestinationInfo,boolean,int) |
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. |
JACIInfo |
getJACIInfo()
Get statistics on the JACI permissions cache. |
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. |
java.lang.Object[] |
getPermissions(UserInfo target,
int flags)
Get user permissions based on the flags set. |
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[] |
getQueues(java.lang.String pattern,
int permType)
Get the info for the queues that match the given pattern and the given permanence type. |
QueueInfo[] |
getQueues(java.lang.String pattern,
int permType,
int cursorPosition,
int cursorSize)
Get the info for the queues that match the given pattern and the given permanence type. |
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. |
QueueInfo[] |
getQueuesStatistics(java.lang.String pattern,
int cursorPosition,
int cursorSize)
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 type)
Deprecated. As of EMS 6.1.0, replaced by getStoreInfo(String) |
StoreInfo |
getStoreInfo(java.lang.String name)
Get information about a store. |
java.lang.String[] |
getStores()
Get a list of configured stores. |
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[] |
getTopics(java.lang.String pattern,
int permType)
Get the info for the topics that match the given pattern and the given permanence type. |
TopicInfo[] |
getTopics(java.lang.String pattern,
int permType,
int cursorPosition,
int cursorSize)
Get the info for the topics that match the given pattern and the given permanence type. |
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. |
TopicInfo[] |
getTopicsStatistics(java.lang.String pattern,
int cursorPosition,
int cursorSize)
Get the statistical information for the topics that match the given pattern. |
java.lang.String[] |
getTraceBuffer(boolean clear)
Reserved for internal provider use only - Do not use this method. |
DetailedTransactionInfo |
getTransaction(TransactionInfo transaction)
Get a specific xa transaction. |
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. |
boolean |
isRestartRequired()
Query a server to determine whether a restart is required to complete state changes. |
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 |
purgeQueues(java.lang.String pattern)
Purge pending messages from the queues matching the given pattern. |
void |
purgeTopic(java.lang.String topicName)
Purge pending messages from the topic for the given name. |
void |
purgeTopics(java.lang.String pattern)
Purge pending messages from topics matching the given pattern. |
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 |
resetJACIStats()
Reset all JACI statistics counters to zero. |
void |
restart()
Restart the server. |
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 |
synchronizeConfiguration(Configuration configuration)
Synchronize the current server with a provided Configuration such that upon success, the server configuration will be identical to the configuration provided. |
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 |
---|
public static final int STORE_SYNC
public static final int STORE_ASYNC
public static final int PERMISSIONS_DIRECT_DEST
public static final int PERMISSIONS_DIRECT_ADMIN
public static final int PERMISSIONS_ALL_ADMIN
public static final int PERMISSIONS_ALL_DEST
public static final int PERMISSIONS_DIRECT
public static final int PERMISSIONS_ALL
public static final int SESSION_UNKNOWN_ACKNOWLEDGE
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int SESSION_NO_ACKNOWLEDGE
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int SESSION_AUTO_ACKNOWLEDGE
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int SESSION_DUPS_OK_ACKNOWLEDGE
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int SESSION_CLIENT_ACKNOWLEDGE
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int SESSION_TRANSACTED
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int SESSION_XA
ConsumerInfo.Details.getSessionAcknowledgeMode()
,
Constant Field Valuespublic static final int GET_STAT
getConsumers(Long,String,DestinationInfo,boolean,int)
.
getConsumers(Long,String,DestinationInfo,boolean,int)
,
Constant Field Valuespublic static final int GET_DETAILED_STAT
getConsumers(Long,String,DestinationInfo,boolean,int)
.
getConsumers(Long,String,DestinationInfo,boolean,int)
,
Constant Field Valuespublic static final int GET_SELECTOR
ConsumerInfo
objects returned by getConsumers()
method.
getConsumers(Long,String,DestinationInfo,boolean,int)
,
Constant Field Valuespublic static final int DEST_CURSOR_FIRST
getQueues(String,int,int,int)
,
getTopics(String,int,int,int)
,
getQueuesStatistics(String,int,int)
,
Constant Field Valuespublic static final int DEST_CURSOR_NEXT
#getQueues(String,int,int,boolean,int,int)
,
#getTopics(String,int,int,boolean,int,int)
,
getQueuesStatistics(String,int,int)
,
Constant Field Valuespublic static final int DEST_CURSOR_LAST
#getQueues(String,int,int,boolean,int,int)
,
#getTopics(String,int,int,boolean,int,int)
,
getQueuesStatistics(String,int,int)
,
Constant Field ValuesConstructor Detail |
---|
public TibjmsAdmin(java.lang.String url, java.lang.String userName, java.lang.String password) throws TibjmsAdminException
url
- The URL of the server to administer.userName
- Name of the administrator user.password
- User password.
TibjmsAdminException
- if not authorized or an error occurred.public TibjmsAdmin(java.lang.String url, java.lang.String userName, java.lang.String password, java.util.Map sslParams) throws TibjmsAdminException
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.
TibjmsAdminException
- if not authorized or an error occurred.Method Detail |
---|
public void close() throws TibjmsAdminException
TibjmsAdminException
- if an error occurred.public long getCommandTimeout()
public void setCommandTimeout(long value) throws java.lang.IllegalArgumentException
value
- new timeout in milliseconds.
java.lang.IllegalArgumentException
- if value is less than 5000ms.public void saveConfiguration() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void setAutoSave(boolean enabled)
enabled
- true if chages should be saved after every change in the configuration.public boolean isAutoSave()
public ServerInfo getInfo() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void updateServer(ServerInfo info) throws TibjmsAdminException, java.lang.IllegalArgumentException
info
- a ServerInfo object containing the changed configuration parameters.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if ServerInfo object is null.public void restart() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void shutdown() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void rotateLog() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void updateCRL() throws TibjmsAdminException
TibjmsAdminException
- if an error occurred.public void createCMListener(CMListenerInfo cmListener) throws TibjmsAdminException, java.lang.IllegalArgumentException
cmListener
- the certified listener to be created (pre-registered).
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if CMListenerInfo object is null.public void deleteCMListener(CMListenerInfo cmListener) throws TibjmsAdminException, java.lang.IllegalArgumentException
cmListener
- the certified listener to be deleted.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if cmListener is null.public CMListenerInfo[] getCMListeners() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public CMLedgerSubjectInfo[] getCMLedger(java.lang.String pattern) throws TibjmsAdminException
pattern
- a pattern indicating which subjects are of interest.
TibjmsAdminException
- if not authorized or an error occurred.public CMLedgerSubjectInfo[] getCMLedger(java.lang.String transport, java.lang.String pattern) throws TibjmsAdminException
transport
- the name of the transport whose ledger file is to be
summarized.pattern
- a pattern indicating which subjects are of interest.
TibjmsAdminException
- if not authorized or an error occurred.public RouteInfo getRoute(java.lang.String name) throws TibjmsAdminException, TibjmsAdminInvalidNameException
name
- name of the route.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if name is not a legal route name.public RouteInfo[] getRoutes() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public RouteInfo createRoute(RouteInfo routeInfo) throws TibjmsAdminException, java.lang.IllegalArgumentException
routeInfo
- The parameters for the new route.
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.public void updateRoute(RouteInfo routeInfo) throws TibjmsAdminException, java.lang.IllegalArgumentException
createRoute(com.tibco.tibjms.admin.RouteInfo)
method.
routeInfo
- The route info to save.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
public void destroyRoute(java.lang.String name) throws TibjmsAdminException, TibjmsAdminInvalidNameException
name
- The name of the route to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if name is not a legal route name.public ConnectionInfo[] getConnections() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public ConnectionInfo[] getConnections(java.lang.String username, java.lang.String hostname) throws TibjmsAdminException
null
value.
username
- if specified, only connections with specific user name will
be returned.
Specify null
if connections for all users should be returned.hostname
- if specified, only connections created from this specific
host name or IP address will be returned.
Specify null
if connections from all hosts should be returned.
TibjmsAdminException
- if not authorized or an error occurred.public ConnectionInfo[] getSystemConnections() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void destroyConnection(long connectionID) throws TibjmsAdminException
connectionID
- The connection ID of the connection to be destroyed.
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo createQueue(QueueInfo queue) throws TibjmsAdminException
queue
- The description of the queue to be created.
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.public void updateQueue(QueueInfo queue) throws TibjmsAdminException, java.lang.IllegalArgumentException
createQueue(com.tibco.tibjms.admin.QueueInfo)
method.
queue
- The QueueInfo for the queue to be modified.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if QueueInfo object is null.public void destroyQueue(java.lang.String queueName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
queueName
- The name of the queue to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if queueName is not a legal queue name.public void destroyQueues(java.lang.String pattern) throws TibjmsAdminException, TibjmsAdminInvalidNameException
pattern
- a pattern indicating which queues to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if pattern is not a legal pattern.public QueueInfo getQueue(java.lang.String queueName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
queueName
- The name of the queue to get.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if queueName is not a legal namepublic QueueInfo[] getQueues(java.lang.String pattern, int permType, int cursorPosition, int cursorSize) throws TibjmsAdminException
pattern
- The pattern that must be matchedpermType
- The permanence type, either DestinationInfo.DEST_GET_ALL
,
DestinationInfo.DEST_GET_STATIC
, DestinationInfo.DEST_GET_DYNAMIC
or
DestinationInfo.DEST_GET_NOTEMP
cursorPosition
- The cursor operations, either DEST_CURSOR_FIRST
,
DEST_CURSOR_NEXT
or DEST_CURSOR_LAST
cursorSize
- The count of queues to return for a given cursor operation. Note that the operation may return less than the requested size.
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo[] getQueues(java.lang.String pattern, int permType) throws TibjmsAdminException
pattern
- The pattern that must be matchedpermType
- The permanence type, either DestinationInfo.DEST_GET_ALL
,
DestinationInfo.DEST_GET_STATIC
, DestinationInfo.DEST_GET_DYNAMIC
or
DestinationInfo.DEST_GET_NOTEMP
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo[] getQueues(java.lang.String pattern) throws TibjmsAdminException
pattern
- The pattern that must be matched
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo[] getQueues() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void purgeQueue(java.lang.String queueName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
queueName
- The name of the queue to purge.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if queueName is not a legal queue name.public void purgeQueues(java.lang.String pattern) throws TibjmsAdminException, TibjmsAdminInvalidNameException
pattern
- a pattern indicating which queues to purge.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if pattern is not a legal pattern.public TopicInfo createTopic(TopicInfo topic) throws TibjmsAdminException
topic
- The description of the topic to be created.
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.public void updateTopic(TopicInfo topic) throws TibjmsAdminException, java.lang.IllegalArgumentException
createTopic(com.tibco.tibjms.admin.TopicInfo)
method.
topic
- The TopicInfo for the queue to be modified.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if TopicInfo object is null.public void destroyTopic(java.lang.String topicName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
topicName
- The name of the topic to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if topicName is not a legal topic name.public void destroyTopics(java.lang.String pattern) throws TibjmsAdminException, TibjmsAdminInvalidNameException
pattern
- a pattern indicating which topics to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if pattern is not a legal pattern.public TopicInfo getTopic(java.lang.String topicName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
topicName
- The name of the topic to get.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if topicName is not a legal topic namepublic TopicInfo[] getTopics(java.lang.String pattern, int permType, int cursorPosition, int cursorSize) throws TibjmsAdminException
pattern
- The pattern that must be matchedpermType
- The permanence type, either DestinationInfo.DEST_GET_ALL
,
DestinationInfo.DEST_GET_STATIC
, DestinationInfo.DEST_GET_DYNAMIC
or
DestinationInfo.DEST_GET_NOTEMP
cursorPosition
- The cursor operations, either DEST_CURSOR_FIRST
,
DEST_CURSOR_NEXT
or DEST_CURSOR_LAST
cursorSize
- The count of topics to return for a given cursor operation. Note that the operation may return less than the requested size.
TibjmsAdminException
- if not authorized or an error occurred.public TopicInfo[] getTopics(java.lang.String pattern, int permType) throws TibjmsAdminException
pattern
- The pattern that must be matchedpermType
- The permanence type, either DestinationInfo.DEST_GET_ALL
,
DestinationInfo.DEST_GET_STATIC
, DestinationInfo.DEST_GET_DYNAMIC
or
DestinationInfo.DEST_GET_NOTEMP
TibjmsAdminException
- if not authorized or an error occurred.public TopicInfo[] getTopics(java.lang.String pattern) throws TibjmsAdminException
pattern
- The pattern that must be matched
TibjmsAdminException
- if not authorized or an error occurred.public TopicInfo[] getTopics() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void purgeTopic(java.lang.String topicName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
topicName
- The name of the topic to purge.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if topicName is not a legal topic name.public void purgeTopics(java.lang.String pattern) throws TibjmsAdminException, TibjmsAdminInvalidNameException
pattern
- a pattern indicating which topics to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if pattern is not a legal pattern.public UserInfo createUser(UserInfo user) throws TibjmsAdminException, TibjmsAdminInvalidNameException, TibjmsAdminNameExistsException
user
- The information for the user to be created.
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.public void destroyUser(java.lang.String userName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
userName
- The name of the user to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if userName is not a legal user name.public void updateUser(UserInfo userInfo) throws TibjmsAdminException, java.lang.IllegalArgumentException
createUser(com.tibco.tibjms.admin.UserInfo)
method.
userInfo
- The user information to save.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if UserInfo object is null.public UserInfo getUser(java.lang.String userName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
userName
- The name of the user to retrieve info for.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if userName is not a legal user name.public UserInfo[] getUsers() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public GroupInfo createGroup(GroupInfo group) throws TibjmsAdminException, TibjmsAdminInvalidNameException, TibjmsAdminNameExistsException
group
- The info for the group to be created.
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.public void destroyGroup(java.lang.String groupName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
groupName
- The name of the group to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if groupName is not a legal name.public void updateGroup(GroupInfo groupInfo) throws TibjmsAdminException, java.lang.IllegalArgumentException
createGroup(com.tibco.tibjms.admin.GroupInfo)
method.
groupInfo
- The group to save configuration changes for.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if GroupInfo object is null.public GroupInfo getGroup(java.lang.String groupName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
groupName
- The name of the group to retrieve.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if groupName is not a legal group name.public GroupInfo[] getGroups() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void addUserToGroup(java.lang.String groupName, java.lang.String userName) throws TibjmsAdminException
groupName
- The group that the user will be added to.userName
- The user to be added.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if the names of the group or the user are not legal.public void addUsersToGroup(java.lang.String groupName, java.lang.String[] userNames) throws TibjmsAdminException, TibjmsAdminInvalidNameException, java.lang.IllegalArgumentException
groupName
- The group that the users will be added to.userNames
- The users to be added.
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.public void removeUserFromGroup(java.lang.String groupName, java.lang.String userName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
groupName
- The group that the user will be removed from.userName
- The user to be removed.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if groupName or userName are not legal names.public void removeUsersFromGroup(java.lang.String groupName, java.lang.String[] userNames) throws TibjmsAdminException, TibjmsAdminInvalidNameException, java.lang.IllegalArgumentException
groupName
- The group that the users will be removed from.userNames
- The users to be removed.
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;public java.lang.Object[] getPermissions() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public java.lang.Object[] getPermissions(java.lang.Object target) throws TibjmsAdminException
target
- the object
TibjmsAdminException
- if not authorized or an error occurred.public java.lang.Object[] getPermissions(UserInfo target, int flags) throws TibjmsAdminException
NOTE: Inherited permissions cannot be modified (i.e removed)
target
- the userinfo objectflags
- the flags, based on which the different permissions are returned
TibjmsAdminException
- if not authorized or an error occurred.public ACLEntry[] getACLEntries() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or some error occurred.public ACLEntry[] getQueueACLEntries(java.lang.String queueName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
queueName
- Queue name.
TibjmsAdminException
- if not authorized or some error occurred.
TibjmsAdminInvalidNameException
- if queueName is not a legal queue name.public ACLEntry[] getTopicACLEntries(java.lang.String topicName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
topicName
- Topic name.
TibjmsAdminException
- if not authorized or some error occurred.
TibjmsAdminInvalidNameException
- if topicName is not a legal topic name.public ACLEntry[] getUserACLEntries(java.lang.String userName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
userName
- User name.
TibjmsAdminException
- if not authorized or some error occurred.
TibjmsAdminInvalidNameException
- if userName is not a legal user name.public ACLEntry[] getGroupACLEntries(java.lang.String groupName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
groupName
- the name of the group.
TibjmsAdminException
- if not authorized or some error occurred.
TibjmsAdminInvalidNameException
- if groupName is not a legal group name.public void grant(ACLEntry entry) throws TibjmsAdminException, java.lang.IllegalArgumentException
entry
- The description of the permissions to grant.
TibjmsAdminException
- if not authorized or some error occurred.
java.lang.IllegalArgumentException
- if entry is null.public void grant(ACLEntry[] acls) throws TibjmsAdminException, java.lang.IllegalArgumentException
acls
- The descriptions of the permissions to grant.
TibjmsAdminException
- if not authorized or some error occurred.
java.lang.IllegalArgumentException
- if acls is null.public void grant(AdminACLEntry entry) throws TibjmsAdminException, java.lang.IllegalArgumentException
entry
- the AdminACLEntry to grant.
TibjmsAdminException
- if not authorized or some error occurred.
java.lang.IllegalArgumentException
- if entry is null.public void revoke(ACLEntry entry) throws TibjmsAdminException, java.lang.IllegalArgumentException
entry
- the ACLEntry to revoke.
TibjmsAdminException
- if not authorized or some error occurred.
java.lang.IllegalArgumentException
- if ACLEntry is null.public void revoke(ACLEntry[] acls) throws TibjmsAdminException, java.lang.IllegalArgumentException
acls
- an array of ACLEntry objects containing the positive permissions to be revoked.
TibjmsAdminException
- if not authorized or some error occurred.
java.lang.IllegalArgumentException
- if ACLEntry array is null.public void revoke(AdminACLEntry entry) throws TibjmsAdminException, java.lang.IllegalArgumentException
entry
- the AdminACLEntry containing the positive permissions to be revoked.
TibjmsAdminException
- if not authorized or some error occurred.
java.lang.IllegalArgumentException
- if AdminACLEntry is null.public DurableInfo getDurable(java.lang.String durableName, java.lang.String clientID) throws TibjmsAdminException, TibjmsAdminInvalidNameException
durableName
- name of the durable subsription.clientID
- client ID associated with the durable (can be null).
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if durableName is not a legal name.public DurableInfo[] getDurables(java.lang.String topicName) throws TibjmsAdminException
getConsumers(Long,String,DestinationInfo,boolean,int)
topicName
- name of topic to get durable information on.
TibjmsAdminException
- if not authorized or an error occurred.getConsumers(Long,String,DestinationInfo,boolean,int)
public DurableInfo[] getDurables() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void purgeDurable(java.lang.String durableName, java.lang.String clientID) throws TibjmsAdminException, TibjmsAdminInvalidNameException
durableName
- The name of the durable to purge.clientID
- The client ID associated with the durable (can be null).
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if durableName is not a legal durable name.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
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.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if durableName is not a legal name.public void destroyDurable(java.lang.String durableName, java.lang.String clientID) throws TibjmsAdminException, TibjmsAdminInvalidNameException
durableName
- The name of the durable to destroy.clientID
- The client ID associated with the durable (can be null).
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if durableName is not a legal name.public Message getMessage(java.lang.String messageID) throws TibjmsAdminException, java.lang.IllegalArgumentException
messageID
- The ID of the message to retrieve.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if messageID is not a legal ID.public void destroyMessage(java.lang.String messageID) throws TibjmsAdminException
messageID
- The ID of the message to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if messageID is not a legal ID.public Message[] getMessages(java.lang.String correlationID) throws TibjmsAdminException, java.lang.IllegalArgumentException
correlationID
- The correlation ID of the messages to retrieve.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if correlationID is not a legal ID.public ConnectionFactoryInfo[] getConnectionFactories() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void createConnectionFactory(java.lang.String jndiName, ConnectionFactoryInfo cfi) throws TibjmsAdminException, TibjmsAdminInvalidNameException, java.lang.IllegalArgumentException, TibjmsAdminNameExistsException
jndiName
- The JNDI name to which the new factory will be bound.cfi
- The info for the factory to create.
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.public void updateConnectionFactory(java.lang.String jndiName, ConnectionFactoryInfo cfi) throws TibjmsAdminException, TibjmsAdminInvalidNameException, java.lang.IllegalArgumentException
createConnectionFactory(java.lang.String, com.tibco.tibjms.admin.ConnectionFactoryInfo)
method.
jndiName
- The JNDI name of the factory that will be updated.cfi
- The updated info for the factory.
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.public void destroyConnectionFactory(java.lang.String jndiName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
jndiName
- A JNDI name for the factory to destroy.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if jndiName is not a legal name.public void bindQueue(java.lang.String name, java.lang.String queueName) throws TibjmsAdminException, TibjmsAdminNameExistsException, TibjmsAdminInvalidNameException
name
- The JNDI name to which the queue will be bound.queueName
- The name of the queue to bind.
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.public void bindTopic(java.lang.String name, java.lang.String topicName) throws TibjmsAdminException, TibjmsAdminNameExistsException, TibjmsAdminInvalidNameException
name
- The JNDI name to which the topic will be bound.topicName
- The name of the topic to bind.
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.public void bind(java.lang.String newName, java.lang.String existingName) throws TibjmsAdminException, TibjmsAdminNameExistsException, TibjmsAdminInvalidNameException
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.
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.public void unbind(java.lang.String name) throws TibjmsAdminException, TibjmsAdminInvalidNameException
name
- The JNDI name to unbind.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if name is not a legal JNDI name.public java.lang.Object lookup(java.lang.String name) throws TibjmsAdminException, TibjmsAdminInvalidNameException
name
- The JNDI name to lookup.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if name is not a legal name.public ConsumerInfo[] getConsumersStatistics() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public ConsumerInfo[] getConsumersStatistics(java.lang.Long connectionID, java.lang.String username, DestinationInfo destination) throws TibjmsAdminException
connectionID
- consumer connection ID or null.username
- consumer user name or null.destination
- consumer destination pattern or null.
TibjmsAdminException
- if not authorized or an error occurred.public ProducerInfo[] getProducersStatistics() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public ProducerInfo[] getProducersStatistics(java.lang.Long connectionID, java.lang.String username, DestinationInfo destination) throws TibjmsAdminException
connectionID
- producer connection ID or null.username
- producer user name or null.destination
- producer destination pattern or null.
TibjmsAdminException
- if not authorized or an error occurred.public TopicInfo[] getTopicsStatistics() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public TopicInfo[] getTopicsStatistics(java.lang.String pattern) throws TibjmsAdminException
pattern
- The pattern that must be matched
TibjmsAdminException
- if not authorized or an error occurred.public TopicInfo[] getTopicsStatistics(java.lang.String pattern, int cursorPosition, int cursorSize) throws TibjmsAdminException
pattern
- The pattern that must be matchedcursorPosition
- The cursor operations, either DEST_CURSOR_FIRST
,
DEST_CURSOR_NEXT
or DEST_CURSOR_LAST
cursorSize
- The count of topics to return for a given cursor operation. Note that the operation may return less than the requested size.
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo[] getQueuesStatistics() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo[] getQueuesStatistics(java.lang.String pattern) throws TibjmsAdminException
pattern
- The pattern that must be matched
TibjmsAdminException
- if not authorized or an error occurred.public QueueInfo[] getQueuesStatistics(java.lang.String pattern, int cursorPosition, int cursorSize) throws TibjmsAdminException
pattern
- The pattern that must be matchedcursorPosition
- The cursor operations, either DEST_CURSOR_FIRST
,
DEST_CURSOR_NEXT
or DEST_CURSOR_LAST
cursorSize
- The count of queues to return for a given cursor operation. Note that the operation may return less than the requested size.
TibjmsAdminException
- if not authorized or an error occurred.public RouteInfo getRouteStatistics(java.lang.String name) throws TibjmsAdminException, TibjmsAdminInvalidNameException
name
- name of the route.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if name is not a legal route name.public TransactionInfo[] getTransactions() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public DetailedTransactionInfo getTransaction(TransactionInfo transaction) throws TibjmsAdminException
transaction
- The TransactionInfo object for the transaction
to be inspected.
TibjmsAdminException
- if not authorized or an error occurred.public void commitTransaction(TransactionInfo transaction) throws TibjmsAdminException, java.lang.IllegalArgumentException
transaction
- The TransactionInfo object for the transaction
to be committed.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if transaction is null.public void rollbackTransaction(TransactionInfo transaction) throws TibjmsAdminException, java.lang.IllegalArgumentException
transaction
- The TransactionInfo object for the transaction
to be rolled back.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if TransactionInfo object is null.public TransportInfo[] getTransports() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public TransportInfo getTransport(java.lang.String transportName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
transportName
- the name of the transport.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if transportName is not a legal
transport namepublic void setExceptionListener(ExceptionListener listener) throws TibjmsAdminException
listener
- the exception listener.
TibjmsAdminException
- if not authorized or an error occurred.public BridgeInfo[] getBridges() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public BridgeInfo[] getBridges(int type, java.lang.String pattern) throws TibjmsAdminException, java.lang.IllegalArgumentException
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.
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if type is invalidpublic BridgeInfo getBridge(int type, java.lang.String name) throws TibjmsAdminException, java.lang.IllegalArgumentException
type
- the type of source destination, either
DestinationInfo.QUEUE_TYPE or DestinationInfo.TOPIC_TYPE.name
- the name of the source destination
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- type is invalid or name is nullpublic JACIInfo getJACIInfo() throws TibjmsAdminException
TibjmsAdminException
public void resetJACIStats() throws TibjmsAdminException
TibjmsAdminException
public void clearJACICache() throws TibjmsAdminException
TibjmsAdminException
public DestinationBridgeInfo createDestinationBridge(DestinationBridgeInfo destBridge) throws TibjmsAdminException, java.lang.IllegalArgumentException, TibjmsAdminInvalidNameException, TibjmsAdminNameExistsException
destBridge
- the destination bridge to be created
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.public void destroyDestinationBridge(int sourceType, java.lang.String sourceName, int targetType, java.lang.String targetName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
sourceType
- the type of the source destination, either DestinationInfo.QUEUE_TYPE
or DestinationInfo.TOPIC_TYPE
sourceName
- the name of the source destinationtargetType
- the type of the target destination, either DestinationInfo.QUEUE_TYPE
or DestinationInfo.TOPIC_TYPE
targetName
- the name of the target destination
TibjmsAdminException
- if not authorized or some other error occurred
TibjmsAdminInvalidNameException
- if the source our target names or types are not validpublic DestinationBridgeInfo getDestinationBridge(int sourceType, java.lang.String sourceName, int targetType, java.lang.String targetName) throws TibjmsAdminException, TibjmsAdminInvalidNameException
sourceType
- the type of the source destination, either DestinationInfo.QUEUE_TYPE
or DestinationInfo.TOPIC_TYPE
sourceName
- the name of the source destinationtargetType
- the type of the target destination, either DestinationInfo.QUEUE_TYPE
or DestinationInfo.TOPIC_TYPE
targetName
- the name of the target destination
TibjmsAdminException
- if not authorized or some other error occurred
TibjmsAdminInvalidNameException
- if the source our target names or types are not validpublic DestinationBridgeInfo[] getDestinationBridges(int sourceType, java.lang.String sourcePattern) throws TibjmsAdminException, TibjmsAdminInvalidNameException
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
.
sourceType
- the type of the source, either DestinationInfo.QUEUE_TYPE
,
DestinationInfo.TOPIC_TYPE
or DestinationInfo.ALL_TYPE
sourcePattern
- a pattern or destination name
TibjmsAdminException
- if not authorized or an error occurred
TibjmsAdminInvalidNameException
- if sourcePattern or sourceType are not validpublic long getConnectionId()
public boolean compact(int store, long timeout) throws TibjmsAdminException, java.lang.IllegalArgumentException
store
- the store file to compact, either STORE_SYNC
or
STORE_ASYNC
timeout
- time in seconds allowed for compaction (must be greater than zero).
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if store is invalid or timeout is not
greater than zero.public boolean compact(java.lang.String name, long timeout) throws TibjmsAdminException, java.lang.IllegalArgumentException
name
- the store file 'name' to compact.timeout
- time in seconds allowed for compaction (must be greater than zero).
TibjmsAdminException
- if not authorized or an error occurred.
java.lang.IllegalArgumentException
- if store is invalid or timeout is not
greater than zero.public StoreInfo getStoreInfo(int type) throws TibjmsAdminException, java.lang.IllegalArgumentException
getStoreInfo(String)
store
- the store file to summarize, either STORE_SYNC
or
STORE_ASYNC
FileStoreInfo
or DbStoreInfo
object detailing configuration and usage of the store.
java.lang.IllegalArgumentException
- if store is invalid
TibjmsAdminException
- if not authorized or an error occurred.public StoreInfo getStoreInfo(java.lang.String name) throws TibjmsAdminException
name
- retrieve information about the store with this name
FileStoreInfo
or DbStoreInfo
or
MStoreInfo
object detailing configuration and usage of
the store.
TibjmsAdminException
- if not authorized or an error occurred.public java.lang.String[] getStores() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public ConsumerInfo[] getConsumers() throws TibjmsAdminException
getConsumers(null,null,null,false,0)
. Refer to the
documentation of getConsumers(Long,String,DestinationInfo,boolean,int)
for detailed information.
TibjmsAdminException
- if not authorized or an error occurred.public ConsumerInfo[] getConsumers(java.lang.Long connectionID, java.lang.String username, DestinationInfo destination, boolean durable, int dataFlags) throws TibjmsAdminException
consumerID
, username
and destination
.
Parameter durable
is applied only to topic subscribers.
All filters may be omitted by specifying null
value.
Parameter durable has special meaning in that it prevents
this method from returning non-durable topic consumers. It however does
not affect which queue consumers are returned.
Returned consumers are not sorted and placed in the array in any order.
Application may need to sort the consumers in application-specific order
if required.
For example, calling
getConsumers(null,null,null,false,0);returns all consumers known to server but does not include statistical information nor selector (if present) for each consumer. Calling
getConsumers(null,null,null,true,0);returns all queue consumers and durable topic consumers. Calling
TopicInfo topic = new TopicInfo("news.*"); getConsumers(null,null,topic,true,TibjmsAdmin.GET_DETAILED_STAT);returns all durable topic consumers which subscribe to any topic matching topic "news.*". Returned
ConsumerInfo
objects will include detailed
statistics about consumers if statistics are enabled in the server but will
not include consumer's selector.
CallingQueueInfo queue = new QueueInfo("purchase.order.>"); getConsumers(null,"OrderProcessor",queue,false, TibjmsAdmin.GET_DETAILED_STAT+TibjmsAdmin.GET_SELECTOR);returns all queue consumers created by user "OrderProcessor" and receiving messages from all queues matching name "purchase.order.>". Each consumer object will include full statistics available for consumer and consumer's selector if present.
connectionID
- if specified, only consumers for specified connection
will be returned.
Specify null
if all consumers should be returned.username
- if specified, only consumers for connections with specified
user name will be returned.
Specify null
if all consumers should be returned.destination
- may be set to null
or specify
TopicInfo
or QueueInfo
object. If specified, only
consumers subscribing to destinations of same type and matching this
destination name will be returned.durable
- specified that only durable topic subscribers should
be returned. This does not affect returned queue consumers. If parameter
destination
specifies QueueInfo, this parameter is ignored.dataFlags
- specifies what information, besides common, should be included
into returned ConsumerInfo objects. Value can be any combination of flags
GET_STAT
, GET_DETAILED_STAT
and GET_SELECTOR
.
Notice GET_DETAILED_STAT
superceeds GET_STAT
. If not specified,
returned objects do not contain statistics or consumer's selector.
Also notice that statistical information may not be returned even when requested
if statistics are disabled in the server.
java.lang.IllegalArgumentException
- if dataFlags
parameter
is invalid.
TibjmsAdminException
- if not authorized or an error occurred.getConsumers()
,
getConsumer(long)
public ConsumerInfo getConsumer(long consumerID) throws TibjmsAdminException
null
if consumer with
specified ID does not exist in the server.
TibjmsAdminException
- if not authorized or an error occurred.getConsumers()
public ChannelInfo[] getChannels() throws TibjmsAdminException
getChannelStatistics(java.lang.String)
method to obtain
statistical information about the channel.
TibjmsAdminException
- if not authorized or an error occurred.public ChannelInfo getChannel(java.lang.String name) throws TibjmsAdminException
getChannelStatistics(java.lang.String)
method to obtain
statistical information about the channel.
null
if channel with
specified name does not exist in the server.
TibjmsAdminException
- if not authorized or an error occurred.getChannels()
public ChannelInfo getChannelStatistics(java.lang.String name) throws TibjmsAdminException
name
- name of the channel.
null
if channel with
specified name does not exist in the server or statistics are disabled.
TibjmsAdminException
- if not authorized or an error occurred.
TibjmsAdminInvalidNameException
- if name is not a legal channel
name.public Configuration getConfiguration() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public Configuration createConfiguration() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public void synchronizeConfiguration(Configuration configuration) throws TibjmsAdminException
A
- Configuration object containing a proposed configuration
for the server.
TibjmsAdminException
- if not authorized or an error occurred.public boolean isRestartRequired() throws TibjmsAdminException
TibjmsAdminException
- if not authorized or an error occurred.public java.lang.String[] getTraceBuffer(boolean clear) throws TibjmsAdminException
TibjmsAdminException
|
TIBCO Enterprise Message Service | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |