org.rvpf.service.som

Class SOMAlerter

Object

Alerter.Abstract

SOMAlerter

All Implemented Interfaces:

Alerter, ServiceThread.Target

public final class SOMAlerter
extends Alerter.Abstract
implements ServiceThread.Target

SOM alerter.

Implements an Alerter using Simple Messaging Objects as transport.

Nested Class Summary

Nested classes/interfaces inherited from interface Alerter

Alerter.Abstract, Alerter.Factory, Alerter.Listener, Alerter.SharedContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TOPIC Default alerter topic.
static String	TOPIC_PROPERTIES The topic properties.

Fields inherited from class Alerter.Abstract

CONNECTION_RETRY_DELAY_PROPERTY, DEFAULT_CONNECTION_RETRY_DELAY, DEFAULT_WATCHDOG_PERIOD, DEFAULT_WATCHDOG_TRIGGER, EMBEDDED_PROPERTY, SHARED_PROPERTY, STEALTH_PROPERTY, WATCHDOG_PERIOD_PROPERTY, WATCHDOG_TRIGGER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SOMAlerter()

Method Summary

Modifier and Type	Method and Description
protected void	doSend(Alert alert) Does send an alert.
protected boolean	doSetUp() Does set up the alerter.
protected void	doStart() Does start.
protected void	doStop() Does stop.
protected void	doTearDown() Does tear down what has been set up.
boolean	isEmbedded() Asks if this alerter is embedded.
boolean	isRunning() Asks if this alerter is running.
void	run() Runs.
protected Alerter.SharedContext	sharedContext() Returns the shared context.

Methods inherited from class Alerter.Abstract

addListener, getActiveInstance, getAlerterProperties, getConfig, getConfigProperties, getOwner, getService, getThisLogger, isShared, isStealth, notifyListeners, removeListener, send, setUp, start, stop, tearDown

Methods inherited from class Object

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

Field Detail

DEFAULT_TOPIC

public static final String DEFAULT_TOPIC

Default alerter topic.

See Also:

Constant Field Values

TOPIC_PROPERTIES

public static final String TOPIC_PROPERTIES

The topic properties.

See Also:

Constant Field Values

Constructor Detail

SOMAlerter

public SOMAlerter()

Method Detail

isEmbedded

public boolean isEmbedded()

Asks if this alerter is embedded.

Specified by:

isEmbedded in interface Alerter

Overrides:

isEmbedded in class Alerter.Abstract

Returns:

True if it is embedded.

isRunning

public boolean isRunning()

Asks if this alerter is running.

Specified by:

isRunning in interface Alerter

Returns:

True if it is running.

run

public void run()

Runs.

Similar to same in Runnable but may throw exceptions.

Specified by:

run in interface ServiceThread.Target

doSend

protected void doSend(Alert alert)
               throws InterruptedException,
                      ServiceNotAvailableException

Does send an alert.

Specified by:

doSend in class Alerter.Abstract

Parameters:

alert - The alert.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

doSetUp

protected boolean doSetUp()

Does set up the alerter.

Specified by:

doSetUp in class Alerter.Abstract

Returns:

A true value on success.

doStart

protected void doStart()
                throws InterruptedException

Does start.

Overrides:

doStart in class Alerter.Abstract

Throws:

InterruptedException - When interrupted.

doStop

protected void doStop()

Does stop.

Overrides:

doStop in class Alerter.Abstract

doTearDown

protected void doTearDown()

Does tear down what has been set up.

Specified by:

doTearDown in class Alerter.Abstract

sharedContext

protected Alerter.SharedContext sharedContext()

Returns the shared context.

Specified by:

sharedContext in class Alerter.Abstract

Returns:

The shared context.