[TIBCO.EMS .NET Admin client library 6.3 documentation]

The Admin type exposes the following members.

Constructors

  NameDescription
AdminOverloaded.

Methods

  NameDescription
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.
ClearJACICache
Clear all entries out of the JACI results cache.
Close
Close connection to the server.
CommitTransaction
Commit the xa transaction.
CompactOverloaded.
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
Creates a destination bridge as specified by the DestinationBridgeInfo object.
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
Destroy the destination bridge between a source and a target
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.
DestroyQueues
Destroy queues matching the given pattern.
DestroyRoute
Destroy the route with specified name.
DestroyTopic
Destroy the topic for the given topic name.
DestroyTopics
Destroy topics matching the given pattern.
DestroyUser
Destroy the user for the given userName.
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from 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.
GetChannel
Returns the multicast channel with the specified name.
GetChannels
Returns all multicast channels in the server.
GetChannelStatistics
Returns statistical information about the multicast channel with the specified name.
GetCMLedgerOverloaded.
GetConsumer
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.
GetConsumersOverloaded.
GetConsumersStatistics
Get statistical information about consumers with specified parameters.
GetDestinationBridge
Returns the destination bridge between a source and a target
GetDestinationBridges
Get the destination bridges for all source destinations that match the given source type and source pattern.
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
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetJACIInfo
Get statistics on the JACI permissions cache.
GetMessage
Get the message for the given message ID.
GetMessages
Get the messages that have the given correlation ID.
GetPermissionsOverloaded.
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.
GetQueuesOverloaded.
GetQueuesStatisticsOverloaded.
GetRoute
Returns route information or null if such route does not exist.
GetRouteStatistics
Returns statistical information about the route with specified name.
GetStoreInfoOverloaded.
GetStores
Get a list of configured stores.
GetTopic
Get the topic for the given topic name.
GetTopicACLEntries
Get all ACL entries pertaining to the topic with the given topicName.
GetTopicsOverloaded.
GetTopicsStatisticsOverloaded.
GetTraceBuffer
Reserved for internal provider use only. Do not use this method.
GetTransaction
Get a specific xa transaction.
GetTransport
Get the transport with a given name.
GetType
Gets the Type of the current instance.
(Inherited from Object.)
GetUser
Get the user for the given username.
GetUserACLEntries
Get all ACL entries pertaining to the user with the given userName.
GrantOverloaded.
Lookup
Retrieve that administrative object bound to the given JNDI name.
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
PurgeDurable
Purge pending messages for the durable with given name and client ID.
PurgeQueue
Purge pending messages from the queue for the given name.
PurgeQueues
Purge pending messages from queues matching the given pattern.
PurgeTopic
Purge pending messages from the topic for the given name.
PurgeTopics
Purge pending messages from topics matching the given pattern.
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.
ResetJACIStats
Reset all JACI statistics counters to zero.
Restart
Restart the server.
RevokeOverloaded.
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
Returns a String that represents the current Object.
(Inherited from 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.

Fields

  NameDescription
ALL_CONSUMERS
DEST_CURSOR_FIRST
DEST_CURSOR_LAST
DEST_CURSOR_NEXT
GET_DETAILED_STAT
Flag requesting both overall and detailed statistics to be returned by methods such as GetConsumers()()() GetConsumers()()()
GET_SELECTOR
Flag requesting consumer's selector to be included into ConsumerInfo objects returned by GetConsumers method. GetConsumers()()()
GET_STAT
Flag requesting overall statistics to be returned by methods such as GetConsumers()()() GetConsumers()()()
PERMISSIONS_ALL
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.
PERMISSIONS_ALL_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.
PERMISSIONS_ALL_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.
PERMISSIONS_DIRECT
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.
PERMISSIONS_DIRECT_ADMIN
Permissions flag to get direct admin permissions for a given user. Use this flag with GetPermissions(UserInfo, flags) API.
PERMISSIONS_DIRECT_DEST
Permissions flag to get direct dest permissions for a given user. Use this flag with GetPermissions(UserInfo, flags) API.
SESSION_AUTO_ACKNOWLEDGE
AUTO acknowledgement mode. GetSessionAcknowledgeMode()()()
SESSION_CLIENT_ACKNOWLEDGE
CLIENT acknowledgement mode. GetSessionAcknowledgeMode()()()
SESSION_DUPS_OK_ACKNOWLEDGE
DUPS_OK acknowledgement mode. GetSessionAcknowledgeMode()()()
SESSION_NO_ACKNOWLEDGE
No acknowledgement mode. GetSessionAcknowledgeMode()()()
SESSION_TRANSACTED
Acknowledgement mode describing transacted session. GetSessionAcknowledgeMode()()()
SESSION_UNKNOWN_ACKNOWLEDGE
Unknown session acknowledge mode. This may be used as return value in cases, for example, when a consumer has no associated session. GetSessionAcknowledgeMode()()()
SESSION_XA
Acknowledgement mode describing XA session. GetSessionAcknowledgeMode()()()

Properties

  NameDescription
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.
Channels
Get all the multicast channels 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.
RestartRequired
Query a server to determine whether a restart is required to complete state changes.
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.

Events

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

See Also