com.ibm.wsspi.wim.pluginmanager

Interface NotificationSubscriber

  • All Superinterfaces:
    Subscriber


    public interface NotificationSubscriber
    extends Subscriber
    The notification-type subscriber allows developers to write exit function which doesn't make any modifications to the DataGraph that is being sent into the topic-emitter on which the subscriber is listening in.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT_NOTICE 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void postExitCall(java.lang.String emitter, DataObject daisyChainDGRootDO, DataObject adapterDGRootDO)
      Function call is called at the end of a Topic-Emitter and allows the NotificationSubscriber to execute its PostExit code.
      void preExitCall(java.lang.String emitter, DataObject pristineDGRootDO)
      This function is called at the beginning of a Topic-Emitter and allows the NotificationSubscriber to execute its PreExit code.
    • Method Detail

      • preExitCall

        void preExitCall(java.lang.String emitter,
                       DataObject pristineDGRootDO)
                         throws SubscriberException
        This function is called at the beginning of a Topic-Emitter and allows the NotificationSubscriber to execute its PreExit code. A call to this method is made to tell the subscriber that the emitter method is beginning execution, and to give the notification subscriber the input datagraph to that method.
        Parameters:
        emitter - The topic-emitter name on which the subscriber is listening on
        pristineDGRootDO - Root The DataObject which has the information passed from API. This DataObject will be unchanged from the call to the API.
        Throws:
        SubscriberException
      • postExitCall

        void postExitCall(java.lang.String emitter,
                        DataObject daisyChainDGRootDO,
                        DataObject adapterDGRootDO)
                          throws SubscriberException
        Function call is called at the end of a Topic-Emitter and allows the NotificationSubscriber to execute its PostExit code. A call to this method is made to tell the subscriber that the emitter method is ending execution, and to give the notification subscriber the datagraph (as may have been changed by the modification subscribers) and the datagraph as returned by the adapter.
        Parameters:
        emitter - The topic-emitter name on which the subscriber is listening on
        daisyChainDGRootDO - Root The DataObject which has the information passed from API which might have been modified by other subscribers
        adapterDGRootDO - Root The DataObject returned by the adapter
        Throws:
        SubscriberException