TIBCO EMS .NET API 10.3
TIBCO EMS .NET API 10.3
|
This is the main class for administering a TIBCO Enterprise Message Service server. More...
Public Member Functions | |
DetailedTransactionInfo | GetTransaction (TransactionInfo transaction) |
Get a specific xa transaction. More... | |
Admin (string url, string userName, string password) | |
This constructor is used to create an administrative connection to the server. More... | |
Admin (string url, string userName, string password, Hashtable sslParams) | |
This constructor is used to create an administrative connection to the server. More... | |
void | Close () |
Close connection to the server. More... | |
void | SaveConfiguration () |
Save any configuration changes to the server's config files. More... | |
void | UpdateServer (ServerInfo info) |
Update the server configuration. More... | |
void | Shutdown () |
Shutdown the server. More... | |
void | Restart () |
Restart the server. More... | |
void | RotateLog () |
Rotate server's log file. More... | |
void | UpdateCRL () |
Update server's CRL. More... | |
void | CreateCMListener (CMListenerInfo cmListener) |
Create (pre-register) TIBCO Rendezvous certified listener. More... | |
void | DeleteCMListener (CMListenerInfo cmListener) |
Delete TIBCO Rendezvous certified listener. More... | |
CMLedgerSubjectInfo[] | GetCMLedger (string pattern) |
Returns a summary of the contents of the ledger file of the server's default TIBCO Rendezvous certified messaging transport. More... | |
CMLedgerSubjectInfo[] | GetCMLedger (string transport, string pattern) |
Returns a summary of the contents of the transport's ledger file. More... | |
RouteInfo | GetRoute (string name) |
Returns route information or null if such route does not exist. More... | |
RouteInfo | CreateRoute (RouteInfo routeInfo) |
Create a new route. More... | |
void | UpdateRoute (RouteInfo routeInfo) |
Update route parameters. More... | |
void | DestroyRoute (string name) |
Destroy the route with specified name. More... | |
void | DestroyConnection (long connectionID) |
Destroy the client connection for the given connectionID. More... | |
QueueInfo | CreateQueue (QueueInfo queue) |
Create a queue based on the parameters from the given QueueInfo. More... | |
void | UpdateQueue (QueueInfo queue) |
Change the properties of the queue corresponding to the given QueueInfo. More... | |
void | DestroyQueue (string queueName) |
Destroy the queue for the given queue name. More... | |
void | DestroyQueues (string pattern) |
Destroy queues matching the given pattern. More... | |
QueueInfo | GetQueue (string queueName) |
Get the queue for the given queue name. More... | |
QueueInfo[] | GetQueues (string pattern) |
Get the information for queues that match the given pattern. More... | |
QueueInfo[] | GetQueues (string pattern, RequestDestInfo permanenceType) |
Get the information for the queues that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return queues only of specified types. More... | |
QueueInfo[] | GetQueues (string pattern, RequestDestInfo permanenceType, int cursorPosition, int cursorSize) |
Get the information for the queues that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return queues only of specified types. More... | |
void | PurgeQueue (string queueName) |
Purge pending messages from the queue for the given name. More... | |
void | PurgeQueues (string pattern) |
Purge pending messages from queues matching the given pattern. More... | |
TopicInfo | CreateTopic (TopicInfo topic) |
Create a topic based on the parameters from the given TopicInfo. More... | |
void | UpdateTopic (TopicInfo topic) |
Change the properties of the topic corresponding to the given TopicInfo. More... | |
void | DestroyTopic (string topicName) |
Destroy the topic for the given topic name. More... | |
void | DestroyTopics (string pattern) |
Destroy topics matching the given pattern. More... | |
TopicInfo | GetTopic (string topicName) |
Get the topic for the given topic name. More... | |
TopicInfo[] | GetTopics (string pattern) |
Get the information for the topics that match the given pattern. More... | |
TopicInfo[] | GetTopics (string pattern, RequestDestInfo permanenceType) |
Get the information for the topics that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return topics only of specified types. More... | |
TopicInfo[] | GetTopics (string pattern, RequestDestInfo permanenceType, int cursorPosition, int cursorSize) |
Get the information for the topics that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return topics only of specified types. More... | |
void | PurgeTopic (string topicName) |
Purge pending messages from the topic for the given name. More... | |
void | PurgeTopics (string pattern) |
Purge pending messages from topics matching the given pattern. More... | |
UserInfo | CreateUser (UserInfo user) |
Create a user based on the information in the given UserInfo. More... | |
void | DestroyUser (string userName) |
Destroy the user for the given userName. More... | |
void | UpdateUser (UserInfo userInfo) |
Save changes made to the given UserInfo. More... | |
UserInfo | GetUser (string userName) |
Get the user for the given username. More... | |
GroupInfo | CreateGroup (GroupInfo group) |
Create a group based on the information in the given GroupInfo. More... | |
void | DestroyGroup (string groupName) |
Destroy the group for the given groupName. More... | |
void | UpdateGroup (GroupInfo groupInfo) |
Save changes made to the given GroupInfo. More... | |
GroupInfo | GetGroup (string groupName) |
Get the group for the given name. More... | |
void | AddUserToGroup (string groupName, string userName) |
Add the user for the given userName to the group for the given groupName. More... | |
void | AddUsersToGroup (string groupName, string[] userNames) |
Add the users for the given array of userNames to the group for the given groupName. More... | |
void | RemoveUserFromGroup (string groupName, string userName) |
Remove the user for the given userName from the group for the given groupName. More... | |
void | RemoveUsersFromGroup (string groupName, string[] userNames) |
Remove the users for the given array of userNames from the group for the given groupName. More... | |
System.Object[] | GetPermissions (System.Object target) |
Get all permission entries for specified target. More... | |
System.Object[] | GetPermissions (UserInfo target, int flags) |
Get user permissions based on the flags set. More... | |
ACLEntry[] | GetQueueACLEntries (string queueName) |
Get all ACL entries pertaining to the queue with the given queueName. More... | |
ACLEntry[] | GetTopicACLEntries (string topicName) |
Get all ACL entries pertaining to the topic with the given topicName. More... | |
ACLEntry[] | GetUserACLEntries (string userName) |
Get all ACL entries pertaining to the user with the given userName. More... | |
ACLEntry[] | GetGroupACLEntries (string groupName) |
Get all permissions on destinations for specified group. More... | |
void | Grant (ACLEntry entry) |
Grant the permissions specified in the given ACLEntry. More... | |
void | Grant (ACLEntry[] acls) |
Grant the permissions specified in the given ACLEntries. More... | |
void | Grant (AdminACLEntry entry) |
Grant the administrative permissions. More... | |
void | Revoke (ACLEntry entry) |
Revoke the permissions specified in the given ACLEntry. More... | |
void | Revoke (ACLEntry[] acls) |
Revoke the permissions specified in the given ACLEntries. More... | |
void | Revoke (AdminACLEntry entry) |
Revoke the administrative permissions. More... | |
DurableInfo | GetDurable (string durableName, string clientID) |
Get the durable subscription information for the given durable name and clientID. More... | |
DurableInfo[] | GetDurables (string topicName) |
Get the durable subscription information for the given topic name. More... | |
void | PurgeDurable (string durableName, string clientID) |
Purge pending messages for the durable with given name and client ID. More... | |
void | CreateDurable (string topicName, string durableName, string clientID, string selector, bool nolocal, bool route) |
Create the durable with given name and client ID. More... | |
void | DestroyDurable (string durableName, string clientID) |
Destroy the durable with given name and client ID. More... | |
Message | GetMessage (string messageID) |
Get the message for the given message ID. More... | |
void | DestroyMessage (string messageID) |
Destroy the message for the given message ID. More... | |
Message[] | GetMessages (string correlationID) |
Get the messages that have the given correlation ID. More... | |
void | CreateConnectionFactory (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. More... | |
void | UpdateConnectionFactory (string jndiName, ConnectionFactoryInfo cfi) |
Save changes to the connection factory stored at the given JNDI name using information from the given ConnectionFactoryInfo. More... | |
void | DestroyConnectionFactory (string jndiName) |
Destroy the connection factory bound to the given JNDI name. More... | |
void | BindQueue (string name, string queueName) |
Bind the queue for the given queue name to the given JNDI name. More... | |
void | BindTopic (string name, string topicName) |
Bind the topic for the given topic name to the given JNDI name. More... | |
void | Bind (string newName, string existingName) |
Bind an object already bound to an existing JNDI name to a new JNDI name. More... | |
void | Unbind (string name) |
Remove the binding between the given JNDI name and the object bound to it. More... | |
System.Object | Lookup (string name) |
Retrieve that administrative object bound to the given JNDI name. More... | |
ConsumerInfo[] | GetConsumersStatistics (long connectionID, string username, DestinationInfo destination) |
Get statistical information about consumers with specified parameters. More... | |
ProducerInfo[] | GetProducersStatistics (long connectionID, string username, DestinationInfo destination) |
Get the statistical information about producers with specified parameters. More... | |
TopicInfo[] | GetTopicsStatistics (string pattern) |
Get the statistical information for the topics that match the given pattern. More... | |
TopicInfo[] | GetTopicsStatistics (string pattern, int cursorPosition, int cursorSize) |
Get the statistical information for the topics that match the given pattern. More... | |
QueueInfo[] | GetQueuesStatistics (string pattern) |
Get the statistical information for the queues that match the given pattern. More... | |
QueueInfo[] | GetQueuesStatistics (string pattern, int cursorPosition, int cursorSize) |
Get the statistical information for the queues that match the given pattern. More... | |
RouteInfo | GetRouteStatistics (string name) |
Returns statistical information about the route with specified name. More... | |
void | CommitTransaction (TransactionInfo transaction) |
Commit the xa transaction. More... | |
void | RollbackTransaction (TransactionInfo transaction) |
Roll the xa transaction back. More... | |
TransportInfo | GetTransport (string transportName) |
Get the transport with a given name. More... | |
BridgeInfo[] | GetBridges (DestinationType type, 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. More... | |
BridgeInfo | GetBridge (DestinationType type, string name) |
Get the bridge from a given destination. More... | |
JACIInfo | GetJACIInfo () |
Get statistics on the JACI permissions cache. More... | |
void | ResetJACIStats () |
Reset all JACI statistics counters to zero. More... | |
void | ClearJACICache () |
Clear all entries out of the JACI results cache. More... | |
DestinationBridgeInfo | CreateDestinationBridge (DestinationBridgeInfo destBridge) |
Creates a destination bridge as specified by the DestinationBridgeInfo object. More... | |
void | DestroyDestinationBridge (DestinationType sourceType, string sourceName, DestinationType targetType, string targetName) |
Destroy the destination bridge between a source and a target More... | |
DestinationBridgeInfo | GetDestinationBridge (DestinationType sourceType, string sourceName, DestinationType targetType, string targetName) |
Returns the destination bridge between a source and a target More... | |
DestinationBridgeInfo[] | GetDestinationBridges (DestinationType sourceType, string sourcePattern) |
Get the destination bridges for all source destinations that match the given source type and source pattern. More... | |
bool | Compact (Store 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. (See remarks for important warning). More... | |
bool | Compact (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. (See remarks for important warning). More... | |
StoreInfo | GetStoreInfo (Store store) |
Get a summary of the usage of a store file. More... | |
StoreInfo | GetStoreInfo (String name) |
Get information about a store. More... | |
String[] | GetStores () |
Get a list of configured stores. More... | |
ConsumerInfo[] | GetConsumers () |
Returns all consumers in the server. Returned array may be of 0 length if there are no consumers in the server. 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. This method is equivalent to calling method GetConsumers(null,null,null,false,0) . See GetConsumers(Object,String,DestinationInfo,bool,int) for detailed information. More... | |
ConsumerInfo[] | GetConsumers (Object connectionID, String username, DestinationInfo destination, bool durable, int dataFlags) |
Returns consumers matching specified filters. Returned array may be of 0 length if there are no consumers in the server which match specified filters. More... | |
ConsumerInfo | GetConsumer (long consumerID) |
Returns consumer with specified ID. Returned consumer object contains all information about consumer known to server, including all details, available statistics, and consumer's selector. More... | |
SubscriptionInfo[] | GetSubscriptions () |
Returns all subscriptions in the server. More... | |
SubscriptionInfo[] | GetSubscriptions (int filterFlags, String name, String topicName) |
Returns subscriptions matching specified filters. More... | |
ChannelInfo[] | GetChannels () |
Returns all multicast channels in the server. More... | |
ChannelInfo | GetChannel (string name) |
Returns the multicast channel with the specified name. More... | |
ChannelInfo | GetChannelStatistics (string name) |
Returns statistical information about the multicast channel with the specified name. More... | |
String[] | GetTraceBuffer (bool clear) |
Reserved for internal provider use only. Do not use this method. More... | |
void | ActivateDRSite () |
Inform the FTL servers at the Disaster Recovery (DR) site that their site of operations is now the new primary site. More... | |
void | SetupDRSite (String urlList) |
Establish a new Disaster Recovery (DR) site after the original DR site has become the new primary site. Must be called on the active EMS server of the FTL server cluster at the designated new DR site. More... | |
void | SaveAndExit () |
When using in-memory replication with FTL stores, save the state of each server to disk and exit. Call this method when all servers have to be shut down. You need to alter the configuration of each of the servers to load its saved state upon restart. More... | |
Public Attributes | |
const int | PERMISSIONS_DIRECT_DEST = 0x0001 |
Permissions flag to get direct dest permissions for a given user. Use this flag with GetPermissions(UserInfo, flags) API. More... | |
const int | PERMISSIONS_DIRECT_ADMIN = 0x0002 |
Permissions flag to get direct admin permissions for a given user. Use this flag with GetPermissions(UserInfo, flags) API. More... | |
const int | PERMISSIONS_ALL_ADMIN = (PERMISSIONS_DIRECT_ADMIN | PERMISSIONS_INHERITED_ADMIN) |
Permissions flag to get all admin permissions for a given user (direct and inherited (i.e. as inhertied from groups to which the user belongs). Use this flag with GetPermissions(UserInfo, flags) API. More... | |
const int | PERMISSIONS_ALL_DEST = (PERMISSIONS_DIRECT_DEST | PERMISSIONS_INHERITED_DEST) |
Permissions flag to get all dest permissions for a given user (direct and inherited (i.e. as inhertied from groups to which the user belongs). Use this flag with GetPermissions(UserInfo, flags) API. More... | |
const int | PERMISSIONS_DIRECT = (PERMISSIONS_DIRECT_DEST | PERMISSIONS_DIRECT_ADMIN) |
Permissions flag to get all direct permissions for a given user (i.e. the one's directly assinged to the user). Use this flag with GetPermissions(UserInfo, flags) API. More... | |
const int | PERMISSIONS_ALL = (PERMISSIONS_ALL_DEST | PERMISSIONS_ALL_ADMIN) |
Permissions flag to get all permissions for a given user (destination and admin permissions both direct and inherited (i.e. as inherited from groups to which the user belogs). Use this flag with GetPermissions(UserInfo, flags) API. More... | |
const int | SESSION_UNKNOWN_ACKNOWLEDGE = 0 |
Unknown session acknowledge mode. This may be used as return value in cases, for example, when a consumer has no associated session. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | SESSION_NO_ACKNOWLEDGE = 1 |
No acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | SESSION_AUTO_ACKNOWLEDGE = 2 |
AUTO acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | SESSION_DUPS_OK_ACKNOWLEDGE = 3 |
DUPS_OK acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | SESSION_CLIENT_ACKNOWLEDGE = 4 |
CLIENT acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | SESSION_TRANSACTED = 5 |
Acknowledgement mode describing transacted session. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | SESSION_XA = 6 |
Acknowledgement mode describing XA session. See ConsumerInfo.Details.GetSessionAcknowledgeMode. More... | |
const int | GET_STAT = 0x0001 |
Flag requesting overall statistics to be returned by methods such as GetConsumers() More... | |
const int | GET_DETAILED_STAT = 0x0002 |
Flag requesting both overall and detailed statistics to be returned by methods such as GetConsumers() More... | |
const int | GET_SELECTOR = 0x0004 |
Flag requesting consumer's selector to be included into ConsumerInfo objects returned by the GetConsumers() method. GetConsumers() More... | |
const int | DEST_CURSOR_FIRST = 1 |
First cursorPosition for requested destinations. See GetQueues(string,RequestDestInfo,int,int), GetTopics(string,RequestDestInfo,int,int), GetQueuesStatistics(string,int,int), and GetTopicsStatistics(string,int,int). More... | |
const int | DEST_CURSOR_NEXT = 2 |
Next cursorPosition for requested destinations. See GetQueues(string,RequestDestInfo,int,int), GetTopics(string,RequestDestInfo,int,int), GetQueuesStatistics(string,int,int), and GetTopicsStatistics(string,int,int). More... | |
const int | DEST_CURSOR_LAST = 3 |
Last cursorPosition for requested destinations. See GetQueues(string,RequestDestInfo,int,int), GetTopics(string,RequestDestInfo,int,int), GetQueuesStatistics(string,int,int), and GetTopicsStatistics(string,int,int). More... | |
const int | SUBSCRIPTIONS_FILTER_DURABLE_ONLY = 0x01 |
Flag requesting non durable subscriptions to be filtered out. See GetSubscriptions(int, string, string). More... | |
const int | SUBSCRIPTIONS_FILTER_NO_DURABLE = 0x02 |
Flag requesting durable subscriptions to be filtered out. See GetSubscriptions(int, string, string). More... | |
const int | SUBSCRIPTIONS_FILTER_SHARED_ONLY = 0x04 |
Flag requesting non shared subscriptions to be filtered out. See GetSubscriptions(int, string, string). More... | |
const int | SUBSCRIPTIONS_FILTER_NO_SHARED = 0x08 |
Flag requesting shared subscriptions to be filtered out. See GetSubscriptions(int, string, string). More... | |
const int | STORE_COMPACT_NOLIMIT = -1 |
Used to run the store compact as a full re-write with no time limit. Valid only for mstores. See Compact(Store, long). See Compact(string, long). More... | |
const long | ALL_CONSUMERS = -1 |
Properties | |
long | CommandTimeout [get, set] |
Get and set the command timeout in milliseconds. More... | |
bool | AutoSave [get, set] |
Returns true if server configuration is saved in the configuration files on disk after each change. More... | |
ServerInfo | Info [get] |
Get the current set of server configuration and metrics. More... | |
StateInfo | StateInfo [get] |
Get the current FT state of the server, along with its name, pid, version and whether or not it is running in an appliance. More... | |
CMListenerInfo[] | CMListeners [get] |
Get the TIBCO Rendezvous certified listeners explicitly created in the server configuration. More... | |
RouteInfo[] | Routes [get] |
Returns all routes known to the server. More... | |
UserInfo[] | Users [get] |
Get the array of all UserInfos known to the server. More... | |
GroupInfo[] | Groups [get] |
Get all the groups known to the server. More... | |
ACLEntry[] | ACLEntries [get] |
Get all ACL entries for destinations. More... | |
ConnectionFactoryInfo[] | ConnectionFactories [get] |
Get all connection factories in the server configuration. More... | |
TransactionInfo[] | Transactions [get] |
Get all the xa transactions known to the server. More... | |
TransportInfo[] | Transports [get] |
Get all the transports known to the server. More... | |
IExceptionListener | ExceptionListener [set] |
Sets an exception listener for the connection used by this API to communicate with the EMS server. More... | |
EMSExceptionHandler | ExceptionHandler |
Add the exception handler to the Admin object's underlying connection. More... | |
long | ConnectionId [get] |
Get the connection id of the Admin object's connection to the server. More... | |
ConnectionInfo[] | Connections [get] |
Returns all connections except system connections. More... | |
ConnectionInfo[] | SystemConnections [get] |
Returns all system connections. More... | |
QueueInfo[] | Queues [get] |
Get the information for all the queues that are known to the server. More... | |
TopicInfo[] | Topics [get] |
Get the information for all the topics that are known to the server. More... | |
System.Object[] | Permissions [get] |
Get all permission entries. More... | |
DurableInfo[] | Durables [get] |
Get the durable subscription information for all durables known to the server. More... | |
ConsumerInfo[] | ConsumersStatistics [get] |
Get statistical information about all consumers. More... | |
ProducerInfo[] | ProducersStatistics [get] |
Returns statistical information about all producers. More... | |
TopicInfo[] | TopicsStatistics [get] |
Get the statistical information for all topics. More... | |
QueueInfo[] | QueuesStatistics [get] |
Get the statistical information about all queues. More... | |
BridgeInfo[] | Bridges [get] |
Get all the bridges known to the server. More... | |
ChannelInfo[] | Channels [get] |
Get all the multicast channels known to the server. More... | |
bool | RestartRequired [get] |
Query a server to determine whether a restart is required to complete state changes. More... | |
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:
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.
|
inline |
This constructor is used to create an administrative connection to the server.
url | The URL of the server to administer. |
userName | Name of the administrator user. |
password | User password. |
AdminException | if not authorized or an error occurred. |
|
inline |
This constructor is used to create an administrative connection to the server.
Use this constructor if the connection to the server needs to use TLS.
url | The URL of the server to administer. |
userName | Name of the administrator user. |
password | User password. |
sslParams | The parameters used for the TLS connection. See the documentation of the TIBCO.EMS.EMSSSL class for details of valid TLS parameters. |
AdminException | if not authorized or an error occurred. |
|
inline |
Inform the FTL servers at the Disaster Recovery (DR) site that their site of operations is now the new primary site.
This call is only relevant when using FTL stores with DR configured.
AdminException | if not authorized or an error occurred. |
Since EMS 10.2.0
|
inline |
Add the users for the given array of userNames to the group for the given groupName.
groupName | The group that the users will be added to. |
userNames | The users to be added. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the names of the group or users are not legal. |
ArgumentException | if the array of user names is null. |
|
inline |
Add the user for the given userName to the group for the given groupName.
groupName | The group that the user will be added to. |
userName | The user to be added. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the names of the group or the user are not legal. |
|
inline |
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.
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. |
AdminException | if not authorized or an error occurred. |
AdminNameExistsException | if the JNDI name is already in use. |
AdminInvalidNameException | if the JNDI names are not legal. |
|
inline |
Bind the queue for the given queue name to the given JNDI name.
name | The JNDI name to which the queue will be bound. |
queueName | The name of the queue to bind. |
AdminException | if not authorized or an error occurred. |
AdminNameExistsException | if the JNDI name is already in use. |
AdminInvalidNameException | if name or queueName are not legal names. |
|
inline |
Bind the topic for the given topic name to the given JNDI name.
name | The JNDI name to which the topic will be bound. |
topicName | The name of the topic to bind. |
AdminException | if not authorized or an error occurred. |
AdminNameExistsException | if the JNDI name is already in use. |
AdminInvalidNameException | if name and topicName are legal names. |
|
inline |
Clear all entries out of the JACI results cache.
AdminException |
|
inline |
Close connection to the server.
After connection is closed the Admin object should no longer be used.
AdminException | if an error occurred. |
|
inline |
Commit the xa transaction.
transaction | The TransactionInfo object for the transaction to be committed. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if transaction is null. |
|
inline |
Compact one of the server's store files until either no more compaction can be done or timeout seconds have elapsed, whichever occurs first. (See remarks for important warning).
For mstores only, a value of STORE_COMPACT_NOLIMIT for the timeout triggers a full re-write of the mstore with no time limit.
WARNING: Once started, it is not possible to interrupt the compaction, and all other operations (creating new connections, sending and/or receiving messages, etc...) will be suspended during, at most, the number of seconds specified (the 'timeout' value) or, if using STORE_COMPACT_NOLIMIT, and for mstores only, until the mstore has been entirely re-written.
store | the store file to compact, Store |
timeout | time in seconds allowed for compaction (must be greater than zero) or, for mstores only, STORE_COMPACT_NOLIMIT |
AdminException | if not authorized or an error occurred. |
ArgumentException | if store is invalid or timeout is not greater than zero. |
|
inline |
Compact one of the server's store files until either no more compaction can be done or timeout seconds have elapsed, whichever occurs first. (See remarks for important warning).
For mstores only, a value of STORE_COMPACT_NOLIMIT for the timeout triggers a full re-write of the mstore with no time limit.
WARNING: Once started, it is not possible to interrupt the compaction, and all other operations (creating new connections, sending and/or receiving messages, etc...) will be suspended during, at most, the number of seconds specified (the 'timeout' value) or, if using STORE_COMPACT_NOLIMIT, and for mstores only, until the mstore has been entirely re-written.
name | the store file 'name' to compact. |
timeout | time in seconds allowed for compaction (must be greater than zero) or, for mstores only, STORE_COMPACT_NOLIMIT |
AdminException | if not authorized or an error occurred. |
ArgumentException | if store is invalid or timeout is not greater than zero. |
|
inline |
Create (pre-register) TIBCO Rendezvous certified listener.
cmListener | the certified listener to be created (pre-registered). |
AdminException | if not authorized or an error occurred. |
ArgumentException | if CMListenerInfo object is null. |
|
inline |
Create a connection factory based on the given ConnectionFactoryInfo and bind it to the given name in the internal JNDI implementation.
jndiName | The JNDI name to which the new factory will be bound. |
cfi | The info for the factory to create. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the JNDI name is not legal. |
ArgumentException | if ConnectionFactoryInfo object is null. |
AdminNameExistsException | if the JNDI name is already in use. |
|
inline |
Creates a destination bridge as specified by the DestinationBridgeInfo object.
destBridge | the destination bridge to be created |
AdminException | if not authorized or some other error occurred |
ArgumentException | if the DestinationBridgeInfo object is null |
AdminInvalidNameException | if the DestinationBridgeInfo object is not valid |
AdminNameExistsException | if a destination bridge already exists between the specified source and target. |
|
inline |
Create the durable with given name and client ID.
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. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if durableName is not a legal name. |
Create a group based on the information in the given GroupInfo.
group | The info for the group to be created. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the name of the group is not a legal group name. |
AdminNameExistsException | if a user aleady exists with the given name. |
Create a queue based on the parameters from the given QueueInfo.
queue | The description of the queue to be created. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the name of the queue is not a legal queue name. |
AdminNameExistsException | if a queue already exists with the given name. |
Create a new route.
routeInfo | The parameters for the new route. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if routeInfo is null. |
AdminInvalidNameException | if RouteInfo object does not have a legal name and url. |
Create a topic based on the parameters from the given TopicInfo.
topic | The description of the topic to be created. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the name of the topic is not a legal topic name. |
AdminNameExistsException | if a topic already exists with the given name. |
Create a user based on the information in the given UserInfo.
user | The information for the user to be created. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if the name of the user is not a legal user name. |
AdminNameExistsException | if a user already exists with the given name. |
|
inline |
Delete TIBCO Rendezvous certified listener.
cmListener | the certified listener to be deleted. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if cmListener is null. |
|
inline |
Destroy 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.
connectionID | The connection ID of the connection to be destroyed. |
AdminException | if not authorized or an error occurred. |
|
inline |
Destroy the connection factory bound to the given JNDI name.
jndiName | A JNDI name for the factory to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if jndiName is not a legal name. |
|
inline |
Destroy the destination bridge between a source and a target
sourceType | the type of the source destination, either a topic or a queue. See DestinationType |
sourceName | the name of the source destination |
targetType | the type of the target destination, either a topic or a queue. See DestinationType |
targetName | the name of the target destination |
AdminException | if not authorized or some other error occurred |
AdminInvalidNameException | if the source our target names or types are not valid |
|
inline |
Destroy the durable with given name and client ID.
durableName | The name of the durable to destroy. |
clientID | The client ID associated with the durable (can be null). |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if durableName is not a legal name. |
|
inline |
Destroy the group for the given groupName.
groupName | The name of the group to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if groupName is not a legal name. |
|
inline |
Destroy the message for the given message ID.
messageID | The ID of the message to destroy. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if messageID is not a legal ID. |
|
inline |
Destroy the queue for the given queue name.
queueName | The name of the queue to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if queueName is not a legal queue name. |
|
inline |
Destroy queues matching the given pattern.
pattern | a pattern indicating which queues to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if pattern is not a legal pattern. |
|
inline |
Destroy the route with specified name.
name | The name of the route to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if name is not a legal route name. |
|
inline |
Destroy the topic for the given topic name.
topicName | The name of the topic to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if topicName is not a legal topic name. |
|
inline |
Destroy topics matching the given pattern.
pattern | a pattern indicating which topics to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if pattern is not a legal pattern. |
|
inline |
Destroy the user for the given userName.
userName | The name of the user to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if userName is not a legal user name. |
|
inline |
Get the bridge from a given destination.
type | the type of source destination, either DestinationType.Queue or DestinationType.Topic. |
name | the name of the source destination |
AdminException | if not authorized or an error occurred. |
ArgumentException | type is invalid or name is null |
|
inline |
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.
type | the type of source destination, either DestinationType.Queue to return only bridges from queues, DestinationType.Topic to return only bridges from topics, or DestinationType.All 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. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if type is invalid |
|
inline |
Returns the multicast channel with the specified name.
Notice returned object does not contain statistical data for the channel. Use GetChannelStatistics() method to obtain statistical information about the channel.
name | the name of the channel. |
null
if channel with specified name does not exist in the server. ArgumentException | if name parameter is invalid. |
AdminException | if not authorized or an error occurred. |
GetChannels GetChannelStatistics
|
inline |
Returns all multicast channels in the server.
Notice returned objects do not contain statistical data for the channels. Use GetChannelStatistics() method to obtain statistical information about the channels.
AdminException | if not authorized or an error occurred. |
GetChannel GetChannelStatistics
|
inline |
Returns statistical information about the multicast channel with the specified name.
name | the name of the channel. |
null
if channel with specified name does not exist in the server or statistics are disabled. ArgumentException | if name parameter is invalid. |
AdminException | if not authorized or an error occurred. |
|
inline |
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 TIBCO EMS documentation for how wildcards work. A pattern of "", ">", or null will return information on all the subjects in the ledger file.
pattern | a pattern indicating which subjects are of interest. |
AdminException | if not authorized or an error occurred. |
|
inline |
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 TIBCO EMS documentation for how wildcards work. A pattern of "", ">", or null will return information on all the subjects in the ledger file.
transport | the name of the transport whose ledger file is to be summarized. |
pattern | a pattern indicating which subjects are of interest. |
AdminException | if not authorized or an error occurred. |
|
inline |
Returns consumer with specified ID. Returned consumer object contains all information about consumer known to server, including all details, available statistics, and consumer's selector.
null
if consumer with specified ID does not exist in the server. AdminException | if not authorized or an error occurred. |
|
inline |
Returns all consumers in the server. Returned array may be of 0 length if there are no consumers in the server. 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. This method is equivalent to calling method GetConsumers(null,null,null,false,0)
. See GetConsumers(Object,String,DestinationInfo,bool,int) for detailed information.
AdminException | if not authorized or an error occurred. |
|
inline |
Returns consumers matching specified filters. Returned array may be of 0 length if there are no consumers in the server which match specified filters.
This method returns only consumers matching filters specified by parameters 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.
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. GetConsumers(null,null,null,true,0);
returns all queue consumers and durable topic consumers. 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. |
ArgumentException | if dataFlags parameter is invalid. |
AdminException | if not authorized or an error occurred. |
|
inline |
Get statistical information about consumers with specified parameters.
connectionID | consumer connection ID or null. |
username | consumer user name or null. |
destination | consumer destination pattern or null. |
AdminException | if not authorized or an error occurred. |
|
inline |
Returns the destination bridge between a source and a target
sourceType | the type of the source destination, either a topic or queue. See DestinationType |
sourceName | the name of the source destination |
targetType | the type of the target destination, either a topic or queue. See DestinationType |
targetName | the name of the target destination |
AdminException | if not authorized or some other error occurred |
AdminInvalidNameException | if the source our target names or types are not valid |
|
inline |
Get the destination bridges for all source destinations that match the given source type and source pattern.
The source type can be either a topic, queue, or all. See DestinationType. 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 a queue or from all the topics if sourceType is a topic.
sourceType | the type of the source, either topic, queue, or all. See DestinationType, |
sourcePattern | a pattern or destination name |
AdminException | if not authorized or an error occurred |
AdminInvalidNameException | if sourcePattern or sourceType are not valid |
|
inline |
Get the durable subscription information for the given durable name and clientID.
durableName | name of the durable subsription. |
clientID | client ID associated with the durable (can be null). |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if durableName is not a legal name. |
|
inline |
Get the durable subscription information for the given topic name.
topicName | The name of topic to get durable information on. |
AdminException | if not authorized or an error occurred. |
Deprecated this method, remains fully functional but in EMS 4.4 the preferred way to obtain consumer information is via method GetConsumers()
|
inline |
Get the group for the given name.
groupName | The name of the group to retrieve. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if groupName is not a legal group name. |
|
inline |
Get all permissions on destinations for specified group.
groupName | the name of the group. |
AdminException | if not authorized or some error occurred. |
AdminInvalidNameException | if groupName is not a legal group name. |
|
inline |
Get statistics on the JACI permissions cache.
AdminException |
|
inline |
Get the message for the given message ID.
messageID | The ID of the message to retrieve. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if messageID is not a legal ID. |
|
inline |
Get the messages that have the given correlation ID.
correlationID | The correlation ID of the messages to retrieve. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if correlationID is not a legal ID. |
|
inline |
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.
target | the object |
AdminException | if not authorized or an error occurred. |
|
inline |
Get user permissions based on the flags set.
If no flags are specified i.e flags == 0, then all the permissions for the user are returned.
If flags == PERMISSIONS_ALL, then all the permissions are returned for the specified user, (i.e direct, inhertied i.e dest (user and admin) and other admin).
If flags == PERMISSIONS_ALL_DEST, then all the destination permissions for the user are returned, both direct and indirect (i.e inherited from groups).
If flags == PERMISSIONS_ALL_ADMIN, then all direct and inherited admin permissions are returned.
If flags == PERMISSIONS_DIRECT, then all direct destination permissions (user and admin) are returned (i.e the one directly assigned to the user).
If flags == PERMISSIONS_DIRECT_DEST all direct destination permissions for the user are returned.
If flags == PERMISSIONS_DIRECT_ADMIN, then all direct admin permissions are returned (i.e the ones directly assigned to the user).
NOTE: Inherited permissions cannot be modified (i.e removed)
target | the userinfo object |
flags | the flags, based on which the different permissions are returned |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the statistical information about producers with specified parameters.
connectionID | producer connection ID or null. |
username | producer user name or null. |
destination | producer destination pattern or null. |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the queue for the given queue name.
queueName | The name of the queue to get. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if queueName is not a legal name |
|
inline |
Get all ACL entries pertaining to the queue with the given queueName.
queueName | Queue name. |
AdminException | if not authorized or some error occurred. |
AdminInvalidNameException | if queueName is not a legal queue name. |
|
inline |
Get the information for queues that match the given pattern.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in queue names. A pattern of "", ">", or null will return all the queues.
pattern | The pattern that must be matched |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the information for the queues that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return queues only of specified types.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in queue names. A pattern of "", ">", or null will return all the queues if permanenceType is DestGetALL
pattern | The pattern that must be matched |
permanenceType | The permanenceType can be either RequestDestInfo.DestGetNoTemp, RequestDestInfo.DestGetStatic, RequestDestInfo.DestGetDynamic, or RequestDestInfo.DestGetAll. See RequestDestInfo. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if permanenceType is invalid |
|
inline |
Get the information for the queues that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return queues only of specified types.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in queue names. A pattern of "", ">", or null will return all the queues if permanenceType is DestGetALL
One can start, continue or complete a cursored scan of queues.
pattern | The pattern that must be matched |
permanenceType | The permanenceType can be either RequestDestInfo.DestGetNoTemp, RequestDestInfo.DestGetStatic, RequestDestInfo.DestGetDynamic, or RequestDestInfo.DestGetAll. See RequestDestInfo. |
cursorPosition | The cursorPosition can be Admin.DEST_CURSOR_FIRST, Admin.DEST_CURSOR_NEXT, Admin.DEST_CURSOR_LAST |
cursorSize | The cursorSize must be greater than zero. Note that the operation may return less than the requested size. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if permanenceType is invalid |
|
inline |
Get the statistical information for the queues that match the given pattern.
The wildcards "*" and ">" may be included in the pattern. See the TIBCO EMS documentation for how wildcards work in queue names. A pattern of "", ">", or null will return statistics for all the queues.
pattern | The pattern that must be matched |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the statistical information for the queues that match the given pattern.
The wildcards "*" and ">" may be included in the pattern. See the TIBCO EMS documentation for how wildcards work in queue names. A pattern of "", ">", or null will return statistics for all the queues.
One can start, continue or complete a cursored scan of queues.
pattern | The pattern that must be matched |
cursorPosition | The cursorPosition can be Admin.DEST_CURSOR_FIRST, Admin.DEST_CURSOR_NEXT, Admin.DEST_CURSOR_LAST |
cursorSize | The cursorSize must be greater than zero. Note that the operation may return less than the requested size. |
AdminException | if not authorized or an error occurred. |
|
inline |
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.
name | name of the route. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if name is not a legal route name. |
|
inline |
Returns statistical information about the route with specified name.
name | name of the route. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if name is not a legal route name. |
Get a summary of the usage of a store file.
store | the store file to summarize. See Store |
AdminException | if not authorized or an error occurred. |
ArgumentException | if store is invalid |
|
inline |
Get information about a store.
name | retrieve information about the store with this name |
AdminException | if not authorized or an error occurred. |
since EMS 5.0
|
inline |
Get a list of configured stores.
AdminException | if not authorized or an error occurred. |
EMS 5.0
|
inline |
Returns all subscriptions in the server.
Returned array may be of 0 length if there is no subscription in the server. Returned subscriptions are not sorted and placed in the array in any order. Application may need to sort the subscriptions in application-specific order if required.
This method is equivalent to calling method GetSubscriptions(0, null, null)
. Refer to documentation of GetSubscriptions(int, string, string) for detailed information.
AdminException | if not authorized or an error occurred. |
|
inline |
Returns subscriptions matching specified filters.
Returned array may be of 0 length if there is no subscription in the server which match specified filters.
This method returns only subscriptions matching filters specified by parameters filterFlags
, name
and topicName
.
Filters may be omitted by specifying 0
or null
value.
Returned subscriptions are not sorted and placed in the array in any order. Application may need to sort the subscriptions in application-specific order if required.
GetSubscriptions(0, null, null);
returns all subscriptions known to server. GetSubscriptions(Admin.SUBSCRIPTIONS_FILTER_DURABLE_ONLY, null, null);
returns all durable (shared or not shared) subscriptions. GetSubscriptions(Admin.SUBSCRIPTIONS_FILTER_DURABLE_ONLY + Admin.SUBSCRIPTIONS_FILTER_SHARED_ONLY, null, "news.*");
returns all shared durable subscriptions on any topic matching topic "news.*"
. filterFlags | value can be any combination of SUBSCRIPTIONS_FILTER_DURABLE_ONLY, SUBSCRIPTIONS_FILTER_NO_DURABLE, SUBSCRIPTIONS_FILTER_SHARED_ONLY and SUBSCRIPTIONS_FILTER_NO_SHARED. |
name | specifies that only subscriptions with this name should be returned. |
topicName | specifies that only subscriptions on a topic matching this topic name should be returned. |
ArgumentException | if parameter filterFlags is invalid. |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the topic for the given topic name.
topicName | The name of the topic to get. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if topicName is not a legal topic name |
|
inline |
Get all ACL entries pertaining to the topic with the given topicName.
topicName | Topic name. |
AdminException | if not authorized or some error occurred. |
AdminInvalidNameException | if topicName is not a legal topic name. |
|
inline |
Get the information for the topics that match the given pattern.
The pattern may contain the wildcards "*" and ">" . See the TIBCO EMS documentation for how wildcards work in topic names. A pattern of "", ">", or null will return all the topics.
pattern | The pattern that must be matched |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the information for the topics that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return topics only of specified types.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in topic names. A pattern of "", ">", or null will return all the topics if permanenceType is DestGetAll.
pattern | The pattern that must be matched |
permanenceType | The permanenceType can be either RequestDestInfo.DestGetNoTemp, RequestDestInfo.DestGetStatic, RequestDestInfo.DestGetDynamic, or RequestDestInfo.DestGetAll. See RequestDestInfo. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if permanenceType is invalid |
|
inline |
Get the information for the topics that match the given pattern and the given permanence type, (that can be any of the RequestDestInfo types) that is an indication to return topics only of specified types.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in topic names. A pattern of "", ">", or null will return all the topics if permanenceType is DestGetAll.
One can start, continue or complete a cursored scan of queues.
pattern | The pattern that must be matched |
permanenceType | The permanenceType can be either RequestDestInfo.DestGetNoTemp, RequestDestInfo.DestGetStatic, RequestDestInfo.DestGetDynamic, or RequestDestInfo.DestGetAll. See RequestDestInfo. |
cursorPosition | The cursorPosition can be Admin.DEST_CURSOR_FIRST, Admin.DEST_CURSOR_NEXT, Admin.DEST_CURSOR_LAST |
cursorSize | The cursorSize must be greater than zero. Note that the operation may return less than the requested size. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if permanenceType is invalid |
|
inline |
Get the statistical information for the topics that match the given pattern.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in topic names. A pattern of "", ">", or null will return statistics for all the topics.
pattern | The pattern that must be matched |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the statistical information for the topics that match the given pattern.
The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in topic names. A pattern of "", ">", or null will return statistics for all the topics.
One can start, continue or complete a cursored scan of queues.
pattern | The pattern that must be matched |
cursorPosition | The cursorPosition can be Admin.DEST_CURSOR_FIRST, Admin.DEST_CURSOR_NEXT, Admin.DEST_CURSOR_LAST |
cursorSize | The cursorSize must be greater than zero. Note that the operation may return less than the requested size. |
AdminException | if not authorized or an error occurred. |
|
inline |
Reserved for internal provider use only. Do not use this method.
|
inline |
Get a specific xa transaction.
transaction | The TransactionInfo object for the transaction to be inspected. |
AdminException | if not authorized or an error occurred. |
|
inline |
Get the transport with a given name.
transportName | the name of the transport. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if transportName is not a legal transport name |
|
inline |
Get the user for the given username.
userName | The name of the user to retrieve info for. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if userName is not a legal user name. |
|
inline |
Get all ACL entries pertaining to the user with the given userName.
userName | User name. |
AdminException | if not authorized or some error occurred. |
AdminInvalidNameException | if userName is not a legal user name. |
|
inline |
Grant the permissions specified in the given ACLEntry.
entry | The description of the permissions to grant. |
AdminException | if not authorized or some error occurred. |
ArgumentException | if entry is null. |
|
inline |
Grant the permissions specified in the given ACLEntries.
acls | The descriptions of the permissions to grant. |
AdminException | if not authorized or some error occurred. |
ArgumentException | if acls is null. |
|
inline |
Grant the administrative permissions.
entry | the AdminACLEntry to grant. |
AdminException | if not authorized or some error occurred. |
ArgumentException | if entry is null. |
|
inline |
Retrieve that administrative object bound to the given JNDI name.
name | The JNDI name to lookup. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if name is not a legal name. |
|
inline |
Purge pending messages for the durable with given name and client ID.
durableName | The name of the durable to purge. |
clientID | The client ID associated with the durable (can be null). |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if durableName is not a legal durable name. |
|
inline |
Purge pending messages from the queue for the given name.
queueName | The name of the queue to purge. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if queueName is not a legal queue name. |
|
inline |
Purge pending messages from queues matching the given pattern.
pattern | a pattern indicating which queues to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if pattern is not a legal pattern. |
|
inline |
Purge pending messages from the topic for the given name.
topicName | The name of the topic to purge. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if topicName is not a legal topic name. |
|
inline |
Purge pending messages from topics matching the given pattern.
pattern | a pattern indicating which topics to destroy. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if pattern is not a legal pattern. |
|
inline |
Remove the user for the given userName from the group for the given groupName.
groupName | The group that the user will be removed from. |
userName | The user to be removed. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if groupName or userName are not legal names. |
|
inline |
Remove the users for the given array of userNames from the group for the given groupName.
groupName | The group that the users will be removed from. |
userNames | The users to be removed. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if groupName or one of the user names is not a legal name. |
ArgumentException | if userNames is null; |
|
inline |
Reset all JACI statistics counters to zero.
AdminException |
|
inline |
Restart the server.
Not supported.
AdminException | Not supported. |
|
inline |
Revoke the permissions specified in the given ACLEntry.
entry | the ACLEntry to revoke. |
AdminException | if not authorized or some error occurred. |
ArgumentException | if ACLEntry is null. |
|
inline |
Revoke the permissions specified in the given ACLEntries.
acls | an array of ACLEntry objects containing the positive permissions to be revoked. |
AdminException | if not authorized or some error occurred. |
ArgumentException | if ACLEntry array is null. |
|
inline |
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.
entry | the AdminACLEntry containing the positive permissions to be revoked. |
AdminException | if not authorized or some error occurred. |
ArgumentException | if AdminACLEntry is null. |
|
inline |
Roll the xa transaction back.
transaction | The TransactionInfo object for the transaction to be rolled back. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if TransactionInfo object is null. |
|
inline |
Rotate server's log file.
AdminException | if not authorized or an error occurred. |
|
inline |
When using in-memory replication with FTL stores, save the state of each server to disk and exit. Call this method when all servers have to be shut down. You need to alter the configuration of each of the servers to load its saved state upon restart.
This call is only relevant when using FTL stores with in-memory replication configured.
AdminException | if not authorized or an error occurred. |
Since EMS 10.2.0
|
inline |
Save any configuration changes to the server's config files.
This call is necessary when auto save mode is not set.
AdminException | if not authorized or an error occurred. |
|
inline |
Establish a new Disaster Recovery (DR) site after the original DR site has become the new primary site. Must be called on the active EMS server of the FTL server cluster at the designated new DR site.
This call is only relevant when using FTL stores with DR configured.
urlList | the pipe-separated list of URLs of the FTL server cluster at the primary site. Each URL should be of the form: <FTL server name>@<host>:<port> |
AdminException | if not authorized or an error occurred. |
Since EMS 10.2.0
|
inline |
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.
AdminException | if not authorized or an error occurred. |
|
inline |
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.
name | The JNDI name to unbind. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if name is not a legal JNDI name. |
|
inline |
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 method.
jndiName | The JNDI name of the factory that will be updated. |
cfi | The updated info for the factory. |
AdminException | if not authorized or an error occurred. |
AdminInvalidNameException | if jndiName is not a legal JNDI name. |
ArgumentException | if ConnectionFactoryInfo object is null. |
|
inline |
Update server's CRL.
AdminException | if an error occurred. |
|
inline |
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 method.
groupInfo | The group to save configuration changes for. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if GroupInfo object is null. |
|
inline |
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 method.
queue | The QueueInfo for the queue to be modified. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if QueueInfo object is null. |
|
inline |
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 method.
routeInfo | The route info to save. |
AdminException | if not authorized or an error occurred. |
|
inline |
Update the server configuration.
info | a ServerInfo object containing the changed configuration parameters. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if ServerInfo object is null. |
|
inline |
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 method.
topic | The TopicInfo for the queue to be modified. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if TopicInfo object is null. |
|
inline |
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 method.
userInfo | The user information to save. |
AdminException | if not authorized or an error occurred. |
ArgumentException | if UserInfo object is null. |
const long TIBCO.EMS.ADMIN.Admin.ALL_CONSUMERS = -1 |
const int TIBCO.EMS.ADMIN.Admin.DEST_CURSOR_FIRST = 1 |
First cursorPosition for requested destinations. See GetQueues(string,RequestDestInfo,int,int), GetTopics(string,RequestDestInfo,int,int), GetQueuesStatistics(string,int,int), and GetTopicsStatistics(string,int,int).
const int TIBCO.EMS.ADMIN.Admin.DEST_CURSOR_LAST = 3 |
Last cursorPosition for requested destinations. See GetQueues(string,RequestDestInfo,int,int), GetTopics(string,RequestDestInfo,int,int), GetQueuesStatistics(string,int,int), and GetTopicsStatistics(string,int,int).
const int TIBCO.EMS.ADMIN.Admin.DEST_CURSOR_NEXT = 2 |
Next cursorPosition for requested destinations. See GetQueues(string,RequestDestInfo,int,int), GetTopics(string,RequestDestInfo,int,int), GetQueuesStatistics(string,int,int), and GetTopicsStatistics(string,int,int).
const int TIBCO.EMS.ADMIN.Admin.GET_DETAILED_STAT = 0x0002 |
Flag requesting both overall and detailed statistics to be returned by methods such as GetConsumers()
const int TIBCO.EMS.ADMIN.Admin.GET_SELECTOR = 0x0004 |
Flag requesting consumer's selector to be included into ConsumerInfo objects returned by the GetConsumers() method. GetConsumers()
const int TIBCO.EMS.ADMIN.Admin.GET_STAT = 0x0001 |
Flag requesting overall statistics to be returned by methods such as GetConsumers()
const int TIBCO.EMS.ADMIN.Admin.PERMISSIONS_ALL = (PERMISSIONS_ALL_DEST | PERMISSIONS_ALL_ADMIN) |
Permissions flag to get all permissions for a given user (destination and admin permissions both direct and inherited (i.e. as inherited from groups to which the user belogs). Use this flag with GetPermissions(UserInfo, flags) API.
const int TIBCO.EMS.ADMIN.Admin.PERMISSIONS_ALL_ADMIN = (PERMISSIONS_DIRECT_ADMIN | PERMISSIONS_INHERITED_ADMIN) |
Permissions flag to get all admin permissions for a given user (direct and inherited (i.e. as inhertied from groups to which the user belongs). Use this flag with GetPermissions(UserInfo, flags) API.
const int TIBCO.EMS.ADMIN.Admin.PERMISSIONS_ALL_DEST = (PERMISSIONS_DIRECT_DEST | PERMISSIONS_INHERITED_DEST) |
Permissions flag to get all dest permissions for a given user (direct and inherited (i.e. as inhertied from groups to which the user belongs). Use this flag with GetPermissions(UserInfo, flags) API.
const int TIBCO.EMS.ADMIN.Admin.PERMISSIONS_DIRECT = (PERMISSIONS_DIRECT_DEST | PERMISSIONS_DIRECT_ADMIN) |
Permissions flag to get all direct permissions for a given user (i.e. the one's directly assinged to the user). Use this flag with GetPermissions(UserInfo, flags) API.
const int TIBCO.EMS.ADMIN.Admin.PERMISSIONS_DIRECT_ADMIN = 0x0002 |
Permissions flag to get direct admin permissions for a given user. Use this flag with GetPermissions(UserInfo, flags) API.
const int TIBCO.EMS.ADMIN.Admin.PERMISSIONS_DIRECT_DEST = 0x0001 |
Permissions flag to get direct dest permissions for a given user. Use this flag with GetPermissions(UserInfo, flags) API.
const int TIBCO.EMS.ADMIN.Admin.SESSION_AUTO_ACKNOWLEDGE = 2 |
AUTO acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.SESSION_CLIENT_ACKNOWLEDGE = 4 |
CLIENT acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.SESSION_DUPS_OK_ACKNOWLEDGE = 3 |
DUPS_OK acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.SESSION_NO_ACKNOWLEDGE = 1 |
No acknowledgement mode. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.SESSION_TRANSACTED = 5 |
Acknowledgement mode describing transacted session. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.SESSION_UNKNOWN_ACKNOWLEDGE = 0 |
Unknown session acknowledge mode. This may be used as return value in cases, for example, when a consumer has no associated session. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.SESSION_XA = 6 |
Acknowledgement mode describing XA session. See ConsumerInfo.Details.GetSessionAcknowledgeMode.
const int TIBCO.EMS.ADMIN.Admin.STORE_COMPACT_NOLIMIT = -1 |
Used to run the store compact as a full re-write with no time limit. Valid only for mstores. See Compact(Store, long). See Compact(string, long).
Since EMS 8.3.0
const int TIBCO.EMS.ADMIN.Admin.SUBSCRIPTIONS_FILTER_DURABLE_ONLY = 0x01 |
Flag requesting non durable subscriptions to be filtered out. See GetSubscriptions(int, string, string).
Since EMS 8.1.0
const int TIBCO.EMS.ADMIN.Admin.SUBSCRIPTIONS_FILTER_NO_DURABLE = 0x02 |
Flag requesting durable subscriptions to be filtered out. See GetSubscriptions(int, string, string).
Since EMS 8.1.0
const int TIBCO.EMS.ADMIN.Admin.SUBSCRIPTIONS_FILTER_NO_SHARED = 0x08 |
Flag requesting shared subscriptions to be filtered out. See GetSubscriptions(int, string, string).
Since EMS 8.1.0
const int TIBCO.EMS.ADMIN.Admin.SUBSCRIPTIONS_FILTER_SHARED_ONLY = 0x04 |
Flag requesting non shared subscriptions to be filtered out. See GetSubscriptions(int, string, string).
Since EMS 8.1.0
|
get |
Get all ACL entries for destinations.
AdminException | if not authorized or some error occurred. |
|
getset |
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. If auto save is turned on, the server updates the configuration files on disk after every change and calls to SaveConfiguration() are not required.
true if chages should be saved after every change in the configuration.
|
get |
Get all the bridges known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get all the multicast channels known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get the TIBCO Rendezvous certified listeners explicitly created in the server configuration.
AdminException | if not authorized or an error occurred. |
|
getset |
Get and set the command timeout in milliseconds.
If the server does not respond to a command within specified timeout the command throws an exception. Default value is 60000 (60 seconds). Expects the timeout value in milliseconds
ArgumentException | if value is less than 5000ms. |
|
get |
Get all connection factories in the server configuration.
AdminException | if not authorized or an error occurred. |
|
get |
|
get |
Returns all connections except system connections.
System connections are connections to other servers.
AdminException | if not authorized or an error occurred. |
|
get |
Get statistical information about all consumers.
AdminException | if not authorized or an error occurred. |
|
get |
Get the durable subscription information for all durables known to the server.
AdminException | if not authorized or an error occurred. |
|
addremove |
Add the exception handler to the Admin object's underlying connection.
See the EMS API documentation for more information about exception handlers. Note in particular that you should only use either an ExceptionListener or an ExceptionHandler, not both.
|
set |
Sets an exception listener for the connection used by this API to communicate with the EMS server.
See the EMS API documentation for more information about exception listeners. Note in particular that you should only use either an ExceptionListener or an ExceptionHandler, not both.
AdminException | if not authorized or an error occurred. |
|
get |
Get all the groups known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get the current set of server configuration and metrics.
AdminException | if not authorized or an error occurred. |
|
get |
Get all permission entries.
AdminException | if not authorized or an error occurred. |
|
get |
Returns statistical information about all producers.
AdminException | if not authorized or an error occurred. |
|
get |
Get the information for all the queues that are known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get the statistical information about all queues.
AdminException | if not authorized or an error occurred. |
|
get |
Query a server to determine whether a restart is required to complete state changes.
This allows the server to be checked before issuing a restart.
|
get |
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.
AdminException | if not authorized or an error occurred. |
|
get |
Get the current FT state of the server, along with its name, pid, version and whether or not it is running in an appliance.
AdminException | if not authorized or an error occurred. |
Since EMS 8.1.0
|
get |
Returns all system connections.
System connections are connections to other servers.
AdminException | if not authorized or an error occurred. |
|
get |
Get the information for all the topics that are known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get the statistical information for all topics.
AdminException | if not authorized or an error occurred. |
|
get |
Get all the xa transactions known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get all the transports known to the server.
AdminException | if not authorized or an error occurred. |
|
get |
Get the array of all UserInfos known to the server.
AdminException | if not authorized or an error occurred. |