TIBCO Enterprise Message Service 4.3.0 .NET Administration Class Library

Admin Members

Admin overview

Public Static Fields

ALL_CONSUMERS 

Public Instance Constructors

Admin Constructor This constructor is used to create an administrative connection to the server.

Public Instance Properties

ACLEntries Get all ACL entries for destinations.
AutoSave Returns true if server configuration is saved in the configuration files on disk after each change.
Bridges Get all the bridges known to the server.
CMListeners Get the TIBCO Rendezvous certified listeners explicitly created in the server configuration.
CommandTimeout Get and set the command timeout in milliseconds.
ConnectionFactories Get all connection factories in the server configuration.
ConnectionId Get the connection id of the Admin object's connection to the server.
Connections Returns all connections except system connections.
ConsumersStatistics Get statistical information about all consumers.
Durables Get the durable subscription information for all durables known to the server.
ExceptionListener Sets an exception listener for the connection used by the admin api to communicate with the EMS server.
Groups Get all the groups known to the server.
Info Get the current set of server configuration and metrics.
Permissions Get all permission entries.
ProducersStatistics Returns statistical information about all producers.
Queues Get the info for all the queues that are known to the server.
QueuesStatistics Get the statistical information about all queues.
Routes Returns all routes known to the server.
SystemConnections Returns all system connections.
Topics Get the info for all the topics that are known to the server.
TopicsStatistics Get the statistical information for all topics.
Transactions Get all the xa transactions known to the server.
Transports Get all the transports known to the server.
Users Get the array of all UserInfos known to the server.

Public Instance Methods

AddUsersToGroup Add the users for the given array of userNames to the group for the given groupName.
AddUserToGroup Add the user for the given userName to the group for the given groupName.
Bind Bind an object already bound to an existing JNDI name to a new JNDI name.
BindQueue Bind the queue for the given queue name to the given JNDI name.
BindTopic Bind the topic for the given topic name to the given JNDI name.
Close Close connection to the server.
CommitTransaction Commit the xa transaction.
Compact Compact one of the server's store files until either no more compaction can be done or timeout seconds have elapsed, whichever occurs first.
CreateCMListener Create (pre-register) TIBCO Rendezvous certified listener.
CreateConnectionFactory Create a connection factory based on the given ConnectionFactoryInfo and bind it to the given name in the internal JNDI implementation.
CreateDestinationBridge 
CreateDurable Create the durable with given name and client ID.
CreateGroup Create a group based on the information in the given GroupInfo.
CreateQueue Create a queue based on the parameters from the given QueueInfo.
CreateRoute Create a new route.
CreateTopic Create a topic based on the parameters from the given TopicInfo.
CreateUser Create a user based on the information in the given UserInfo.
DeleteCMListener Delete TIBCO Rendezvous certified listener.
DestroyConnection Destroy the client connection for the given connectionID.
DestroyConnectionFactory Destroy the connection factory bound to the given JNDI name.
DestroyDestinationBridge 
DestroyDurable Destroy the durable with given name and client ID.
DestroyGroup Destroy the group for the given groupName.
DestroyMessage Destroy the message for the given message ID.
DestroyQueue Destroy the queue for the given queue name.
DestroyRoute Destroy the route with specified name.
DestroyTopic Destroy the topic for the given topic name.
DestroyUser Destroy the user for the given userName.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetBridge Get the bridge from a given destination.
GetBridges 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.
GetCMLedgerOverloaded. Returns a summary of the contents of the ledger file of the server's default TIBCO Rendezvous certified messaging transport.
GetConsumersStatistics Get statistical information about consumers with specified parameters.
GetDestinationBridge 
GetDestinationBridges 
GetDurable Get the durable subscription information for the given durable name and clientID.
GetDurables Get the durable subscription information for the given topic name.
GetGroup Get the group for the given name.
GetGroupACLEntries Get all permissions on destinations for specified group.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetMessage Get the message for the given message ID.
GetMessages Get the messages that have the given correlation ID.
GetPermissions Get all permission entries for specified target.
GetProducersStatistics Get the statistical information about producers with specified parameters.
GetQueue Get the queue for the given queue name.
GetQueueACLEntries Get all ACL entries pertaining to the queue with the given queueName.
GetQueues Get the info for the queues that match the given pattern.
GetQueuesStatistics Get the statistical information for the queues that match the given pattern.
GetRoute Returns route information or null if such route does not exist.
GetRouteStatistics Returns statistical information about the route with specified name.
GetStoreInfo Get a summary of the usage of a store file.
GetTopic Get the topic for the given topic name.
GetTopicACLEntries Get all ACL entries pertaining to the topic with the given topicName.
GetTopics Get the info for the topics that match the given pattern.
GetTopicsStatistics Get the statistical information for the topics that match the given pattern.
GetTransport Get the transport with a given name.
GetType (inherited from Object) Gets the Type of the current instance.
GetUser Get the user for the given username.
GetUserACLEntries Get all ACL entries pertaining to the user with the given userName.
GrantOverloaded. Grant the permissions specified in the given ACLEntry.
Lookup Retrieve that administrative object bound to the given JNDI name.
PurgeDurable Purge pending messages for the durable with given name and client ID.
PurgeQueue Purge pending messages from the queue for the given name.
PurgeTopic Purge pending messages from the topic for the given name.
RemoveUserFromGroup Remove the user for the given userName from the group for the given groupName.
RemoveUsersFromGroup Remove the users for the given array of userNames from the group for the given groupName.
RevokeOverloaded. Revoke the permissions specified in the given ACLEntry.
RollbackTransaction Roll the xa transaction back.
RotateLog Rotate server's log file.
SaveConfiguration Save any configuration changes to the server's config files.
Shutdown Shutdown the server.
ToString (inherited from Object) Returns a String that represents the current Object.
Unbind Remove the binding between the given JNDI name and the object bound to it.
UpdateConnectionFactory Save changes to the connection factory stored at the given JNDI name using information from the given ConnectionFactoryInfo.
UpdateCRL Update server's CRL.
UpdateGroup Save changes made to the given GroupInfo.
UpdateQueue Change the properties of the queue corresponding to the given QueueInfo.
UpdateRoute Update route parameters.
UpdateServer Update the server configuration.
UpdateTopic Change the properties of the topic corresponding to the given TopicInfo.
UpdateUser Save changes made to the given UserInfo.

Public Instance Events

ExceptionHandler Add the exception handler to the Admin object's underlying connection.

See Also

Admin Class | TIBCO.EMS.ADMIN Namespace