Package COM.activesw.api.client

Interface Summary

Interface	Description
BrokerCallback	This class is implemented by any object which needs to be registered for Information Broker event callbacks.
BrokerConnectionCallback	This class is implemented by any object which needs to be registered for client connection callbacks.
BrokerCPConnectionCallback	This class is implemented by any object which needs to be registered for cluster publisher connection callbacks.
BrokerCPSelectionCallback	This class is implemented by any object which implements a cluster publisher selection callback for cluster operations.
BrokerLockedQueueBrowser
BrokerQueueBrowser
BrokerServerConnectionCallback	This class is implemented by any object which needs to be registered for server client connection callbacks.

Class Summary

Class	Description
BrokerAccessControlList	An access control list (ACL) consists of a list of names of users who should be allowed access, plus a list of names of authenticators which can issue users their identities.
BrokerAdminClient	Representation of an Information Broker administrative client.
BrokerAdminTypeDef	This type is used to represent a type definition as used by admin clients.
BrokerAllQueueStat
BrokerAuthInfo	This class is a data structure used to describe a Broker Client's Authentication info for each session.
BrokerChangeLockInfo	This class is a data structure used to describe the result of acquiring the broker change lock.
BrokerClient	Representation of an Information Broker client.
BrokerClientGroupInfo	This class is a data structure used to describe client group information.
BrokerClientInfo	This class is a data structure used to describe client information.
BrokerClientPoll	This class is a data structure used to describe client poll information.
BrokerClientQueueBrowser	This class provides queue browsing capabilities to view events from client queue.
BrokerClientQueueBrowserInfo	This class holds details of a client queue browser.
BrokerClientSession	This class is a data structure used to describe client sessions.
BrokerClusterGatewayInfo	This class stores configuration information about a cluster gateway
BrokerClusterInfo	This class stores configuration information about a cluster
BrokerClusterPublisher
BrokerCompleteBroker	Holds all of the information describing a broker as far as import and export are concerned.
BrokerCompleteClient	Holds all of the information describing a client as far as import and export are concerned.
BrokerCompleteClientGroup	Holds all of the information describing a client groups as far as import and export are concerned.
BrokerCompleteCollection	This class is used as a container to collect various Broker objects.
BrokerCompleteEventType	Holds all of the information describing an event type as far as import and export are concerned.
BrokerCompleteServer	Holds all of the information describing a server as far as import and export are concerned.
BrokerCompleteTerritory	Holds all of the information describing a broker as far as import and export are concerned.
BrokerCompleteTerritoryGateway	Holds all of the information describing a broker as far as import and export are concerned.
BrokerConnectionDescriptor	This class provides a way to configure the connection which a BrokerClient object uses.
BrokerDate	This class provides a powerful and flexible date/time system for use with the Java client API.
BrokerEvent	Represents an Information Broker event.
BrokerField	This class is a data structure giving a field's type and value.
BrokerFilter
BrokerFilterDescriptor	This class is a data structure used to describe a filter.
BrokerFormat	String formatting functions.
BrokerForwardQueueBrowser	This class provides queue browsing capabilities to view events from remote broker's queue.
BrokerInfo	This class represents the description of a Broker.
BrokerJoinFailureInfo	This class is used to report failures from the BrokerAdminClient.joinTerritory() method.
BrokerLockedClientQueueBrowser	This class provides queue browsing capabilities to view and modify events of a client queue.
BrokerLockedForwardQueueBrowser	This class provides queue browsing capabilities to view and modify events of a client queue.
BrokerLogConfig	A log configuration object.
BrokerLogConfigEntry	This class is a data structure used to describe a log setting.
BrokerMonitorClient	Representation of a Broker Monitor client.
BrokerProcessInfo	This class represents the process information for a Broker.
BrokerQueueBrowserInfo	This class holds details of a queue browser.
BrokerServerClient	Representation of an Broker Server client.
BrokerServerLogEntry	This class is a data structure used to describe server log entry information.
BrokerSetFailureInfo	This class is used to report failures from the BrokerAdminClient.setEventTypesAndClientGroups() method.
BrokerSharedEventTypeInfo	This class stores configuration information about how an event type is shared across a territory gateway
BrokerSharedEventTypeRefuseUpdateInfo	This class stores configuration information about how an event type is shared across a territory gateway
BrokerSSLCertificate	This class represents an SSL certificate.
BrokerSSLConfig	This class is a data structure used to describe a broker's SSL configuration.
BrokerSSLConfigV2	This class is a data structure used to describe a broker's SSL configuration.
BrokerSSLIdentity	This class is a data structure used to describe a broker's SSL identity - distinguished name (DN) and issuer distinguished name (issuer DN).
BrokerSSLStatus	This class is a data structure used to describe a broker's SSL status.
BrokerSubscription	This class is a data structure used to describe a subscription.
BrokerTerritoryGatewayInfo	This class stores configuration information about a territory gateway
BrokerTerritoryInfo	This class stores configuration information about a territory
BrokerTraceEvent	This class is a data structure used to describe trace event.
BrokerTransactionalClient
BrokerTypeCache	This type is used to track broker type definitions
BrokerTypeDef	This type is used to represent a type definition.

Enum Summary

Enum	Description
BrokerSSLConfigV2.CRLType
BrokerSSLConfigV2.KeystoreType
BrokerSSLConfigV2.SSLProtocol
BrokerSSLConfigV2.TruststoreType

Exception Summary

Exception	Description
BrokerBadStateException	This exception is thrown by Information Broker client methods when an API call is made that conflicts with the current system state.
BrokerClientContentionException	This exception is thrown by Information Broker client methods when client contention is detected.
BrokerClientExistsException	This exception is thrown by Information Broker client methods when an attempt is made to create a client and that client's ID is already in use.
BrokerClientGroupExistsException	This exception is thrown by Information Broker client methods when an attempt is made to create a client group and that client group name is already in use.
BrokerClientQueueBrowserException	This exception is thrown by queue browser methods when an operation on a BrokerClientQueueBrowser (including the locked) fails.
BrokerClientQueueLockException	This exception is thrown by Information Broker client methods when the specified operation cannot be affected as the BrokerClient is determined to be locked for queue browser operations.
BrokerClusterPublisherException	This exception is thrown by BrokerClusterPublisher methods when an error occurs while invoking methods on BrokerClusterPublisher object.
BrokerCommFailureException	This exception is thrown by Information Broker client methods when a network communications failure occurs.
BrokerConnectionClosedException	This exception is thrown by Information Broker client methods when an action is attempted on a BrokerClient which has been disconnected from the broker previously or was disconnected during the operation.
BrokerCorruptDataException	This exception is thrown by Information Broker client methods when internal data is discovered to be corrupt
BrokerDependencyException	This exception is thrown by Information Broker client methods when an opperation cannot be completed due to a dependency.
BrokerException	This class is the base exception type for all exception thrown by Information Broker client classes.
BrokerExistsException	This exception is thrown by Information Broker client methods when an attempt is made to create a broker and that broker's name is already in use.
BrokerFailureException	This exception is thrown by Information Broker client methods when an internal failure happens when communicating with the broker.
BrokerFieldNotFoundException	This exception is thrown by Information Broker client methods when an application tries to get or set a non-existant field in an event.
BrokerFieldTypeMismatchException	This exception is thrown by Information Broker client methods when a field is accessed as a type other than what it really is.
BrokerFileNotFoundException	This exception is thrown by Information Broker client methods when an application tries to access a non-existant file.
BrokerFilterParseException	This exception is thrown by Information Broker client methods when an error occurs during the parsing of a filter string.
BrokerFilterRuntimeException	This exception is thrown by Information Broker client methods when an error occurs during a filter match.
BrokerFormatException	This exception is thrown by Information Broker client methods when an internal formating error is detected.
BrokerHostNotFoundException	This exception is thrown by Information Broker client methods when a host is not found.
BrokerIncompatibleVersionException	This exception is thrown by Information Broker client methods when the broker is running which is incompatible with the client class version being used.
BrokerInputParseException	This exception is thrown by the ADL parser when the import file contents are invalid in some way.
BrokerInTerritoryException	This exception is thrown by Information Broker client methods when a territory join or create operation is performed on a broker that is already in a territory.
BrokerInterruptedException	This exception is thrown by Information Broker client methods when an interruption occurs.
BrokerInvalidAccessListException	This exception is thrown by Information Broker client methods when the access list specified to a call is not valid.
BrokerInvalidAcknowledgementException	This exception is thrown by Information Broker client methods when an acknowledgement is determined to be invalid.
BrokerInvalidBrokerNameException	This exception is thrown by Information Broker client methods when the client group name specified to a call is not valid.
BrokerInvalidClientException	This exception is thrown by Information Broker client methods when a BrokerClient is determined to be invalid because it has already been disconnected or destroyed.
BrokerInvalidClientGroupNameException	This exception is thrown by Information Broker client methods when the client group name specified to a call is not valid.
BrokerInvalidClientIdException	This exception is thrown by Information Broker client methods when the client ID specified to a call is not valid.
BrokerInvalidEventException	This exception is thrown by Information Broker client methods when an attempt is made to publish an event that is not properly formed.
BrokerInvalidEventTypeNameException	This exception is thrown by Information Broker client methods when an invalid event type name is used.
BrokerInvalidFieldNameException	This exception is thrown by Information Broker client methods when an invalid field name is used.
BrokerInvalidLicenseException	This exception is thrown by Information Broker client methods when the license string specified to a call is not valid.
BrokerInvalidLogConfigException	This exception is thrown by Information Broker client methods when the log configuration specified to a call is not valid.
BrokerInvalidNameException	This exception is thrown by Information Broker client methods when a name specified to a call is not valid.
BrokerInvalidPlatformKeyException	This exception is thrown by Information Broker client methods when the platform key specified to a call is not valid.
BrokerInvalidPortException	This exception is thrown by Information Broker client methods when the port specified to a call is not valid.
BrokerInvalidSubscriptionException	This exception is thrown by Information Broker client methods when a subscription contains an invalid event type name or subscription ID.
BrokerInvalidTerritoryNameException	This exception is thrown by Information Broker client methods when the client group name specified to a call is not valid.
BrokerInvalidTxException	This exception is thrown by Information Broker client methods when a name is specified which does not exist in the resource being accessed.
BrokerInvalidTypeCacheException	This exception is thrown by Information Broker client methods when an internal type caching failure occurs.
BrokerInvalidTypeDefException	This exception is thrown by Information Broker client methods when using a type definition from a client that is no longer connected to the broker or after the type cache has been flushed.
BrokerInvalidTypeException	This exception is thrown by Information Broker client methods when a type is used which is not supported by the client classes.
BrokerNoPermissionException	This exception is thrown by Information Broker client methods when access permission is denied for the operation.
BrokerNotImplementedException	This exception is thrown by Information Broker client methods when the requested operation is not available.
BrokerNotInClusterException	This exception is thrown by Information Broker client methods when a cluster operation is performed on a broker that is not in a cluster.
BrokerNotInTerritoryException	This exception is thrown by Information Broker client methods when a territory operation is performed on a broker that is not in a territory.
BrokerNotRunningException	This exception is thrown by Information Broker client methods when the host is available but no broker is running on that host.
BrokerNullParameterException	This exception is thrown by Information Broker client methods when a paramter value is null.
BrokerOutOfRangeException	This exception is thrown by Information Broker client methods when an out of range value is encountered.
BrokerProtocolException	This exception is thrown by Information Broker client methods when an internal protocol failure occurs.
BrokerPublishPauseException	This exception is thrown by Information Broker client methods when an internal failure happens when communicating with the broker.
BrokerQueueBrowserException	This exception is thrown by queue browser methods when an operation on a BrokerQueueBrowser (including the locked) fails.
BrokerSecurityException	This exception is thrown by Information Broker client methods when an error occurs with the security system.
BrokerSSLConfigException
BrokerSubscriptionExistsException	This exception is thrown by Information Broker client methods when an attempt is made to open a subscription which is the same as another existing subscription.
BrokerTimeoutException	This exception is thrown by Information Broker client methods when the operation times out.
BrokerTxClosedException	This exception is thrown by Information Broker client methods when an action is attempted on a BrokerClient transaction which has been either committed or aborted.
BrokerUnknownBrokerNameException	This exception is thrown by Information Broker client methods when a broker name is specified that does not exist on the host.
BrokerUnknownClientGroupException	This exception is thrown by Information Broker client methods when a client group name is specified that is not defined in the broker.
BrokerUnknownClientIdException	This exception is thrown by Information Broker client methods when a client ID is specified which does not exist in the broker.
BrokerUnknownClusterException	This exception is thrown by Information Broker client methods when a Cluster name is specified that does not exist on the Broker.
BrokerUnknownEventTypeException	This exception is thrown by Information Broker client methods when an event type name is specified which does not exist in the broker.
BrokerUnknownInfosetException	This exception is thrown by Information Broker client methods when an infoset name is specified which does not exist on the event type definition in the broker.
BrokerUnknownKeyException	This exception is thrown by Information Broker client methods when a platform key is specified which is not in the platform information.
BrokerUnknownNameException	This exception is thrown by Information Broker client methods when a name is specified which does not exist in the resource being accessed.
BrokerUnknownServerException	This exception is thrown by Broker Monitor methods when the server specified to a call does not exist.
BrokerUnknownSessionIdException	This exception is thrown by Information Broker client methods when the session ID specified to a call is not valid.
BrokerUnknownTerritoryException	This exception is thrown by Information Broker client methods when a broker name is specified that does not exist on the host.