Class Hierarchy All Classes All Fields and Methods

Interface com.ibm.broker.config.proxy.AdministeredObjectListener

public interface AdministeredObjectListener
extends ListenerParent

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

The AdministeredObjectListener interface is a powerful way of ensuring that Configuration Manager Proxy applications work with up-to-date information and that any requests that these applications make to modify domain objects are processed successfully. The real benefits of using this interface come from the asynchronous and multi-user design of the Configuration Manager:

In order to receive notifications, Configuration Manager Proxy applications must first register an instance of a class that implements this interface 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);
 

...where MyAdministeredObjectListener is a class that implements the AdministeredObjectListener interface, written by the Configuration Manager Proxy application developer.

AdministeredObjectListener notifications occur on a dedicated Java thread.

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

Responsibilities States that the implementing class is able to receive notifications from the Configuration 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 Index
Method Description
void processActionResponse(AdministeredObject, CompletionCodeType, List, Properties) States that the Configuration Manager has processed a request that previously originated from the current connection to the Configuration Manager.
void processDelete(AdministeredObject) States that the supplied AdministeredObject has been deleted on the Configuration Manager.
void processModify(AdministeredObject, List, List, List) States that the supplied AdministeredObject has been modified by the current or another application.

Methods

processActionResponse

public void processActionResponse(AdministeredObject affectedObject,
                                  CompletionCodeType ccType,
                                  List bipMessages,
                                  Properties referenceProperties) 

States that the Configuration Manager has processed a request that previously originated from the current connection to the Configuration Manager. The parameters of this method call indicate the result of the command that was sent, and the original command for reference.

processDelete

public void processDelete(AdministeredObject deletedObject) 

States that the supplied AdministeredObject has been deleted on the Configuration Manager.

processModify

public void processModify(AdministeredObject affectedObject,
                          List changedAttributes,
                          List newChildren,
                          List removedChildren) 

States that the supplied AdministeredObject has been modified by the current or another application.

Class Hierarchy All Classes All Fields and Methods