org.rvpf.service

Class Alerter.Abstract

Object

Alerter.Abstract

All Implemented Interfaces:

Alerter

Direct Known Subclasses:

NullAlerter, SOMAlerter

Enclosing interface:

Alerter

@ThreadSafe
public abstract static class Alerter.Abstract
extends Object
implements Alerter

Abstract alerter.

Implements basic functionalities and common constants for Alerter implementations.

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	CONNECTION_RETRY_DELAY_PROPERTY The time in millis before an alerter topic connect retry.
static ElapsedTime	DEFAULT_CONNECTION_RETRY_DELAY Default connection retry delay.
static ElapsedTime	DEFAULT_WATCHDOG_PERIOD Default watchdog period in milliseconds.
static ElapsedTime	DEFAULT_WATCHDOG_TRIGGER Default watchdog periods.
static String	EMBEDDED_PROPERTY Embeds the alerter topic server within the service.
static String	SHARED_PROPERTY Tries to share the alerter.
static String	STEALTH_PROPERTY Disables response to 'Ping' signals.
static String	WATCHDOG_PERIOD_PROPERTY Watchdog period property.
static String	WATCHDOG_TRIGGER_PROPERTY Watchdog trigger property.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Abstract() Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	addListener(Alerter.Listener listener) Adds a listener.
protected abstract void	doSend(Alert alert) Does send an alert.
protected abstract boolean	doSetUp() Does set up the alerter.
protected void	doStart() Does start.
protected void	doStop() Does stop.
protected abstract void	doTearDown() Does tear down what has been set up.
Optional<Alerter>	getActiveInstance() Gets the active instance.
KeyedGroups	getAlerterProperties() Gets the alerter properties.
Config	getConfig() Gets the config.
KeyedGroups	getConfigProperties() Gets the configuration properties.
Object	getOwner() Gets the owner.
Optional<Service>	getService() Gets the service.
Logger	getThisLogger() Gets the logger.
boolean	isEmbedded() Asks if this alerter is embedded.
boolean	isShared() Gets the shared indicator.
boolean	isStealth() Gets the stealth indicator.
protected void	notifyListeners(Optional<Alert> alert) Notifies listeners.
boolean	removeListener(Alerter.Listener listener) Removes a listener.
void	send(Alert alert) Sends an alert.
boolean	setUp(Config config, KeyedGroups alerterProperties, Thread.UncaughtExceptionHandler owner) Sets up the alerter.
protected abstract Alerter.SharedContext	sharedContext() Returns the shared context.
void	start() Starts.
void	stop() Stops.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Methods inherited from interface Alerter

isRunning

Field Detail

CONNECTION_RETRY_DELAY_PROPERTY

public static final String CONNECTION_RETRY_DELAY_PROPERTY

The time in millis before an alerter topic connect retry.

See Also:

Constant Field Values

DEFAULT_CONNECTION_RETRY_DELAY

public static final ElapsedTime DEFAULT_CONNECTION_RETRY_DELAY

Default connection retry delay.

DEFAULT_WATCHDOG_PERIOD

public static final ElapsedTime DEFAULT_WATCHDOG_PERIOD

Default watchdog period in milliseconds.

DEFAULT_WATCHDOG_TRIGGER

public static final ElapsedTime DEFAULT_WATCHDOG_TRIGGER

Default watchdog periods.

EMBEDDED_PROPERTY

public static final String EMBEDDED_PROPERTY

Embeds the alerter topic server within the service.

See Also:

Constant Field Values

SHARED_PROPERTY

public static final String SHARED_PROPERTY

Tries to share the alerter.

See Also:

Constant Field Values

STEALTH_PROPERTY

public static final String STEALTH_PROPERTY

Disables response to 'Ping' signals.

See Also:

Constant Field Values

WATCHDOG_PERIOD_PROPERTY

public static final String WATCHDOG_PERIOD_PROPERTY

Watchdog period property.

See Also:

Constant Field Values

WATCHDOG_TRIGGER_PROPERTY

public static final String WATCHDOG_TRIGGER_PROPERTY

Watchdog trigger property.

See Also:

Constant Field Values

Constructor Detail

Abstract

protected Abstract()

Constructs an instance.

Method Detail

addListener

public final boolean addListener(Alerter.Listener listener)

Adds a listener.

Specified by:

addListener in interface Alerter

Parameters:

listener - The listener to be added.

Returns:

True unless already added.

getActiveInstance

public final Optional<Alerter> getActiveInstance()

Gets the active instance.

Specified by:

getActiveInstance in interface Alerter

Returns:

The optional active instance.

getAlerterProperties

@Nonnull
 @CheckReturnValue
public final KeyedGroups getAlerterProperties()

Gets the alerter properties.

Returns:

The alerter properties.

getConfig

@Nonnull
 @CheckReturnValue
public final Config getConfig()

Gets the config.

Returns:

The config.

getConfigProperties

@Nonnull
 @CheckReturnValue
public final KeyedGroups getConfigProperties()

Gets the configuration properties.

Returns:

The configuration properties.

getOwner

@Nonnull
 @CheckReturnValue
public final Object getOwner()

Gets the owner.

Returns:

The owner.

getService

@Nonnull
 @CheckReturnValue
public final Optional<Service> getService()

Gets the service.

Returns:

The optional service.

getThisLogger

@Nonnull
 @CheckReturnValue
public final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

isEmbedded

public boolean isEmbedded()

Asks if this alerter is embedded.

Specified by:

isEmbedded in interface Alerter

Returns:

True if it is embedded.

isShared

public final boolean isShared()

Gets the shared indicator.

Specified by:

isShared in interface Alerter

Returns:

True if this alerter is shared.

isStealth

public boolean isStealth()

Gets the stealth indicator.

Specified by:

isStealth in interface Alerter

Returns:

The stealth indicator.

removeListener

public final boolean removeListener(Alerter.Listener listener)

Removes a listener.

Specified by:

removeListener in interface Alerter

Parameters:

listener - The listener to be removed.

Returns:

True if it was present.

send

public final void send(Alert alert)
                throws InterruptedException,
                       ServiceNotAvailableException

Sends an alert.

Specified by:

send in interface Alerter

Parameters:

alert - The alert.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

setUp

public final boolean setUp(Config config,
                           KeyedGroups alerterProperties,
                           Thread.UncaughtExceptionHandler owner)

Sets up the alerter.

Specified by:

setUp in interface Alerter

Parameters:

config - The service configuration.

alerterProperties - The alerter configuration properties.

owner - The alerter owner.

Returns:

True value on success.

start

public final void start()
                 throws InterruptedException

Starts.

Specified by:

start in interface Alerter

Throws:

InterruptedException - When interrupted.

stop

public final void stop()

Stops.

Specified by:

stop in interface Alerter

tearDown

public final void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Alerter

doSend

protected abstract void doSend(@Nonnull
                               Alert alert)
                        throws InterruptedException,
                               ServiceNotAvailableException

Does send an alert.

Parameters:

alert - The alert.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

doSetUp

@CheckReturnValue
protected abstract boolean doSetUp()

Does set up the alerter.

Returns:

A true value on success.

doStart

protected void doStart()
                throws InterruptedException

Does start.

Throws:

InterruptedException - When interrupted.

doStop

protected void doStop()

Does stop.

doTearDown

protected abstract void doTearDown()

Does tear down what has been set up.

notifyListeners

protected final void notifyListeners(@Nonnull
                                     Optional<Alert> alert)

Notifies listeners.

Parameters:

alert - An alert (empty on failure).

sharedContext

@Nonnull
 @CheckReturnValue
protected abstract Alerter.SharedContext sharedContext()

Returns the shared context.

Returns:

The shared context.