Package org.ikasan.spec.monitor

Interface Monitor<NOTIFICATION>

  • All Known Subinterfaces:
    FlowMonitor<NOTIFICATION>, JobMonitor<NOTIFICATION>
    public interface Monitor<NOTIFICATION>
    Monitor contract for the subject notification to the monitor
    Author:
    Ikasan Development Team

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void destroy()
      Destroys the monitor internal, rendering this Monitor defunct.
      java.lang.String getEnvironment()
      Get the runtime environment name this monitor is associated with
      java.lang.String getModuleName()
      Get the module name of this monitor
      java.util.List<Notifier> getNotifiers()
      Get the notifiers registered with this monitor
      void invoke​(NOTIFICATION notification)
      Invoke the monitor with the given notification
      void setEnvironment​(java.lang.String environmentName)
      Set the runtime environment name this monitor is associated with
      void setModuleName​(java.lang.String moduleName)
      Set the module name of this monitor
      void setNotifiers​(java.util.List<Notifier> notifiers)
      Set the notifiers to which the monitor brokers notifications

    • Method Detail

      • invoke

        void invoke​(NOTIFICATION notification)
        Invoke the monitor with the given notification
        Parameters:
        notification -

      • setModuleName

        void setModuleName​(java.lang.String moduleName)
        Set the module name of this monitor
        Parameters:
        moduleName -

      • getModuleName

        java.lang.String getModuleName()
        Get the module name of this monitor
        Returns:

      • setEnvironment

        void setEnvironment​(java.lang.String environmentName)
        Set the runtime environment name this monitor is associated with
        Parameters:
        environmentName -

      • getEnvironment

        java.lang.String getEnvironment()
        Get the runtime environment name this monitor is associated with
        Returns:

      • setNotifiers

        void setNotifiers​(java.util.List<Notifier> notifiers)
        Set the notifiers to which the monitor brokers notifications
        Parameters:
        notifiers -

      • getNotifiers

        java.util.List<Notifier> getNotifiers()
        Get the notifiers registered with this monitor
        Returns:

      • destroy

        void destroy()
        Destroys the monitor internal, rendering this Monitor defunct.