com.ibm.broker.config.proxy (IBM Integration Bus API)

Interface Summary
Interface	Description
AdministeredObjectListener	Classes that implement this interface are stating that they can receive change notifications from the broker.
AdvancedAdministeredObjectListener	User-written classes that extend this class are stating that they can receive notifications from the broker that contain more information than is provided by the basic AdministeredObjectListener interface.
AttributeConstants	This is a common set of strings used by the IBM Integration API (CMP) to describe attributes of broker objects.
BrokerConnectionParameters	In order to connect to brokers, applications must pass objects that implement this interface to the BrokerProxy.getInstance() method.
ConfigManagerConnectionParameters	Deprecated It is recommended that applications use implementors of BrokerConnectionParameters in order to connect to brokers.
DeployableObject	Each instance of a class that implements this interface represents a file that can be deployed.
DeployedObject	Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.
ServiceInterface	Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.

Class Summary
Class	Description
AccessControlEntry	Deprecated This class is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
AccessControlEntryPermission	Deprecated This class is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
AccessControlEntryPrincipalType	Deprecated This class is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
ActivityLogEntry	The ActivityLogEntry class represents an entry in a broker activity log.
ActivityLogProxy	The ActivityLogProxy represents the set of activity log entries for broker objects.
AdministeredObject	This is the abstract superclass from which most representations of broker objects inherit.
AdminQueueEntry	The AdminQueueEntry class represents an entry in the brokers administration work queue.
AdminQueueProxy	The AdminQueueProxy represents the set of administration queue entries for the broker.
ApplicationProxy	Each application deployed to an execution group can be represented by an ApplicationProxy.
BarEntry	Represents a file contained within a broker archive that can be deployed to an execution group.
BarFile	Represents a broker archive file on the local filesystem.
BrokerProxy	Each BrokerProxy instance represents a broker and all of its configuration and operational state.
BrokerProxy.MulticastParameterSet	Deprecated This class is no longer used as of WebSphere Message Broker V7.
CollectiveProxy	Deprecated With the removal of collectives, this class is no longer relevant.
CompletionCodeType	The CompletionCodeType type is used to describe the outcome of the operation that has been performed.
ConfigManagerProxy	Deprecated It is recommended to use the BrokerProxy class to interact with brokers.
ConfigurableService	Describes a configurable service definition on a broker.
ConfigurationObjectType	The ConfigurationObjectType type is used to describe the types of various objects managed by the broker.
DataCaptureEntry	The DataCaptureEntry class represents a data point that has previously been recorded by an execution group.
DataCaptureProxy	When the broker has been configured to record data passing through it for subsequent view, edit and replay, the DataCaptureProxy object can be used to retrieve information related to the recorded data.
DeployedObjectGroupProxy	This is the abstract superclass from which groups of deployed objects inherit.
DeploymentDescriptor	Represents a deployment descriptor.
DeployResult	Each DeployResult instance is used to describe the outcome of a BAR file deployment through the ExecutionGroupProxy.deploy() methods.
ExecutionGroupProxy	Each execution group associated with a broker can be represented by an ExecutionGroupProxy.
LibraryProxy	Each library deployed to an execution group or application can be represented by a LibraryProxy.
LocalBrokerConnectionParameters	Provides the connection parameters to a locally defined broker.
LocalBrokerUtilities	A collection of static utilities for querying and configuring local brokers and Message Broker runtime installations.
LogEntry	The LogEntry class represents an entry in the broker message log table.
LogProxy	The LogProxy represents the set of administration log entries for the broker.
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.
MQBrokerConnectionParameters	Provides the connection parameters to a remote broker by directly specifying its WebSphere MQ-based connection parameters.
MQConfigManagerConnectionParameters	Deprecated It is recommended that applications use implementors of BrokerConnectionParameters in order to connect to brokers.
MQPropertyFileBrokerConnectionParameters	Provides the connection parameters to a remote broker by reading a .broker properties file that contains the hostname, queue manager, port and security exit information.
MQPropertyFileConfigManagerConnectionParameters	Deprecated It is recommended to use the MQPropertyFileBrokerConnectionParameters class to hold the connection parameters for brokers.
MQSubscription	Deprecated Use WebSphere MQ to manage subscriptions.
OperationType	The OperationType type is used to describe the type of a request to a broker.
PolicyManagerProxy	Each PolicyManagerProxy instance represents a set of policies of a given type.
PolicyProxy	Each PolicyProxy instance represents a policy and all the data defined by that policy.
ResourceManagerProxy	Each ResourceManagerProxy instance represents a component of the execution group that is responsible for interacting with a specific protocol or endpoint type.
RuntimePropertyConstants	Deprecated The RuntimePropertyConstants class has been merged with the AttributeConstants interface.
ServiceFederationManagerProxy	Deprecated
ServiceGroupProxyItem	Deprecated
ServiceOperation	Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.
ServiceProxyItem	Deprecated
Subscription	Deprecated Use WebSphere MQ to manage subscriptions.
SubscriptionParameters	Deprecated Use WebSphere MQ v7 or later to manage subscriptions.
SubscriptionParameters.MQ	Deprecated Use WebSphere MQ to manage subscriptions.
SubscriptionQuery	Deprecated Use WebSphere MQ to manage subscriptions.
SubscriptionsProxy	Deprecated Use WebSphere MQ to manage subscriptions.
TopicProxy	Deprecated Use WebSphere MQ to manage topics.
TopicProxy.Policy	Deprecated As of Websphere Message Broker V7 this class should no longer be used.
TopicProxy.QoP	Deprecated As of Websphere Message Broker V7 this class should no longer be used.
TopicRootProxy	Deprecated Use WebSphere MQ to manage topics.
TopologyProxy	Deprecated Use the BrokerProxy class to access brokers, and use WebSphere MQ to manage publish/subscribe networks.
TopologyProxy.Connection	Deprecated This method is not used as of WebSphere Message Broker V7.
WebAdminProxy	This object is for Web Administration.
WebUserProxy	This object represents a user account for Web Administration.
WLMPolicyProxy	Each WLMPolicyProxy instance represents a Workload management policy and all the data defined by that policy.

Enum Summary
Enum	Description
AttributeConstants.HAStatus	An enumeration of the states of a multi-instance broker that has been configured for high availabilty support.
BrokerProxy.PolicyType	Enumerates the possible types of policy that can be used when retrieving the defined policy sets from the broker.
BrokerProxy.StopMode	Enum for stoping message flows
BrokerProxy.SyncType	Deprecated This property is specific to previous versions of WebSphere Message Broker and is not used as of V7.
WLMPolicyProxy.ProcessingTimeoutAction

Exception Summary
Exception	Description
ConfigManagerProxyException	Abstract base class for all exceptions originating on the IBM Integration API (CMP).
ConfigManagerProxyIncompatibilityException	Deprecated As of WebSphere Message Broker V7 this exception cannot be thrown, as the IBM Integration API (CMP) is unable to communicate with environments of V6.1 and earlier.
ConfigManagerProxyLoggedException	This exception is used to describe a general problem with the IBM Integration API (CMP), 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 broker.
ConfigManagerProxyRequestFailureException	An exception which states that the broker rejected a request to change its configuration.
ConfigManagerProxyRequestTimeoutException	An exception which states that the broker did not respond to a request to change its configuration before a timeout occurred.

Package com.ibm.broker.config.proxy Description

Reference documentation for the IBM Integration API.

Note: There are two versions of this Java Documentation:

Javadoc that includes deprecated classes and methods can be found in the InfoCenter version of the Javadoc reference information. If you are migrating Configuration Manager Proxy applications you might like to use this version.
For new applications, Javadoc with deprecated classes and methods removed is part of the installation package for the IBM Integration Bus runtime. On Windows platforms, this version of the Java documentation is accessible from the Start Menu.

This is the reference documentation for the IBM Integration API, also known as the "CMP". It allows user-written applications to configure, view and operate instances of a broker runtime. Tasks that can be performed using this interface include:

viewing and modifying the broker's configuration
creating, modifying and deleting execution groups and their properties
starting and stopping message flows
reading, modifying and deploying broker archive files, deployment descriptors and broker configuration
viewing the broker's deployment log

A good starting point for reference information is the BrokerProxy class, as this class provides the ability to connect to brokers. After successfully completing the following statement in the following code snippet, b represents an active connection to a locally-defined broker called "MYBROKER". With this object, it is possible to view and manipulate the broker, its execution groups and its deployed objects.

   BrokerProxy b = BrokerProxy.getLocalInstance("MYBROKER");

It is also possible to use the API to connect to brokers that have been defined on other machines.

In order to build and run applications that use the IBM Integration API (CMP), the CLASSPATH environment variable needs to contain instdir/classes/ConfigManagerProxy.jar, whereinstdir is the installation directory for the WebSphere Message Broker runtime.

Additionally, the WebSphere MQ Classes for Java need to be configured in the environment, as this provides the IBM Integration API (CMP) with its network connectivity to brokers. For example, the CLASSPATH needs to contain mqinstdir/java/com.ibm.mq.jar, com.ibm.mq.jmqi.jar and connector.jar. Also, the PATH (on Windows) or LD_LIBRARY_PATH (on Linux/UNIX platforms) needs to contain mqinstdir/java/lib, where mqinstdir is the installation directory for WebSphere MQ. Consult the WebSphere MQ Information Center for more information.

Use this documentation in conjunction with the IBM Integration API (CMP) Exerciser sample, as this will allow you to most easily discover the capabilities of the interface.