Class Hierarchy All Classes All Fields and Methods

Interface com.ibm.broker.config.proxy.AdvancedAdministeredObjectListener

public interface AdvancedAdministeredObjectListener
extends ListenerParent

User-written classes that extend this class are stating that they can receive notifications from the Configuration Manager Proxy that contain more information than is provided by the basic AdministeredObjectListener interface.

Most user applications will not require the information provided by this advanced listener, and should implement the AdministeredObjectListener interface instead.

The extra information provided by this advanced interface is as follows:

  • Advanced processActionResponse() notifications include parameters to correlate batches of requests sent using ConfigManagerProxy.sendUpdates(). Notifications include any correlation identifier that was passed during the sendUpdates() call, and also a boolean to describe whether any further responses can be expected for the current batch.
  • Advanced processModify() notifications include parameters that suggest to the listener whether another notification is imminent. Listeners may choose to make use of this information if they can improve performance by holding off starting a task as a result (for example, choosing to not refresh the screen until all updates are received).
  • Advanced processDelete() notifications also include parameters that suggest to the listener whether another notification is imminent.
  • Advanced listeners can also elect to receive an immediate processModify() notification as soon as the listener is first registered.

    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();
         Object obj = new Object();
     
         AdvancedAdministeredObjectListener l =
             new MyAdvancedAdministeredObjectListener();
         t.registerListener(l, true, obj);
     

    Classes that implement both the AdministeredObjectListener interface and the AdvancedAdministeredObjectListener interface will always receive advanced notifications, regardless of the registerListener() variant that is called.

    interface com.ibm.broker.config.proxy.AdvancedAdministeredObjectListener

    Responsibilities States that the extending class is able to receive notifications from the Configuration Manager Proxy. Classes extending AdvancedAdministeredObjectListener wish to receive extra information from the Configuration Manager Proxy.
    Internal Collaborators None

    
     Change Activity:
     ---------- ----------- -------------  -------------------------------
     Reason:    Date:       Originator:    Comments:
     ---------- ----------- -------------  -------------------------------
     25103.3    2004-06-30  HDMPL          v6 Release
    
     

    Method Index
    Method Description
    void processActionResponse(AdministeredObject, CompletionCodeType, List, Properties, int, boolean) States that the Configuration Manager has processed a request that previously originated from the current connection to the Configuration Manager.
    void processDelete(AdministeredObject, long) States that the supplied AdministeredObject has been deleted on the Configuration Manager.
    void processModify(AdministeredObject, List, List, List, long) States that the supplied Configuration Manager Administered Object has been modified by the current or another application.

    Methods

    processActionResponse

    public void processActionResponse(AdministeredObject affectedObject,
                                      CompletionCodeType ccType,
                                      List bipMessages,
                                      Properties referenceProperties,
                                      int batchCorrelationID,
                                      boolean lastActionResponseInBatch) 

    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,
                              long timeTillNextNotificationMs) 

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

    processModify

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

    States that the supplied Configuration Manager Administered Object has been modified by the current or another application.

    Class Hierarchy All Classes All Fields and Methods