org.rvpf.service.app

Class ServiceAppHolderImpl

Object

ServiceBaseImpl

ServiceImpl

ServiceAppHolderImpl

All Implemented Interfaces:

Runnable, Thread.UncaughtExceptionHandler, Alerter.Listener, Service, ServiceBase

Direct Known Subclasses:

ContainerServiceImpl, DatabaseServiceImpl, DocumentVersionControlImpl, ForwarderServiceImpl, LoggerServiceImpl, RemoteExecutorImpl, RLPServiceImpl, ScriptServiceImpl, SOMContainerServiceImpl

public class ServiceAppHolderImpl
extends ServiceImpl

Service application holder implementation.

A service application holder supports a single service application.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_APP_CLASS_PROPERTY The class of the service application to activate.

Fields inherited from class ServiceImpl

DEFAULT_JOIN_TIMEOUT, DEFAULT_RESTART_DELAY, DEFAULT_STARTING_EXTEND, DEFAULT_STOPPING_EXTEND, DEPENDENCY_PROPERTY, JOIN_TIMEOUT_PROPERTY, MEMORY_LOG_INTERVAL_PROPERTY, MONITOR_DISABLED_PROPERTY, RESTART_ALLOWED_PROPERTY, RESTART_DELAY_PROPERTY, RESTART_IGNORED_PROPERTY, SERVICE_LOG_ID_PROPERTY, SERVICE_UUID_PROPERTY, STARTING_EXTEND_PROPERTY, STARTUP_DELAY_PROPERTY, STATS_LOG_ENABLED_PROPERTY, STOPPING_EXTEND_PROPERTY, ZOMBIE_ENABLED_PROPERTY

Fields inherited from interface Service

MIDNIGHT_EVENT, PING_SIGNAL, PONG_EVENT, RESTART_NOW_SIGNAL, RESTART_SIGNAL, RESUME_SIGNAL, RESUMED_EVENT, STARTED_EVENT, STOP_NOW_SIGNAL, STOP_SIGNAL, STOPPED_EVENT, SUSPEND_SIGNAL, SUSPENDED_EVENT, WATCHDOG_EVENT, ZOMBIE_EVENT

Constructor Summary

Constructors

Constructor and Description
ServiceAppHolderImpl()

Method Summary

Modifier and Type	Method and Description
protected ServiceStats	createStats(StatsOwner statsOwner) Creates a stats instance.
protected boolean	doPendingActions() Does pending actions.
protected void	doStart() Does start.
protected void	doStop() Does stop.
ServiceApp	getServiceApp() Gets the service application.
protected ClassDef	getServiceAppClassDef() Gets the service application class definition.
protected ServiceApp	newServiceApp() Creates a new service application.
boolean	onAlert(Optional<Alert> alert) Called on alert.
protected boolean	onEvent(Event event) Called when a event has been received.
protected void	onServicesNotReady() Acts when some services are not ready.
protected boolean	onSignal(Signal signal) Called when a signal has been received.
protected boolean	setUp() Sets up the service thread.
protected void	tearDown() Tears down what has been set up.

Methods inherited from class ServiceImpl

addAlertListener, cancelRestarters, disableSuspend, doRun, enableSuspend, exportAgent, fail, getAlerter, getConfig, getDataDir, getEntityName, getJoinTimeout, getMutex, getOptionalSourceUUID, getServiceActivator, getServiceUUID, getSourceUUID, isJMXRegistrationEnabled, isRunning, isStarted, isStopped, isStopping, isWait, isZombie, monitorService, onServiceStartFailure, registerServer, removeAlertListener, restart, restoreConfigState, restoreMonitored, resume, run, saveConfigState, saveMonitored, sendAlert, sendEvent, sendSignal, setRestartEnabled, setRestartSignaled, setSourceUUID, starting, stopping, suspend, tearDownConfig, trySuspend, unregisterServer

Methods inherited from class ServiceBaseImpl

addStats, closeSnoozeAlarm, getLogID, getServiceActivatorBase, getServiceName, getStats, getThisLogger, getThread, getTimer, getVersion, interrupt, isCurrentThread, isThreadStarted, join, logStats, scheduleMidnightLogger, setLogID, setServiceActivatorBase, setServiceName, snooze, starting, startThread, startTimer, stopping, stopTimer, toString, uncaughtException, updateStats, wakeUp

Methods inherited from class Object

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

Methods inherited from interface ServiceBase

addStats, getServiceName, getStats, getTimer, snooze, starting, stopping, wakeUp

Methods inherited from interface Thread.UncaughtExceptionHandler

uncaughtException

Field Detail

SERVICE_APP_CLASS_PROPERTY

public static final String SERVICE_APP_CLASS_PROPERTY

The class of the service application to activate.

See Also:

Constant Field Values

Constructor Detail

ServiceAppHolderImpl

public ServiceAppHolderImpl()

Method Detail

getServiceApp

@Nonnull
 @CheckReturnValue
public ServiceApp getServiceApp()

Gets the service application.

Returns:

The service application.

onAlert

public boolean onAlert(Optional<Alert> alert)

Called on alert.

Specified by:

onAlert in interface Alerter.Listener

Overrides:

onAlert in class ServiceImpl

Parameters:

alert - The alert (empty on failure).

Returns:

False when the alert does not needs further processing by this listener.

createStats

protected ServiceStats createStats(StatsOwner statsOwner)

Creates a stats instance.

Overrides:

createStats in class ServiceImpl

Parameters:

statsOwner - The stats owner.

Returns:

The stats instance.

doPendingActions

protected boolean doPendingActions()
                            throws InterruptedException,
                                   ServiceNotAvailableException

Does pending actions.

Caution: this is called while synchronized on mutex.

Overrides:

doPendingActions in class ServiceImpl

Returns:

False if stopping.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

doStart

protected void doStart()
                throws Exception

Does start.

Specified by:

doStart in class ServiceImpl

Throws:

Exception - Handled by ServiceImpl.run().

doStop

protected void doStop()
               throws Exception

Does stop.

Specified by:

doStop in class ServiceImpl

Throws:

Exception - Handled by ServiceImpl.run().

getServiceAppClassDef

@Nullable
 @CheckReturnValue
protected ClassDef getServiceAppClassDef()

Gets the service application class definition.

Returns:

The service application class definition (null on failure).

newServiceApp

@Nullable
 @CheckReturnValue
protected ServiceApp newServiceApp()

Creates a new service application.

Returns:

The service application (null on failure).

onEvent

protected boolean onEvent(Event event)

Called when a event has been received.

Caution: this is called while synchronized on mutex.

Overrides:

onEvent in class ServiceImpl

Parameters:

event - The signal.

Returns:

False to inhibit further actions on the event.

onServicesNotReady

protected void onServicesNotReady()

Acts when some services are not ready.

Caution: this is called while synchronized on mutex.

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 are completed; at that time, all the registered services will be ready.

Overrides:

onServicesNotReady in class ServiceImpl

onSignal

protected boolean onSignal(Signal signal)

Called when a signal has been received.

Caution: this is called while synchronized on mutex.

Overrides:

onSignal in class ServiceImpl

Parameters:

signal - The signal.

Returns:

False to inhibit further actions on the signal.

setUp

protected boolean setUp()

Sets up the service thread.

Overriding subclasses must call this with success before proceeding.

Overrides:

setUp in class ServiceImpl

Returns:

True on success.

tearDown

protected void tearDown()

Tears down what has been set up.

Overrides:

tearDown in class ServiceImpl