org.rvpf.service.app

Class ServiceAppImpl

Object

ServiceAppImpl

All Implemented Interfaces:

ServiceApp

Direct Known Subclasses:

DatabaseServiceAppImpl, DocumentVersionControlAppImpl, ForwarderServiceAppImpl, LoggerServiceAppImpl, MetadataServiceAppImpl, RemoteExecutorAppImpl, RLPServiceAppImpl, ScriptServiceAppImpl, SOMContainerServiceAppImpl

public abstract class ServiceAppImpl
extends Object
implements ServiceApp

Service application implementation.

This abstract class supplies a minimal implementation for the service application interface. It also supplies help methods (protected) to its subclasses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_APP_PROPERTIES The properties for the service application.

Constructor Summary

Constructors

Constructor and Description
ServiceAppImpl()

Method Summary

Modifier and Type	Method and Description
ServiceStats	createStats(StatsOwner statsOwner) Creates a stats instance.
void	fail() Fails.
Config	getConfig() Gets the service config.
KeyedGroups	getConfigProperties() Gets the config properties.
File	getDataDir() Gets the data directory.
long	getJoinTimeout() Gets the join timeout.
KeyedGroups	getProperties() Gets the application specific properties.
Service	getService() Gets the service holding this application.
UUID	getSourceUUID() Gets the source UUID.
protected Logger	getThisLogger() Gets the logger for this instance.
Optional<Timer>	getTimer() Gets the service timer.
boolean	onAlert(Alert alert) Called when a alert has been received.
boolean	onEvent(Event event) Called when a event has been received.
protected void	onServiceNotAvailableException(ServiceNotAvailableException exception) Called on service not available exception.
void	onServicesNotReady() Called when some services are not ready.
void	onServicesReady() Called when the pending actions processing is completed.
boolean	onSignal(Signal signal) Called when a signal has been received.
boolean	setUp(Service service) Sets up the application.
void	start() Starts the application.
void	stop() Stops the application.
void	tearDown() Tears down the application.

Methods inherited from class Object

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

Field Detail

SERVICE_APP_PROPERTIES

public static final String SERVICE_APP_PROPERTIES

The properties for the service application.

See Also:

Constant Field Values

Constructor Detail

ServiceAppImpl

public ServiceAppImpl()

Method Detail

createStats

public ServiceStats createStats(StatsOwner statsOwner)

Creates a stats instance.

Specified by:

createStats in interface ServiceApp

Parameters:

statsOwner - The stats owner.

Returns:

The stats instance.

fail

public final void fail()

Fails.

getConfig

@Nonnull
 @CheckReturnValue
public final Config getConfig()

Gets the service config.

Returns:

The config.

getConfigProperties

@Nonnull
 @CheckReturnValue
public KeyedGroups getConfigProperties()

Gets the config properties.

Returns:

The config properties.

getDataDir

@Nonnull
 @CheckReturnValue
public final File getDataDir()

Gets the data directory.

Returns:

The data directory.

getJoinTimeout

@CheckReturnValue
public long getJoinTimeout()

Gets the join timeout.

Returns:

The interrupt timeout.

getProperties

@Nonnull
 @CheckReturnValue
public KeyedGroups getProperties()

Gets the application specific properties.

These properties are contained in the non validated group '"service.app.properties"'.

Since this method is usually called during the set up of subclasses, they must call the set up of their superclass first.

Returns:

The application specific properties.

getService

@Nonnull
 @CheckReturnValue
public Service getService()

Gets the service holding this application.

Returns:

The service.

getSourceUUID

@Nonnull
 @CheckReturnValue
public UUID getSourceUUID()

Gets the source UUID.

Returns:

The source UUID (may be generated).

getTimer

@Nonnull
 @CheckReturnValue
public Optional<Timer> getTimer()

Gets the service timer.

Returns:

The optional service timer.

onAlert

public boolean onAlert(Alert alert)

Called when a alert has been received.

Caution: this is called while synchronized on the service.

Specified by:

onAlert in interface ServiceApp

Parameters:

alert - The alert.

Returns:

False to inhibit further actions on the alert.

onEvent

public boolean onEvent(Event event)

Called when a event has been received.

Caution: this is called while synchronized on the service.

Specified by:

onEvent in interface ServiceApp

Parameters:

event - The event.

Returns:

False to inhibit further actions on the event.

onServicesNotReady

public void onServicesNotReady()

Called when some services are not ready.

This is called by the pending actions processing when it not known if all registered services are ready. This may be used by a service thread to trigger some state refresh when the pending actions processing is completed; at that time, all the registered services will be ready.

Specified by:

onServicesNotReady in interface ServiceApp

onServicesReady

public void onServicesReady()

Called when the pending actions processing is completed.

Specified by:

onServicesReady in interface ServiceApp

onSignal

public boolean onSignal(Signal signal)

Called when a signal has been received.

Caution: this is called while synchronized on the service.

Specified by:

onSignal in interface ServiceApp

Parameters:

signal - The signal.

Returns:

False to inhibit further actions on the signal.

setUp

public boolean setUp(Service service)

Sets up the application.

Overidden as needed.

Called by the framework and by overriding classes at the beginning of the override.

Specified by:

setUp in interface ServiceApp

Parameters:

service - The service holding this application.

Returns:

True on success.

start

public void start()

Starts the application.

Overidden as needed by the application.

Called by the framework.

Should return only when the application is started.

Specified by:

start in interface ServiceApp

stop

public void stop()

Stops the application.

Overidden as needed by the application.

Called by the framework.

Specified by:

stop in interface ServiceApp

tearDown

public void tearDown()

Tears down the application.

Overidden as needed by the application.

Called by the framework and by overriding classes at the end of the override.

Specified by:

tearDown in interface ServiceApp

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger for this instance.

Returns:

The logger.

onServiceNotAvailableException

protected void onServiceNotAvailableException(@Nonnull
                                              ServiceNotAvailableException exception)

Called on service not available exception.

Parameters:

exception - The service not available exception.