org.rvpf.service

Interface Alerter

All Known Implementing Classes:

Alerter.Abstract, NullAlerter, SOMAlerter

public interface Alerter

Alerter.

Classes implementing this interface take the responsibility of the transport of Alert objects between related services.

Each service must have its own instance of the class.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Alerter.Abstract Abstract alerter.
static class	Alerter.Factory Alerter factory.
static interface	Alerter.Listener Alert listener.
static class	Alerter.SharedContext Shared context.

Method Summary

Modifier and Type	Method and Description
boolean	addListener(Alerter.Listener listener) Adds a listener.
Optional<Alerter>	getActiveInstance() Gets the active instance.
boolean	isEmbedded() Asks if this alerter is embedded.
boolean	isRunning() Asks if this alerter is running.
boolean	isShared() Gets the shared indicator.
boolean	isStealth() Gets the stealth indicator.
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.
void	start() Starts.
void	stop() Stops.
void	tearDown() Tears down what has been set up.

Method Detail

addListener

@CheckReturnValue
boolean addListener(@Nonnull
                                       Alerter.Listener listener)

Adds a listener.

Parameters:

listener - The listener to be added.

Returns:

True unless already added.

getActiveInstance

@Nonnull
 @CheckReturnValue
Optional<Alerter> getActiveInstance()

Gets the active instance.

Returns:

The optional active instance.

isEmbedded

@CheckReturnValue
boolean isEmbedded()

Asks if this alerter is embedded.

Returns:

True if it is embedded.

isRunning

@CheckReturnValue
boolean isRunning()

Asks if this alerter is running.

Returns:

True if it is running.

isShared

@CheckReturnValue
boolean isShared()

Gets the shared indicator.

Returns:

True if this alerter is shared.

isStealth

@CheckReturnValue
boolean isStealth()

Gets the stealth indicator.

Returns:

The stealth indicator.

removeListener

@CheckReturnValue
boolean removeListener(@Nonnull
                                          Alerter.Listener listener)

Removes a listener.

Parameters:

listener - The listener to be removed.

Returns:

True if it was present.

send

void send(@Nonnull
          Alert alert)
   throws InterruptedException,
          ServiceNotAvailableException

Sends an alert.

Parameters:

alert - The alert.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 Config config,
                                 @Nonnull
                                 KeyedGroups alerterProperties,
                                 @Nonnull
                                 Thread.UncaughtExceptionHandler owner)

Sets up the alerter.

Parameters:

config - The service configuration.

alerterProperties - The alerter configuration properties.

owner - The alerter owner.

Returns:

True value on success.

start

void start()
    throws InterruptedException

Starts.

Throws:

InterruptedException - When interrupted.

stop

void stop()

Stops.

tearDown

void tearDown()

Tears down what has been set up.