com.solab.alarms

Class AlarmEhcacheClient

java.lang.Object

com.solab.alarms.AlarmEhcacheClient

All Implemented Interfaces:

AlarmCache

public class AlarmEhcacheClient
extends Object
implements AlarmCache

An alarm cache that uses ehcache to store the data it needs to know if an alarm message should be resent. This is useful in environments where you have several applications which can be using similar alarm channels, since the DefaultAlarmCache is internal to the app and events in two or more apps will cause an alarm to be sent from each app.

Constructor Summary

Constructors

Constructor and Description
AlarmEhcacheClient()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCacheName()
String	getConfigPath()
int	getDefaultInterval()
void	init() Creates an ehcache CacheManager with the specified config file, and gets the cache with the cacheName from it.
void	setCacheName(String name) Sets the name of the cache to use.
void	setConfigPath(String path) Sets the path of the config file, located in the classpath.
void	setDefaultInterval(int value) Sets the default resend interval, for storing alarms unrelated to a specific channel, in seconds.
boolean	shouldResend(AlarmChannel channel, String source, String message)
void	shutdown() Shuts down the ehcache CacheManager.
void	store(AlarmChannel channel, String source, String message)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmEhcacheClient

public AlarmEhcacheClient()

Method Detail

setDefaultInterval

public void setDefaultInterval(int value)

Sets the default resend interval, for storing alarms unrelated to a specific channel, in seconds. Default is 2 minutes.

Parameters:

value - The number of seconds after which alarms with no specific channel expire.

getDefaultInterval

public int getDefaultInterval()

setConfigPath

public void setConfigPath(String path)

Sets the path of the config file, located in the classpath. Default is "/jalarms_ehcache.xml".

Parameters:

path - The absolute path inside the classpath for the ehcache config.

getConfigPath

public String getConfigPath()

setCacheName

public void setCacheName(String name)

Sets the name of the cache to use. Default is "jalarms".

Parameters:

name - The name of the cache to use.

getCacheName

public String getCacheName()

init

@PostConstruct
public void init()

Creates an ehcache CacheManager with the specified config file, and gets the cache with the cacheName from it.

store

public void store(AlarmChannel channel,
         String source,
         String message)

Specified by:

store in interface AlarmCache

shouldResend

public boolean shouldResend(AlarmChannel channel,
                   String source,
                   String message)

Specified by:

shouldResend in interface AlarmCache

shutdown

public void shutdown()

Shuts down the ehcache CacheManager.

Specified by:

shutdown in interface AlarmCache