See: Description
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 | 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.
|
Checkpoint |
The Checkpoint class represents a point during flow execution where a
set of message data that has been
recorded by the integration server when test record mode is enabled.
|
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.
|
EventManagerProxy |
This object is for Event definition Administration.
|
EventProxy |
This object represents an event definition.
|
ExecutionGroupProxy |
Each Integration server associated with a broker can be represented
by an ExecutionGroupProxy.
|
FlowProxy |
This is the superclass from which message flows and subflows inherit.
|
IIBCommandSocket | |
InputTestData |
The TestData class represents a single set of message data that has been
recorded by the integration server when test record mode is enabled.
|
IntegrationNodeConnectionParameters |
Provides the connection parameters to a remote integration node by directly
specifying its IP connection parameters.
|
JettyLogger | |
LatestBrokerInstallLocation | |
LibraryProxy |
As of Integration Bus V10, libraries have been renamed to static libraries.
|
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.
|
LocalCMPReceiver | |
LocalCMPSender | |
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 integration server.
|
MessageFlowProxy.UserTrace |
A small structure that represents all the possible types of
user trace.
|
MQBrokerConnectionParameters | Deprecated
As of IBM Integration Bus v10, replaced by
IntegrationNodeConnectionParameters |
MQConfigManagerConnectionParameters | Deprecated
As of IBM Integration Bus v10, replaced by
IntegrationNodeConnectionParameters |
MQPropertyFileBrokerConnectionParameters | Deprecated
As of IBM Integration Bus v10, replaced by
IntegrationNodeConnectionParameters |
MQPropertyFileConfigManagerConnectionParameters | Deprecated
As of IBM Integration Bus v10, replaced by
IntegrationNodeConnectionParameters |
MQSubscription | Deprecated
Use WebSphere MQ to manage subscriptions.
|
OperationType |
The OperationType type is used to describe the type
of a request to a broker.
|
PipedBrokerConnectionParameters |
Provides the connection parameters to a locally defined broker.
|
PolicyManagementProxy |
The PolicyManagementProxy provides access to PolicyManagerProxy objects of different types.
|
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.
|
RecordedTestData |
The CaptureTestData class represents a single set of data that has been
recorded by the execution group when test record mode is enabled.
|
ResourceManagerProxy |
Each ResourceManagerProxy instance represents a component of the
execution group that is responsible for interacting with a specific protocol
or endpoint type.
|
RestApiProxy |
Each REST API deployed to an execution group can be represented
by an RestApiProxy.
|
RuntimePropertyConstants | Deprecated
The RuntimePropertyConstants class has been merged with
the AttributeConstants interface.
|
SecurityIdentity |
Each instance of this class represents a security identity defined against
an integration node or integration server by using the mqsisetdbparms command.
|
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 |
SharedLibraryProxy |
Each shared library deployed to an execution group can be represented
by a SharedLibraryProxy.
|
SharedLibraryReference |
Each instance of this class represents a reference from an application, integration
service or shared library to a specified shared library.
|
StaticLibraryProxy |
Each static library deployed to an execution group can be represented
by a StaticLibraryProxy.
|
SubFlowProxy |
Represents a subflow that has been deployed to an execution group.
|
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.
|
TestData |
The TestData class represents a single set of message data that has been
recorded by the integration server when test record mode is enabled.
|
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.
|
TraceProxy | |
WebAdminProxy |
This object is for Web Administration.
|
WebSocketClientManager | |
WebSocketReceiver | |
WebSocketSender | |
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 | 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.
|
SecurityIdentity.Type |
The type of the security identity, for example ODBC, JMS, IMS, etc.
|
WLMPolicyProxy.ProcessingTimeoutAction |
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.
|
ConfigManagerProxyLoggedSocketException |
This class is used to describe exceptions due to problems flagged by
the web sockets.
|
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.
|
ConfigManagerProxySecurityException |
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.
|
This is the reference documentation for the IBM Integration API, previously 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:
BrokerProxy b = BrokerProxy.getLocalInstance("MYBROKER");It is also possible to use the API to connect to brokers that have been defined on other machines by using a TCP/IP connection to the remote broker.
In order to build and run applications that use the IBM Integration API (CMP), the CLASSPATH environment variable needs to contain instdir/common/classes/IntegrationAPI.jar, whereinstdir is the installation directory for IBM Integration Bus.
Additionally you need to ensure that the following are included in your CLASSPATH: instdir/server/jetty/lib/jetty-io.jar, instdir/server/jetty/lib/jetty-util.jar, instdir/server/jetty/lib/websocket-api.jar, instdir/server/jetty/lib/websocket-client.jar, instdir/server/jetty/lib/websocket-common.jar.
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.