Classes
class	ACLEntry
	An ACLEntry represents the set of permissions that a Principal (User or Group) has on a Destination (Topic or Queue). More...

class	Admin
	This is the main class for administering a TIBCO Enterprise Message Service server. More...

class	AdminACLEntry
	This class represents a set of administrative permissions for a Principal (user or group). More...

class	AdminException
	This is the general admin exception used when an error occurs with a call to the server. More...

class	AdminInvalidNameException
	This is the admin exception thrown when the name used to create a User, Group, or Destination is invalid. More...

class	AdminNameExistsException
	This is the admin exception thrown when the name used to create a User, Group, Destination, or JNDI binding is already in use. More...

class	AdminPermissions
	This class represents a set of positive and negative administrative permissions. Negative permissions are only returned when the entry is returned from the server. In grant() and revoke() methods only positive permissions are used to specify the set of permissions which should be granted or revoked. Applications normally use objects returned as a result of a server query to obtain administrative permissions. If any permissions have to be changed, a new AdminPermission object should be created. More...

class	AdminSecurityException
	This is the admin exception thrown when the user is not authorized to execute a command. More...

class	BridgeInfo
	This class represents the definition of a bridge. A bridge consists of a source destination name and type and 1 or more BridgeTarget objects. More...

class	BridgeTarget
	This class represents the target destination of a bridge. More...

class	ChannelInfo
	An object of this class represents the configuration and optionally statistical data about the multicast channel. More...

class	CMLedgerListenerInfo
	This class represents a summary about a single registered TIBCO Rendezvous certified listener that the EMS server exports messages to. More...

class	CMLedgerSubjectInfo
	This class represents an outbound subject entry in a TIBCO Rendezvous Certified Messaging ledger file. More...

class	CMListenerInfo
	This class represents a TIBCO Rendezvous CM listener. More...

class	ConnectionFactoryInfo
	A ConnectionFactoryInfo object represents a configured ConnectionFactory that can be retrieved by an EMS client through the built in JNDI implementation. This class is used to create and alter the properties of the ConnectionFactory. More...

class	ConnectionInfo
	A ConnectionInfo object represents a client connection to the TIBCO EMS server. ConnectionInfo objects are obtained through calls to Admin.GetConnections(). More...

class	ConsumerInfo
	A ConsumerInfo object represents a message consumer. Admin.GetConsumers() More...

class	DbStoreInfo
	Class representing information about server's database-based store. More...

class	DestinationBridgeInfo
	This class replaces the old BridgeInfo class to represent bridges between destinations. More...

class	DestinationInfo
	This abstract class contains methods common to both QueueInfo and TopicInfo. More...

class	DetailedDestStat
	This class represents detailed destination statistics about another object (Topic, Queue etc). More...

class	DetailedTransactionInfo
	This class represents the a transaction as it is present on the EMS server. In addition to TransactionInfo it contains more detail. Especially about Messages that are part of this transaction. More...

class	DurableInfo
	This class represents a durable subscription on the Tibjms server. More...

class	FileStoreInfo
	Class representing information about a server's file-based store. More...

class	FTLParams
	This class represents FTL parameters. More...

class	FTLTransportInfo
	This class represents TIBCO FTL transports that are configured on the EMS server. More...

class	GroupInfo
	This class represents a group on the Tibjms server. More...

class	JACIInfo
	This class represents a set of statistics about the JACI cache collected from the EMS server. More...

class	LDAPParams
	This class represents LDAP parameters. More...

class	MStoreInfo
	Class representing information about server's mstore-based store. More...

class	Permissions
	This class represents a set of permissions on destinations. More...

class	PrincipalInfo
	This abstract class represents a user or group and contains methods common to both. More...

class	ProducerInfo
	A ProducerInfo object represents a message producer. More...

class	QueueInfo
	This class represents a message queue that is configured on the EMS server. More...

class	RouteInfo
	An object of this class represents the configuration and optionally statistical data about the routed server. More...

class	RouteSelector
	This class represents a selector applied to incoming or outgoing messages on a route. More...

class	RVCMTransportInfo
	This class represents TIBCO Rendezvous Certified Messaging transports that are configured on the EMS server. More...

class	RVQueuePolicy
	This class represents the discard policy of the TIBCO Rendezvous queues used internally by the TIBCO EMS Server when importing messages from TIBCO Rendezvous. More...

class	RVTransportInfo
	This class represents TIBCO Rendezvous transports that are configured on the EMS server. More...

class	ServerInfo
	This class represents configuration parameters for a TIBCO Enterprise Message Service server. More...

class	SSLParams
	This class represents all the possible TLS parameters. More...

class	SSTransportInfo
	This class represents TIBCO SmartSockets transports that are configured on the EMS server. More...

class	StatData
	This class represents statistical data about another object (Topic, Queue etc). More...

class	StateInfo
	This class represents the FT state for a TIBCO Enterprise Message Service server, along with other information. More...

class	StateObj
	This class represents the FT state for a TIBCO Enterprise Message Service server. More...

class	StoreInfo
	Class representing information about a server's store. More...

class	SubscriptionInfo
	This class represents a topic subscription in EMS Server. More...

class	ThirdPartyParams
	This class represents parameters from third party components such as TLS and LDAP. More...

class	TopicInfo
	This class represents a topic that is configured on the EMS server. More...

class	TraceInfo
	This class represents the set of trace message types that will be output to a particular output destination (console or log file). More...

class	TransactionInfo
	This class represents an XA transaction. More...

class	TransportInfo
	This abstract class represents the data and behavior common to transports of all types that are configured on the EMS server More...

class	UserInfo
	This class represents a user on the TIBCO EMS server. More...

class	VersionInfo
	This class represents the parsed version information for the TIBCO Enterprise Message Service components. More...

Enumerations
enum	Store { Store.Sync = (1 << 0), Store.Async = (1 << 1) }
	Enum that contains values for store, sync or async More...

enum	Metric { Metric.None = 0, Metric.Connections = 1, Metric.ByteRate = 2 }
	Defines the possible values for load balanced metric that can be specified for a connection factory or retrieved from a connection factory object. More...

enum	SSLType : byte { SSLType.None = 0, SSLType.SSL = 1, SSLType.TCP = 2 }
	Types indicating whether connection is TLS or not More...

enum	DestinationType { DestinationType.All = 0, DestinationType.Queue = 1, DestinationType.Topic = 2 }
	Enum containing different destination types More...

enum	OverflowPolicyType { OverflowPolicyType.Default = 0, OverflowPolicyType.DiscardOld = 1, OverflowPolicyType.RejectIncoming = 2 }
	Enum contains different overflow policy types More...

enum	RequestDestInfo { RequestDestInfo.DestGetStatic = 1, RequestDestInfo.DestGetDynamic = 2, RequestDestInfo.DestGetNoTemp = 3, RequestDestInfo.DestGetAll = 4 }
	This enum is mainly for getting dests (either topic or queues) via the Admin.GetQueues(pattern, parameter) or Admin.GetTopics(pattern, parameter) API's, Where the parameter can be one of the following. More...

enum	ZoneType : short { ZoneType.MultiHop = 0, ZoneType.OneHop = 1, ZoneType.Unknown = 2 }
	Enum contains different zone types More...

enum	PolicyType : int { PolicyType.TIBRVQUEUE_DISCARD_NONE = 0, PolicyType.TIBRVQUEUE_DISCARD_FIRST = 2, PolicyType.TIBRVQUEUE_DISCARD_LAST = 3 }
	Defines possible values for discard policy More...

enum	ClientTraceTarget : short { ClientTraceTarget.None = 0, ClientTraceTarget.Stdout = 1, ClientTraceTarget.Stderr = 2 }
	Defines possible values for client tracing More...

enum	ClientTraceFilter : short { ClientTraceFilter.None = 0, ClientTraceFilter.User = 1, ClientTraceFilter.ClientID = 2, ClientTraceFilter.ConnID = 3 }
	Defines possible values for client trace filter, namely, User, ClientID and ConnID. More...

enum	State : short { State.FTStandby = 3, State.Active = 4 }
	Enum that contains values that represent the state of server (i.e standby or active) More...

enum	AuthenticationLocation : int { AuthenticationLocation.ldap = 1, AuthenticationLocation.system = 2, AuthenticationLocation.local = 3, AuthenticationLocation.jaas = 4 }
	Enum that contains values of authentication location currently used by the server. More...

enum	ConfigurationMode : int { ConfigurationMode.Conf = 0, ConfigurationMode.XML = 1, ConfigurationMode.JSON = 1 }
	Enum that contains values of configuration modes the server may be running. More...

enum	SSDeliveryMode : int { SSDeliveryMode.BestEffort = 0, SSDeliveryMode.Some = 1, SSDeliveryMode.All = 2, SSDeliveryMode.Ordered = 3, SSDeliveryMode.Persistent = 4 }
	Enum contains the delivery modes that can be used with SmartSockets transport More...

enum	SSLoadBalanceMode : int { SSLoadBalanceMode.None = 0, SSLoadBalanceMode.RoundRobin = 1, SSLoadBalanceMode.Weighted = 2, SSLoadBalanceMode.Sorted = 3 }
	Enum contains the load balance modes that can be used with SmartSockets transport More...

enum	SSSubscribeMode : int { SSSubscribeMode.Exact = 0, SSSubscribeMode.All = 1 }
	Enum contains the subscribe modes that can be used with SmartSockets transport More...

enum	SSImportSSHeaders : int { SSImportSSHeaders.None = 0, SSImportSSHeaders.type_num = 1, SSImportSSHeaders.All = 2 }
	Enum contains the import SmartSockets header values for SmartSockets transport More...

enum	SSPreserveGMD : int { SSPreserveGMD.Never = 0, SSPreserveGMD.Always = 1, SSPreserveGMD.Receivers = 2 }
	Enum contains the values for preserving failed SmartSockets GMD messages when using SmartSockets Transport More...

enum	CompState : short { CompState.WAIT_FOR_PEER = 0x8, CompState.SYNCHRONIZING = 0x10, CompState.REPLICATING = 0x20, CompState.PAUSED = 0x30, CompState.STANDALONE = 0x40 }
	Flags that complement the state of the server. More...

enum	StateVal : short { StateVal.STANDBY = 0x3, StateVal.ACTIVE = 0x4, StateVal.WAIT_FOR_PEER = CompState.WAIT_FOR_PEER, StateVal.STANDBY_SYNCHRONIZING, StateVal.STANDBY_REPLICATING, StateVal.STANDBY_PAUSED, StateVal.ACTIVE_SYNCHRONIZING, StateVal.ACTIVE_REPLICATING, StateVal.ACTIVE_PAUSED, StateVal.ACTIVE_STANDALONE }
	Enum that contains values that represent the state of the server, to be used in combination with the complementary state flags. Values other than STANDBY and ACTIVE are provided as a convenience that can be used instead of checking against individual flags. More...

enum	TransportType : int { TransportType.All = 0, TransportType.RV = 1, TransportType.RVCM = 2, TransportType.SS = 3, TransportType.FTL = 4 }
	Defines possible values for tranport types More...

enum	DeliveryMode : int { DeliveryMode.NonPersistent = 1, DeliveryMode.Persistent = 2, DeliveryMode.Reliable = 22 }
	Defines possible values of delivery modes More...

Enumeration Type Documentation

enum TIBCO.EMS.ADMIN.AuthenticationLocation : int

Enum that contains values of authentication location currently used by the server.

Enumerator
ldap	Obtain user authentication information from an LDAP directory server.
system	Obtain user authentication information from the UNIX system password file (available only when server is running on a UNIX system).
local	Obtain user authentication information from the local TIBCO Enterprise Message Service server's user configuration.
jaas	Obtain user authentication information from a JAAS module

enum TIBCO.EMS.ADMIN.ClientTraceFilter : short

Defines possible values for client trace filter, namely, User, ClientID and ConnID.

Enumerator
None	No filtering.
User	Only show traced for a given user name.
ClientID	Only show traced for a given client id.
ConnID	Only show traced for a given connection id.

enum TIBCO.EMS.ADMIN.ClientTraceTarget : short

Defines possible values for client tracing

Enumerator
None	No tracing.
Stdout	Tracing directed to stdout.
Stderr	Tracing directed stderr.

enum TIBCO.EMS.ADMIN.CompState : short

Flags that complement the state of the server.

Since EMS 8.1.0

Enumerator
WAIT_FOR_PEER	This flag indicates that the server is currently waiting for its peer to come up (applies to the EMS Appliance only). Since EMS 8.1.0
SYNCHRONIZING	This flag indicates that the server is currently synchronizing data with its peer (applies to a server either in active or standby state, in the EMS Appliance only). Since EMS 8.1.0
REPLICATING	This flag indicates that the server is currently replicating incoming data with its peer (applies to a server either in active or standby state, in the EMS Appliance only). Since EMS 8.1.0
PAUSED	This flag indicates that the server is currently paused, waiting to determine the correct action after the failure of its peer. Since EMS 8.1.0
STANDALONE	This flag indicates that the server is currently running standalone (applies to a server in active state, in the EMS Appliance only). Since EMS 8.1.0

enum TIBCO.EMS.ADMIN.ConfigurationMode : int

Enum that contains values of configuration modes the server may be running.

Enumerator
Conf	Server is using *.conf format configuration files.
XML	Server is using a json or an xml based configuration file (deprecated).
JSON	Server is using a json based configuration file.

enum TIBCO.EMS.ADMIN.DeliveryMode : int

Defines possible values of delivery modes

Enumerator
NonPersistent	NON_PERSISTENT delivery mode.
Persistent	PERSISTENT delivery mode.
Reliable	RELIABLE delivery mode. This is a TIBCO extension.

enum TIBCO.EMS.ADMIN.DestinationType

Enum containing different destination types

Enumerator
All	Type indicating a topic or queue.
Queue	Type indicating a queue.
Topic	Type indicating a topic.

enum TIBCO.EMS.ADMIN.Metric

Defines the possible values for load balanced metric that can be specified for a connection factory or retrieved from a connection factory object.

Enumerator
None	Connection factory is not load balanced.
Connections	Connection factory load balances by generating a connection to the server with the fewest number of connections.
ByteRate	Connection factory load balances by generating a connection to the server with the lowest total byte rate, input and output.

enum TIBCO.EMS.ADMIN.OverflowPolicyType

Enum contains different overflow policy types

Enumerator
Default	Default overflow policy. For queues this means that producers will receive an error if they try to send a message to a queue that has reached either its maxbytes limit or its maxmsgs limit. For topics, if a subscriber has exceeded their maxbytes limit of their maxmsgs limit then new messages will not be delivered to that subscriber but no error will be returned to the sender.
DiscardOld	Policy is to discard old messages. If maxmsgs or maxbytes are exceeded for the queue or a topic's subscriber then when new messages arrive, old messages will be discarded.
RejectIncoming	Policy is to reject new messages. For queues, this behavior is the same as the default. For topics, the sender will receive an error if any of the subscribers for the topics has exceeded either their maxbytes limit or their maxmsgs limit.

enum TIBCO.EMS.ADMIN.PolicyType : int

Defines possible values for discard policy

Enumerator
TIBRVQUEUE_DISCARD_NONE	Never discard events; use this policy when a queue has no limit on the number of events it can contain.
TIBRVQUEUE_DISCARD_FIRST	Discard the first event in the queue (that is, the oldest event in the queue, which would otherwise be the next event to dispatch).
TIBRVQUEUE_DISCARD_LAST	Discard the last event in the queue (that is, the youngest event in the queue).

enum TIBCO.EMS.ADMIN.RequestDestInfo

This enum is mainly for getting dests (either topic or queues) via the Admin.GetQueues(pattern, parameter) or Admin.GetTopics(pattern, parameter) API's, Where the parameter can be one of the following.

Enumerator
DestGetStatic	Request info for static destinations only
DestGetDynamic	Request info for dynamic destinations only
DestGetNoTemp	Request info for nontemporary destinations only
DestGetAll	Request info for all destinations

enum TIBCO.EMS.ADMIN.SSDeliveryMode : int

Enum contains the delivery modes that can be used with SmartSockets transport

Enumerator
BestEffort	SmartSockets BEST_EFFORT delivery mode.
Some	SmartSockets SOME delivery mode.
All	SmartSockets ALL delivery mode.
Ordered	SmartSockets ORDERED delivery mode.
Persistent	SmartSockets PERSISTENT delivery mode.

enum TIBCO.EMS.ADMIN.SSImportSSHeaders : int

Enum contains the import SmartSockets header values for SmartSockets transport

Enumerator
None	The SmartSockets sender is the only header that will be imported.
type_num	The SmartSockets sender and the SmartSockets message type are the only headers that will be imported.
All	All SmartSockets headers will be imported.

enum TIBCO.EMS.ADMIN.SSLoadBalanceMode : int

Enum contains the load balance modes that can be used with SmartSockets transport

Enumerator
None	SmartSockets NONE load balance mode.
RoundRobin	SmartSockets ROUND_ROBIN load balance mode.
Weighted	SmartSockets WEIGHTED load balance mode.
Sorted	SmartSockets SORTED load balance mode.

enum TIBCO.EMS.ADMIN.SSLType : byte

Types indicating whether connection is TLS or not

Enumerator

None

Type indicating that the connection is not a TLS connection.

SSL

Type indicating that the connection is a TLS connection.

TCP

Type indicating that the client uses TLS but connects by way of an external TLS accelerator to one of the server's TCP ports.

Deprecated:: As of release 4.1.

enum TIBCO.EMS.ADMIN.SSPreserveGMD : int

Enum contains the values for preserving failed SmartSockets GMD messages when using SmartSockets Transport

Enumerator
Never	Never preserve failed SmartSockets GMD messages in the EMS undelivered queue.
Always	Always preserve failed SmartSockets GMD messages in the EMS undelivered queue.
Receivers	Only preserve failed SmartSockets GMD messages in the EMS undelivered queue if that GMD message had one or more receivers.

enum TIBCO.EMS.ADMIN.SSSubscribeMode : int

Enum contains the subscribe modes that can be used with SmartSockets transport

Deprecated:: As of release 5.0 subscribe mode is not configurable.

Enumerator
Exact	SmartSockets EXACT subscribe mode.
All	SmartSockets ALL subscribe mode.

enum TIBCO.EMS.ADMIN.State : short

Enum that contains values that represent the state of server (i.e standby or active)

Enumerator
FTStandby	Server is fault tolerant standby
Active	Server is active

enum TIBCO.EMS.ADMIN.StateVal : short

Enum that contains values that represent the state of the server, to be used in combination with the complementary state flags. Values other than STANDBY and ACTIVE are provided as a convenience that can be used instead of checking against individual flags.

Since EMS 8.1.0

Enumerator
STANDBY	This value indicates that the server is currently in standby state. Since EMS 8.1.0
ACTIVE	This value indicates that the server is currently in active state. Since EMS 8.1.0
WAIT_FOR_PEER	This value indicates that the server is currently waiting for its peer to come up. Since EMS 8.1.0
STANDBY_SYNCHRONIZING	This value indicates that the server is currently in standby state and is presently synchronizing data from the active server. Since EMS 8.1.0
STANDBY_REPLICATING	This value indicates that the server is currently in standby state and is presently replicating incoming data from the active server. Since EMS 8.1.0
STANDBY_PAUSED	This value indicates that the server is currently in standby state and is presently determining the correct action in reaction to failure of the active server. Since EMS 8.1.0
ACTIVE_SYNCHRONIZING	This value indicates that the server is currently in active state and is presently synchronizing data to the standby server. Since EMS 8.1.0
ACTIVE_REPLICATING	This value indicates that the server is currently in active state and is presently replicating incoming data to the standby server. Since EMS 8.1.0
ACTIVE_PAUSED	This value indicates that the server is currently in active state and is presently determining the correct action in reaction to failure of the standby server. Since EMS 8.1.0
ACTIVE_STANDALONE	This value indicates that the server is currently in standalone active state. Since EMS 8.1.0

enum TIBCO.EMS.ADMIN.Store

Enum that contains values for store, sync or async

Enumerator
Sync	Syncronous
Async	Asynchronous

enum TIBCO.EMS.ADMIN.TransportType : int

Defines possible values for tranport types

Enumerator
All	Type indicating all types of transport.
RV	Type indicating a TIBCO Rendezvous transport.
RVCM	Type indicating a TIBCO Rendezvous Certified Messaging transport.
SS	Type indicating a TIBCO SmartSockets transport. Deprecated: As of release 8.6
FTL	Type indicating a TIBCO FTL transport.

enum TIBCO.EMS.ADMIN.ZoneType : short

Enum contains different zone types

Enumerator
MultiHop	A m-hop (Multi-Hop) zone is one in which topic messages can be routed across multiple hops and the routes between servers may not form a cycle.
OneHop	A 1-Hop zone is one in which messages can be routed at most 1 hop away. A typical 1-Hop zone is one in which every server has a route to every other server in the zone.
Unknown	A zone of unknown type indicates some kind of error.

Classes

Enumerations

Enumeration Type Documentation