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

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
Monitor()

Method Summary

Modifier and Type	Method	Description
void	addTrigger(ITrigger trigger)
void	changeMonitorState(EventType eventType, Severity severity, String eventCode, MonitorEvent event)
void	changeState(ITrigger.TriggerType type, Severity severity, MonitorEvent event)
protected void	clearEvents(ITrigger.TriggerType alarm)
void	configure()	Configure this component.
void	destroy()	Destroy the monitor and all registered triggers
int	getAdditionalHitCount()
org.springframework.context.ApplicationContext	getApplicationContext()
String	getDestinationsAsString()
Set<String>	getDestinationSet()
String	getLogPrefix()
ITrigger	getTrigger(int index)
List<ITrigger>	getTriggers()
boolean	isRaised()
boolean	isRunning()
void	removeTrigger(ITrigger trigger)
void	setAdditionalHitCount(int i)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDestinations(String newDestinations)
void	setDestinationSet(Set<String> newDestinations)
void	setName(String string)	The functional name of the object.
void	setRaised(boolean b)
void	start()
void	stop()
XmlBuilder	toXml()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

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)

Description copied from interface: NameAware

The functional name of the object.

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 ConfigurableLifecycle

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