Package org.frankframework.monitoring

Class Monitor

java.lang.Object
org.frankframework.monitoring.Monitor
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
@FrankDocGroup(MONITORING) public class Monitor extends Object implements ConfigurableLifecycle, NameAware, org.springframework.beans.factory.DisposableBean, FrankElement

Example configuration:


 <Monitor name="Receiver Shutdown" destinations="MONITOR_LOG">
    <AlarmTrigger severity="WARNING">
        <Event>Receiver Shutdown</Event>
    </AlarmTrigger>
    <ClearingTrigger severity="WARNING">
        <Event>Receiver Shutdown</Event>
    </ClearingTrigger>
 </Monitor>
Since:
4.9
Version:
2.0
Author:
Gerrit van Brakel, Niels Meijer

  • Constructor Details

    • Monitor

      public Monitor()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware

    • getApplicationContext

      public org.springframework.context.ApplicationContext getApplicationContext()
      Specified by:
      getApplicationContext in interface HasApplicationContext

    • configure

      public void configure() throws ConfigurationException
      Description copied from interface: IConfigurable
      Configure this component.

      configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • changeState

      public void changeState(ITrigger.TriggerType type, Severity severity, MonitorEvent event) throws MonitorException
      Throws:
      MonitorException

    • changeMonitorState

      public void changeMonitorState(EventType eventType, Severity severity, String eventCode, MonitorEvent event) throws MonitorException
      Throws:
      MonitorException

    • clearEvents

      protected void clearEvents(ITrigger.TriggerType alarm)

    • toXml

      public XmlBuilder toXml()

    • getDestinationsAsString

      public String getDestinationsAsString()

    • setDestinations

      public void setDestinations(String newDestinations)

    • getDestinationSet

      public Set<String> getDestinationSet()

    • setDestinationSet

      public void setDestinationSet(Set<String> newDestinations)

    • addTrigger

      public void addTrigger(ITrigger trigger)

    • removeTrigger

      public void removeTrigger(ITrigger trigger)

    • getLogPrefix

      public String getLogPrefix()

    • getTriggers

      public List<ITrigger> getTriggers()

    • getTrigger

      public ITrigger getTrigger(int index)

    • setName

      @Mandatory public void setName(String string)
      Specified by:
      setName in interface NameAware

    • setRaised

      public void setRaised(boolean b)

    • isRaised

      public boolean isRaised()

    • setAdditionalHitCount

      public void setAdditionalHitCount(int i)

    • getAdditionalHitCount

      public int getAdditionalHitCount()

    • destroy

      public void destroy()
      Destroy the monitor and all registered triggers
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean

    • start

      public void start()
      Specified by:
      start in interface org.springframework.context.Lifecycle

    • stop

      public void stop()
      Specified by:
      stop in interface org.springframework.context.Lifecycle

    • isRunning

      public boolean isRunning()
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle

    • getConfigurationClassLoader

      public ClassLoader getConfigurationClassLoader()
      Description copied from interface: IScopeProvider
      This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
      Specified by:
      getConfigurationClassLoader in interface HasApplicationContext
      Specified by:
      getConfigurationClassLoader in interface IScopeProvider
      Returns:
      returns the ClassLoader created by the ClassLoaderManager.

    • getName

      public String getName()
      Specified by:
      getName in interface HasName

    • getType

      public EventType getType()

    • setType

      public void setType(EventType type)

    • getStateChanged

      public Instant getStateChanged()

    • getLastHit

      public Instant getLastHit()

    • getAlarmSeverity

      public Severity getAlarmSeverity()

    • setAlarmSeverity

      public void setAlarmSeverity(Severity alarmSeverity)

    • getRaisedBy

      public EventThrowing getRaisedBy()