Package org.frankframework.monitoring

Class Monitor

java.lang.Object

org.frankframework.monitoring.Monitor

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, NameAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.context.ApplicationContextAware

@FrankDocGroup(MONITORING)
public class Monitor
extends Object
implements IConfigurable, 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 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(boolean alarm, Severity severity, MonitorEvent event)
protected void	clearEvents(boolean alarm)
void	configure()	Configure this component.
void	destroy()	Destroy the monitor and all registered triggers
int	getAdditionalHitCount()
Severity	getAlarmSeverity()
org.springframework.context.ApplicationContext	getApplicationContext()
ClassLoader	getConfigurationClassLoader()	This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
String	getDestinationsAsString()
Set<String>	getDestinationSet()
Instant	getLastHit()
String	getLogPrefix()
String	getName()
EventThrowing	getRaisedBy()
Instant	getStateChanged()
ITrigger	getTrigger(int index)
List<ITrigger>	getTriggers()
EventType	getType()
boolean	isRaised()
void	removeTrigger(ITrigger trigger)
void	setAdditionalHitCount(int i)
void	setAlarmSeverity(Severity alarmSeverity)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDestinations(String newDestinations)
void	setDestinationSet(Set<String> newDestinations)
void	setManager(MonitorManager manager)
void	setName(String string)
void	setRaised(boolean b)
void	setType(EventType type)
XmlBuilder	toXml()

Methods inherited from class java.lang.Object

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

Constructor Details

Monitor

public Monitor()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

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(boolean alarm,
 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(boolean 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()

setManager

public void setManager(MonitorManager manager)

getTriggers

public List<ITrigger> getTriggers()

getTrigger

public ITrigger getTrigger(int index)

setName

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

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()

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface HasApplicationContext

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware