WBI BrokersTM
Config Manager Proxy API

com.ibm.broker.config.proxy
Interface AdministeredObjectListener

All Superinterfaces:
com.ibm.broker.config.proxy.ListenerParent

public interface AdministeredObjectListener
extends com.ibm.broker.config.proxy.ListenerParent

User-written classes that implement this interface are stating that they can receive notifications from the Config Manager Proxy. Notifications are sent whenever objects for which the listener is registered is modified, deleted, or whenever a previously submitted request is processed.

In order to receive notifications, applications must first register their listener with each administered object for which they wish to receive notifications. Here is an example of how to do this:

     ConfigManagerConnectionParameters cmcp =
         MQConfigManagerConnectionParameters("localhost", 1414, "QMGR");
     ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp);
     TopologyProxy t = cmp.getTopology();
     
     AdministeredObjectListener l = new MyAdministeredObjectListener();
     t.registerListener(l);
 

interface com.ibm.broker.config.proxy.AdministeredObjectListener

Responsibilities States that the implementing class is able to receive notifications from the Config Manager Proxy.
Internal Collaborators com.ibm.broker.config.proxy.CompletionCodeType
com.ibm.broker.config.proxy.AdministeredObject

 Change Activity:
 ---------- ----------- -------------  -------------------------------
 Reason:    Date:       Originator:    Comments:
 ---------- ----------- -------------  -------------------------------
 25103.1    2004-03-29  HDMPL          v6 Release

 


Method Summary
 void processActionResponse(AdministeredObject affectedObject, CompletionCodeType ccType, List bipMessages, Properties referenceProperties)
          States that the Config Manager has processed a request that previously originated from the current connection to the Config Manager.
 void processDelete(AdministeredObject deletedObject)
          States the the supplied Config Manager Administered Object has been deleted on the server.
 void processModify(AdministeredObject affectedObject, List changedAttributes, List newChildren, List removedChildren)
          States that the supplied Config Manager Administered Object has been modified by the current or another application.
 

Method Detail

processModify

public void processModify(AdministeredObject affectedObject,
                          List changedAttributes,
                          List newChildren,
                          List removedChildren)
States that the supplied Config Manager Administered Object has been modified by the current or another application.

Parameters:
affectedObject - The object which has changed. The attributes of the object will already have been updated to contain the new information.
changedAttributes - An unmodifiable list of Strings containing the attribute key names that have changed.
newChildren - An unmodifiable list of Strings containing the object's subcomponents that were added by the latest change. Each entry is of the form "componenttype+UUID" such as "Broker+123-123-123". A list of valid component types can be found in the typedef-enumeration com.ibm.broker.config.proxy.ConfigurationObjectType.
removedChildren - An unmodifiable list of Strings containing the object's subcomponents that were removed by the latest change. Same format as the newChildren List.

processDelete

public void processDelete(AdministeredObject deletedObject)
States the the supplied Config Manager Administered Object has been deleted on the server.

Parameters:
deletedObject - AdministeredObject which has been deleted.

processActionResponse

public void processActionResponse(AdministeredObject affectedObject,
                                  CompletionCodeType ccType,
                                  List bipMessages,
                                  Properties referenceProperties)
States that the Config Manager has processed a request that previously originated from the current connection to the Config Manager. The parameters of this method call indicate the result of the command that was sent, and the original command for reference.

Parameters:
affectedObject - The object on which a command was attempted.
ccType - The overall completion code of the action
bipMessages - an unmodifiable list of com.ibm.broker.config.proxy.LogEntry classes that contains any localized BIP Messages associated with the action.
referenceProperties - Properties of the Request that caused this Action Response.

WBI BrokersTM
Config Manager Proxy API