org.rvpf.service

Class ServiceImpl

Object

ServiceBaseImpl

ServiceImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

MetadataServiceImpl, ServiceAppHolderImpl

public abstract class ServiceImpl
extends ServiceBaseImpl
implements Service, Alerter.Listener

Service implementation.

Implements common or default behaviors for service implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static ElapsedTime	DEFAULT_JOIN_TIMEOUT Default join timeout.
static ElapsedTime	DEFAULT_RESTART_DELAY Default restart delay.
static ElapsedTime	DEFAULT_STARTING_EXTEND Default starting extend.
static ElapsedTime	DEFAULT_STOPPING_EXTEND Default stopping extend.
static String	DEPENDENCY_PROPERTY Contains the UUID of an other service upon which this one is dependent.
static String	JOIN_TIMEOUT_PROPERTY Join timeout.
static String	MEMORY_LOG_INTERVAL_PROPERTY Memory log interval property.
static String	MONITOR_DISABLED_PROPERTY Disables the service monitor.
static String	RESTART_ALLOWED_PROPERTY Allows restarts.
static String	RESTART_DELAY_PROPERTY Specifies a delay when the service is self-restarting.
static String	RESTART_IGNORED_PROPERTY Ignores the restart signal.
static String	SERVICE_LOG_ID_PROPERTY Used within a 'service' element to provide an identifying log ID to a service.
static String	SERVICE_UUID_PROPERTY Used within a 'service' element to provide an identifying UUID to a service.
static String	STARTING_EXTEND_PROPERTY The number of millis by which to extend the start time.
static String	STARTUP_DELAY_PROPERTY Specifies a delay before making the service available.
static String	STATS_LOG_ENABLED_PROPERTY Enables the logging of service stats.
static String	STOPPING_EXTEND_PROPERTY The number of millis by which to extend the stop time.
static String	ZOMBIE_ENABLED_PROPERTY Enables a 'zombie' state when the service fails to start.

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

Modifier	Constructor and Description
protected	ServiceImpl() Creates a new service implementation.

Method Summary

Modifier and Type	Method and Description
boolean	addAlertListener(Alerter.Listener listener) Adds an alert listener.
static void	cancelRestarters() Cancels restarters.
protected ServiceStats	createStats(StatsOwner statsOwner) Creates a stats instance.
void	disableSuspend() Disables suspend.
protected boolean	doPendingActions() Does pending actions.
protected void	doRun() Does run.
protected abstract void	doStart() Does start.
protected abstract void	doStop() Does stop.
void	enableSuspend() Enables suspend.
boolean	exportAgent() Exports the JMX agent.
void	fail() Fails the service.
Alerter	getAlerter() Gets the alerter.
Config	getConfig() Gets the service config.
File	getDataDir() Gets the data directory.
Optional<String>	getEntityName() Gets the name of the associated entity.
long	getJoinTimeout() Gets the join timeout.
protected Object	getMutex() Gets the mutex.
Optional<UUID>	getOptionalSourceUUID() Gets the optional source UUID.
ServiceActivator	getServiceActivator() Gets the service activator owning this.
Optional<UUID>	getServiceUUID() Gets the service UUID.
UUID	getSourceUUID() Gets the source UUID.
boolean	isJMXRegistrationEnabled() Asks if the JMX registration is enabled.
boolean	isRunning() Asks if the service is running.
boolean	isStarted() Asks if the service has been started.
boolean	isStopped() Asks if the service has been stopped.
boolean	isStopping() Asks if the service is stopping.
boolean	isWait() Asks if the service waits until running.
boolean	isZombie() Asks if the service is a zombie.
void	monitorService(Optional<String> name, Optional<UUID> uuid, Optional<String> reference) Registers a service to be monitored.
boolean	onAlert(Optional<Alert> optionalAlert) 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 void	onServiceStartFailure() Called when the service start failed.
protected boolean	onSignal(Signal signal) Called when a signal has been received.
String	registerServer(SessionFactory server, String serverPath) Registers a RMI server.
boolean	removeAlertListener(Alerter.Listener listener) Removes an alert listener.
void	restart(boolean delayed) Restarts the service.
void	restoreConfigState() Restores the config state.
void	restoreMonitored() Restores monitored services.
void	resume() Resumes.
void	run() Runs within the thread.
void	saveConfigState() Saves the config state.
void	saveMonitored() Saves monitored services.
void	sendAlert(Alert alert) Sends an alert.
void	sendEvent(String name, Optional<Object> info) Sends an event.
void	sendSignal(String name, Optional<?> info) Sends a signal.
boolean	setRestartEnabled(boolean restartEnabled) Sets the restart enabled indicator.
protected void	setRestartSignaled(boolean restartSignaled) Sets the restart signaled indicator.
void	setSourceUUID(UUID sourceUUID) Sets the source UUID.
protected boolean	setUp() Sets up the service thread.
void	starting() Informs that the start is progressing.
void	stopping() Informs that the stop is progressing.
void	suspend() Suspends.
protected void	tearDown() Tears down what has been set up.
protected void	tearDownConfig() Tears down the config.
boolean	trySuspend(long timeout) Tries to suspend.
void	unregisterServer(String serverName) Unregisters a RMI server.

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

DEFAULT_JOIN_TIMEOUT

public static final ElapsedTime DEFAULT_JOIN_TIMEOUT

Default join timeout.

DEFAULT_RESTART_DELAY

public static final ElapsedTime DEFAULT_RESTART_DELAY

Default restart delay.

DEFAULT_STARTING_EXTEND

public static final ElapsedTime DEFAULT_STARTING_EXTEND

Default starting extend.

DEFAULT_STOPPING_EXTEND

public static final ElapsedTime DEFAULT_STOPPING_EXTEND

Default stopping extend.

DEPENDENCY_PROPERTY

public static final String DEPENDENCY_PROPERTY

Contains the UUID of an other service upon which this one is dependent.

See Also:

Constant Field Values

JOIN_TIMEOUT_PROPERTY

public static final String JOIN_TIMEOUT_PROPERTY

Join timeout.

See Also:

Constant Field Values

MEMORY_LOG_INTERVAL_PROPERTY

public static final String MEMORY_LOG_INTERVAL_PROPERTY

Memory log interval property.

See Also:

Constant Field Values

MONITOR_DISABLED_PROPERTY

public static final String MONITOR_DISABLED_PROPERTY

Disables the service monitor.

See Also:

Constant Field Values

RESTART_ALLOWED_PROPERTY

public static final String RESTART_ALLOWED_PROPERTY

Allows restarts.

See Also:

Constant Field Values

RESTART_DELAY_PROPERTY

public static final String RESTART_DELAY_PROPERTY

Specifies a delay when the service is self-restarting.

See Also:

Constant Field Values

RESTART_IGNORED_PROPERTY

public static final String RESTART_IGNORED_PROPERTY

Ignores the restart signal.

See Also:

Constant Field Values

SERVICE_LOG_ID_PROPERTY

public static final String SERVICE_LOG_ID_PROPERTY

Used within a 'service' element to provide an identifying log ID to a service. This may be used to tag log entries.

See Also:

Constant Field Values

SERVICE_UUID_PROPERTY

public static final String SERVICE_UUID_PROPERTY

Used within a 'service' element to provide an identifying UUID to a service. This may be useful in the context of the 'Events' and 'Signals' topics.

See Also:

Constant Field Values

STARTING_EXTEND_PROPERTY

public static final String STARTING_EXTEND_PROPERTY

The number of millis by which to extend the start time. This is used to prevent a timeout when the service is wrapped.

See Also:

Constant Field Values

STARTUP_DELAY_PROPERTY

public static final String STARTUP_DELAY_PROPERTY

Specifies a delay before making the service available.

See Also:

Constant Field Values

STATS_LOG_ENABLED_PROPERTY

public static final String STATS_LOG_ENABLED_PROPERTY

Enables the logging of service stats.

See Also:

Constant Field Values

STOPPING_EXTEND_PROPERTY

public static final String STOPPING_EXTEND_PROPERTY

The number of millis by which to extend the stop time. This is used to prevent a timeout when the service is wrapped.

See Also:

Constant Field Values

ZOMBIE_ENABLED_PROPERTY

public static final String ZOMBIE_ENABLED_PROPERTY

Enables a 'zombie' state when the service fails to start. This allows the service to respond to 'Signals'.

See Also:

Constant Field Values

Constructor Detail

ServiceImpl

protected ServiceImpl()

Creates a new service implementation.

Method Detail

cancelRestarters

public static void cancelRestarters()

Cancels restarters.

addAlertListener

public boolean addAlertListener(Alerter.Listener listener)

Adds an alert listener.

Specified by:

addAlertListener in interface Service

Parameters:

listener - The listener to be added.

Returns:

True if the alerter is running and the listener has been added.

disableSuspend

public void disableSuspend()
                    throws InterruptedException

Disables suspend.

Specified by:

disableSuspend in interface Service

Throws:

InterruptedException - When interrupted.

enableSuspend

public void enableSuspend()

Enables suspend.

Specified by:

enableSuspend in interface Service

exportAgent

public boolean exportAgent()

Exports the JMX agent.

Specified by:

exportAgent in interface Service

Returns:

A true value on success.

fail

public void fail()

Fails the service.

This is called by the service implementation or one of its children when an unexpected condition is detected. It may be overridden.

Specified by:

fail in interface ServiceBase

Overrides:

fail in class ServiceBaseImpl

getAlerter

public Alerter getAlerter()

Gets the alerter.

Specified by:

getAlerter in interface Service

Returns:

The alerter.

getConfig

public final Config getConfig()

Gets the service config.

Specified by:

getConfig in interface Service

Returns:

The config.

getDataDir

public final File getDataDir()

Gets the data directory.

Specified by:

getDataDir in interface Service

Returns:

The data directory.

getEntityName

public Optional<String> getEntityName()

Gets the name of the associated entity.

Specified by:

getEntityName in interface Service

Returns:

The optional name.

getJoinTimeout

public long getJoinTimeout()

Gets the join timeout.

Specified by:

getJoinTimeout in interface Service

Returns:

The join timeout.

getOptionalSourceUUID

public Optional<UUID> getOptionalSourceUUID()

Gets the optional source UUID.

Specified by:

getOptionalSourceUUID in interface Service

Returns:

The optional source UUID.

getServiceActivator

public final ServiceActivator getServiceActivator()

Gets the service activator owning this.

Specified by:

getServiceActivator in interface Service

Returns:

The service activator.

getServiceUUID

public final Optional<UUID> getServiceUUID()

Gets the service UUID.

Specified by:

getServiceUUID in interface Service

Returns:

The optional service UUID.

getSourceUUID

public UUID getSourceUUID()

Gets the source UUID.

Specified by:

getSourceUUID in interface Service

Returns:

The source UUID.

isJMXRegistrationEnabled

public final boolean isJMXRegistrationEnabled()

Asks if the JMX registration is enabled.

Specified by:

isJMXRegistrationEnabled in interface ServiceBase

Overrides:

isJMXRegistrationEnabled in class ServiceBaseImpl

Returns:

True if enabled.

isRunning

public final boolean isRunning()

Asks if the service is running.

Specified by:

isRunning in interface Service

Returns:

A true value if running.

isStarted

public final boolean isStarted()

Asks if the service has been started.

Specified by:

isStarted in interface Service

Returns:

A true value if started.

isStopped

public final boolean isStopped()

Asks if the service has been stopped.

Specified by:

isStopped in interface Service

Returns:

A true value if stopped.

isStopping

public final boolean isStopping()

Asks if the service is stopping.

Specified by:

isStopping in interface Service

Returns:

A true value if stopping.

isWait

public boolean isWait()

Asks if the service waits until running.

Specified by:

isWait in interface Service

Returns:

True if the service waits until running.

isZombie

public final boolean isZombie()

Asks if the service is a zombie.

Specified by:

isZombie in interface Service

Returns:

A true value if zombie.

monitorService

public final void monitorService(Optional<String> name,
                                 Optional<UUID> uuid,
                                 Optional<String> reference)

Registers a service to be monitored.

Does nothing if the service name and UUID are both empty.

Specified by:

monitorService in interface Service

Parameters:

name - The optional service name.

uuid - The optional UUID identifying the service.

reference - An optional service reference.

onAlert

public boolean onAlert(Optional<Alert> optionalAlert)

Called on alert.

Specified by:

onAlert in interface Alerter.Listener

Parameters:

optionalAlert - The alert (empty on failure).

Returns:

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

registerServer

public final String registerServer(SessionFactory server,
                                   String serverPath)

Registers a RMI server.

Specified by:

registerServer in interface Service

Parameters:

server - The server object.

serverPath - The path to the server.

Returns:

The server name (null on failure).

removeAlertListener

public boolean removeAlertListener(Alerter.Listener listener)

Removes an alert listener.

Specified by:

removeAlertListener in interface Service

Parameters:

listener - The listener to be removed.

Returns:

True if it was present.

restart

public final void restart(boolean delayed)

Restarts the service.

Specified by:

restart in interface Service

Parameters:

delayed - A true value if start should be delayed.

restoreConfigState

public final void restoreConfigState()

Restores the config state.

Specified by:

restoreConfigState in interface Service

restoreMonitored

public final void restoreMonitored()

Restores monitored services.

Specified by:

restoreMonitored in interface Service

resume

public final void resume()

Resumes.

Specified by:

resume in interface Service

run

public final void run()

Runs within the thread.

The objective of this method is to streamline the overall processing and exception handling for subclasses. Instead of implementing this method, subclass should implement or override the following methods:

1. doStart() which will be called before the service is declared 'Running';
2. doRun() containing the main processing loop;
3. doStop() which will be called when the service is stopped.

Specified by:

run in interface Runnable

saveConfigState

public final void saveConfigState()

Saves the config state.

Specified by:

saveConfigState in interface Service

saveMonitored

public final void saveMonitored()

Saves monitored services.

Specified by:

saveMonitored in interface Service

sendAlert

public final void sendAlert(Alert alert)

Sends an alert.

Specified by:

sendAlert in interface Service

Parameters:

alert - The alert.

sendEvent

public final void sendEvent(String name,
                            Optional<Object> info)

Sends an event.

Specified by:

sendEvent in interface Service

Parameters:

name - The event's name.

info - Additional optional informations.

sendSignal

public final void sendSignal(String name,
                             Optional<?> info)

Sends a signal.

Specified by:

sendSignal in interface Service

Parameters:

name - The signal's name.

info - Additional optional informations.

setRestartEnabled

public final boolean setRestartEnabled(boolean restartEnabled)

Sets the restart enabled indicator.

Specified by:

setRestartEnabled in interface Service

Parameters:

restartEnabled - The restart enabled indicator.

Returns:

The previous value of the indicator.

setSourceUUID

public final void setSourceUUID(UUID sourceUUID)

Sets the source UUID.

Specified by:

setSourceUUID in interface Service

Parameters:

sourceUUID - The source UUID.

starting

public final void starting()

Informs that the start is progressing.

Specified by:

starting in interface Service

stopping

public final void stopping()

Informs that the stop is progressing.

Specified by:

stopping in interface Service

suspend

public final void suspend()
                   throws InterruptedException

Suspends.

Specified by:

suspend in interface Service

Throws:

InterruptedException - When interrupted.

trySuspend

public final boolean trySuspend(long timeout)
                         throws InterruptedException

Tries to suspend.

Specified by:

trySuspend in interface Service

Parameters:

timeout - The timeout in milliseconds.

Returns:

A true value on success.

Throws:

InterruptedException - When interrupted.

unregisterServer

public final void unregisterServer(String serverName)

Unregisters a RMI server.

Specified by:

unregisterServer in interface Service

Parameters:

serverName - The name of the server.

createStats

protected ServiceStats createStats(StatsOwner statsOwner)

Creates a stats instance.

Specified by:

createStats in class ServiceBaseImpl

Parameters:

statsOwner - The stats owner.

Returns:

The stats instance.

doPendingActions

@CheckReturnValue
protected boolean doPendingActions()
                                               throws InterruptedException,
                                                      ServiceNotAvailableException

Does pending actions.

Caution: this is called while synchronized on mutex.

Returns:

False if stopping.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

doRun

protected void doRun()
              throws Exception

Does run.

Throws:

Exception - Handled by run().

doStart

protected abstract void doStart()
                         throws Exception

Does start.

Throws:

Exception - Handled by run().

doStop

protected abstract void doStop()
                        throws Exception

Does stop.

Throws:

Exception - Handled by run().

getMutex

@Nonnull
 @CheckReturnValue
protected final Object getMutex()

Gets the mutex.

Returns:

The mutex.

onEvent

@CheckReturnValue
protected boolean onEvent(@Nonnull
                                             Event event)

Called when a event has been received.

Caution: this is called while synchronized on mutex.

Parameters:

event - The signal.

Returns:

False to inhibit further actions on the event.

onServiceStartFailure

protected void onServiceStartFailure()
                              throws InterruptedException

Called when the service start failed.

Caution: this is called while synchronized on mutex.

Throws:

InterruptedException - If the service is stopped while waiting.

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.

onSignal

@CheckReturnValue
protected boolean onSignal(@Nonnull
                                              Signal signal)

Called when a signal has been received.

Caution: this is called while synchronized on mutex.

Parameters:

signal - The signal.

Returns:

False to inhibit further actions on the signal.

setRestartSignaled

protected void setRestartSignaled(boolean restartSignaled)

Sets the restart signaled indicator.

Parameters:

restartSignaled - The restart signaled indicator.

setUp

protected boolean setUp()

Sets up the service thread.

Overriding subclasses must call this with success before proceeding.

Overrides:

setUp in class ServiceBaseImpl

Returns:

True on success.

tearDown

protected void tearDown()

Tears down what has been set up.

Overrides:

tearDown in class ServiceBaseImpl

tearDownConfig

protected void tearDownConfig()

Tears down the config.