|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
AdministeredObjectListener | User-written classes that implement this interface are stating that they can receive notifications from the Config Manager Proxy. |
AdvancedAdministeredObjectListener | User-written classes that extend this class are stating that they can receive notifications from the Config Manager Proxy that contain more information than is provided by the basic AdministeredObjectListener interface. |
AttributeConstants | This is a common set of strings used by the Config Manager Proxy to describe attributes of objects in the Configuration Manager's domain. |
ConfigManagerConnectionParameters | Config Manager Proxy applications must pass objects that implement this interface to the ConfigManagerProxy.getInstance() method, which enables them to connect to Configuration Managers. |
DeployedObject | Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group. |
Class Summary | |
---|---|
AccessControlEntry | A small class to represent an Access Control Entry Contains a principal name, principal type (user or group) and permission |
AccessControlEntryPermission | Defines a set of abilities over which security can be applied. |
AccessControlEntryPrincipalType | Defines a set of principal types over which security can be applied. |
AdministeredObject | This is the abstract superclass from which all Proxy-type objects inherit. |
BrokerProxy | Each broker within the Config Manager's domain can be represented by a BrokerProxy. |
BrokerProxy.MulticastParameterSet | A small data structure that represents the set of parameters required to enable multicast on this broker. |
CollectiveProxy | Represents a totally connected set of pub/sub brokers. |
CompletionCodeType | The CompletionCodeType type is used to describe the outcome of the operation that has been performed. |
ConfigManagerProxy | This class allows applications to connect to and manipulate Configuration Managers. |
ConfigurationObjectType | The ConfigurationObjectType type is used to describe the types of various objects managed by the Configuration Manager. |
DeployResult | The DeployResult type is used to describe the outcome of deployment operations. |
ExecutionGroupProxy | Each execution group associated with a broker can be represented by an ExecutionGroupProxy. |
LogEntry | The LogEntry class represents an entry in the broker message log table. |
LogProxy | The LogProxy represents the selection of broker log entries for the current user. |
MessageFlowDependency | Represents an object deployed to an execution group that is required in order for it to process message flow logic. |
MessageFlowProxy | Represents a message flow that has been deployed to an execution group. |
MessageFlowProxy.UserTrace | A small structure that represents all the possible types of user trace. |
MQConfigManagerConnectionParameters | Allows user-written Config Manager Proxy applications to specify a set of connection parameters that can be used to connect to MQ-based Configuration Managers. |
MQPropertyFileConfigManagerConnectionParameters | Provides the connection parameters to a Configuration Manager by reading a properties file that contains the hostname, queue manager, port and security exit information. |
OperationType | The OperationType type is used to describe the outcome of a Configuration Manager request that has been processed. |
Subscription | Each Subscription object represents a single topic subscription on a broker. |
SubscriptionsProxy | Represents a query of the Configuration Manager's broker subscriptions table, and the results. |
TopicProxy | Represents a node in the topic hierarchy. |
TopicProxy.Policy | A small class that represents a policy for a given topic. |
TopicProxy.QoP | A small structure that represents all the possible types of a topic's quality of protection. |
TopicRootProxy | Represents the root of the topic hierarchy. |
TopologyProxy | There is exactly one Topology associated with each Config Manager, and this is referenced by the TopologyProxy object. |
TopologyProxy.Connection | A small data structure representing a connection between two brokers in the topology. |
Exception Summary | |
---|---|
ConfigManagerProxyException | Abstract base class for all exceptions originating on the ConfigManagerProxy. |
ConfigManagerProxyIncompatibilityException | This exception is thrown after an incompatibility between versions of the Configuration Manager and the connected Config Manager Proxy is detected. |
ConfigManagerProxyLoggedException | This exception is used to describe a general problem with the Config Manager Proxy, as a result of an internal error or a misuse of the API. |
ConfigManagerProxyLoggedMQException | This class is used to describe exceptions due to problems flagged by the WebSphere MQ Classes for Java. |
ConfigManagerProxyPropertyNotInitializedException | This exception type represents the condition when an application attempts to get a property of an AdministeredObject, but the property has not yet been set to a value by the Config Manager. |
The com.ibm.broker.config.proxy package gives user-written applications programmatic control of broker domains by providing a remote interface to Configuration Managers. It gives applications complete access to Configuration Manager function:
ConfigManagerConnectionParameters cmcp = new MQConfigManagerConnectionParameters("localhost", 1414, "QMGR1"); ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp);After successfully completing the second statement, cmp represents an active connection to a Configuration Manager. With this object, if is possible to view and manipulate the pub/sub topology, topic tree, broker log, subscriptions and (indirectly) brokers, execution groups and other domain objects.
In order to build and run Config Manager Proxy applications, the following JARs and directories need to be available on the CLASSPATH:
|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |