org.rvpf.service

Class ServiceBaseImpl

Object

ServiceBaseImpl

All Implemented Interfaces:

Runnable, Thread.UncaughtExceptionHandler, ServiceBase

Direct Known Subclasses:

ServiceImpl

public abstract class ServiceBaseImpl
extends Object
implements ServiceBase, Runnable

Service base implementation.

Constructor Summary

Constructors

Constructor and Description
ServiceBaseImpl()

Method Summary

Modifier and Type	Method and Description
void	addStats(ServiceStats serviceStats) Adds supplementary service stats.
protected void	closeSnoozeAlarm() Closes the snooze alarm.
protected abstract ServiceStats	createStats(StatsOwner statsOwner) Creates a stats instance.
void	fail() Fails the service.
protected Optional<String>	getLogID() Gets the log ID.
protected ServiceActivatorBase	getServiceActivatorBase() Gets the service activator base owning this.
String	getServiceName() Gets the Service name.
ServiceStats	getStats() Gets the service stats.
protected Logger	getThisLogger() Gets the logger.
protected Thread	getThread() Gets the thread.
Optional<Timer>	getTimer() Gets the service timer.
protected Version	getVersion() Gets the version object.
protected void	interrupt() Interrupts the thread.
protected boolean	isCurrentThread() Asks if the service implementation thread is the current thread.
boolean	isJMXRegistrationEnabled() Asks if the JMX registration is enabled.
protected boolean	isThreadStarted() Asks if the thread has been started.
protected boolean	join() Waits for the thread to die.
protected void	logStats(boolean intermediate) Logs the stats.
protected void	scheduleMidnightLogger() Schedules the midnight logger.
protected void	setLogID(Optional<String> logID) Sets the log ID.
protected void	setServiceActivatorBase(ServiceActivatorBase serviceActivatorBase) Sets the service activator base.
void	setServiceName(String serviceName) Sets the service name.
protected boolean	setUp() Sets up the service thread.
void	snooze(ElapsedTime snoozeTime) Snoozes for the specified time.
void	starting(Optional<ElapsedTime> waitHint) Informs that the start is progressing.
protected void	startThread() Starts the thread.
protected void	startTimer() Starts the timer.
void	stopping(Optional<ElapsedTime> waitHint) Informs that the stop is progressing.
protected void	stopTimer() Stops the timer.
protected void	tearDown() Tears down what has been set up.
String	toString()
void	uncaughtException(Thread thread, Throwable throwable)
protected void	updateStats() Allows a subclass to update the stats.
void	wakeUp() Wakes up all snoozers.

Methods inherited from class Object

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

Methods inherited from interface Runnable

run

Constructor Detail

ServiceBaseImpl

public ServiceBaseImpl()

Method Detail

addStats

public final void addStats(ServiceStats serviceStats)

Adds supplementary service stats.

Specified by:

addStats in interface ServiceBase

Parameters:

serviceStats - The service stats.

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

getServiceName

public final String getServiceName()

Gets the Service name.

Specified by:

getServiceName in interface ServiceBase

Returns:

The Service name.

getStats

public ServiceStats getStats()

Gets the service stats.

Specified by:

getStats in interface ServiceBase

Returns:

The first service stats.

getTimer

public final Optional<Timer> getTimer()

Gets the service timer.

Specified by:

getTimer in interface ServiceBase

Returns:

The optional service timer.

isJMXRegistrationEnabled

public boolean isJMXRegistrationEnabled()

Asks if the JMX registration is enabled.

Specified by:

isJMXRegistrationEnabled in interface ServiceBase

Returns:

True if enabled.

setServiceName

public final void setServiceName(@Nonnull
                                 String serviceName)

Sets the service name.

Parameters:

serviceName - The service name.

snooze

public final void snooze(ElapsedTime snoozeTime)
                  throws InterruptedException

Snoozes for the specified time.

Caution: calling this method while holding a lock object other than this instance may cause a stall.

Specified by:

snooze in interface ServiceBase

Parameters:

snoozeTime - The snooze time.

Throws:

InterruptedException - When interrupted.

starting

public final void starting(Optional<ElapsedTime> waitHint)

Informs that the start is progressing.

Specified by:

starting in interface ServiceBase

Parameters:

waitHint - An optional additional time in milliseconds.

stopping

public final void stopping(Optional<ElapsedTime> waitHint)

Informs that the stop is progressing.

Specified by:

stopping in interface ServiceBase

Parameters:

waitHint - Additional time in milliseconds.

toString

public String toString()

Overrides:

toString in class Object

uncaughtException

public final void uncaughtException(Thread thread,
                                    Throwable throwable)

Specified by:

uncaughtException in interface Thread.UncaughtExceptionHandler

wakeUp

public final void wakeUp()

Wakes up all snoozers.

Specified by:

wakeUp in interface ServiceBase

closeSnoozeAlarm

protected final void closeSnoozeAlarm()

Closes the snooze alarm.

createStats

@Nonnull
 @CheckReturnValue
protected abstract ServiceStats createStats(@Nonnull
                                                                          StatsOwner statsOwner)

Creates a stats instance.

Parameters:

statsOwner - The stats owner.

Returns:

The stats instance.

getLogID

@Nonnull
 @CheckReturnValue
protected final Optional<String> getLogID()

Gets the log ID.

Returns:

The optional log ID.

getServiceActivatorBase

@Nonnull
 @CheckReturnValue
protected final ServiceActivatorBase getServiceActivatorBase()

Gets the service activator base owning this.

Returns:

The service base.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

getThread

@Nonnull
 @CheckReturnValue
protected Thread getThread()

Gets the thread.

Returns:

The thread.

getVersion

@Nonnull
 @CheckReturnValue
protected Version getVersion()

Gets the version object.

Returns:

The version object.

interrupt

protected final void interrupt()

Interrupts the thread.

isCurrentThread

@CheckReturnValue
protected final boolean isCurrentThread()

Asks if the service implementation thread is the current thread.

Returns:

True if it is the current thread.

isThreadStarted

@CheckReturnValue
protected final boolean isThreadStarted()

Asks if the thread has been started.

Returns:

True when started.

join

@CheckReturnValue
protected final boolean join()

Waits for the thread to die.

Returns:

True on success.

logStats

protected final void logStats(boolean intermediate)

Logs the stats.

Parameters:

intermediate - True means a final log.

scheduleMidnightLogger

protected final void scheduleMidnightLogger()

Schedules the midnight logger.

This is used by service threads which are not set up to receive midnight events but still need to switch log files.

setLogID

protected final void setLogID(@Nonnull
                              Optional<String> logID)

Sets the log ID.

Parameters:

logID - The log ID.

setServiceActivatorBase

protected final void setServiceActivatorBase(@Nonnull
                                             ServiceActivatorBase serviceActivatorBase)

Sets the service activator base.

Parameters:

serviceActivatorBase - The service activator base.

setUp

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
protected boolean setUp()

Sets up the service thread.

Overriding subclasses must call this with success before proceeding.

Returns:

True on success.

startThread

protected final void startThread()

Starts the thread.

startTimer

protected final void startTimer()

Starts the timer.

stopTimer

protected final void stopTimer()

Stops the timer.

tearDown

protected void tearDown()

Tears down what has been set up.

updateStats

protected void updateStats()

Allows a subclass to update the stats.