org.rvpf.clock

Class ClockServiceAppImpl

Object

ServiceAppImpl

MetadataServiceAppImpl

ClockServiceAppImpl

All Implemented Interfaces:

ServiceApp, MetadataServiceApp, ServiceThread.Target

public final class ClockServiceAppImpl
extends MetadataServiceAppImpl
implements ServiceThread.Target

Clock service application implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME Name of the default 'Origin'.
static String	GENERATED_TRACES Traces subdirectory.
static String	MIDNIGHT_ENABLED_PROPERTY Enables the generation of 'Midnight' events.
static String	NAME_PROPERTY Identifies the 'Origin' entry in the Metadata associated with the service instance.

Fields inherited from class ServiceAppImpl

SERVICE_APP_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
ClockServiceAppImpl()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getEntityName() Gets the entity name.
boolean	onEvent(Event event) Called when a event has been received.
boolean	onNewMetadata(Metadata metadata) Called on new metadata.
void	onServicesNotReady() Called when some services are not ready.
void	run() Runs.
boolean	setUp(MetadataService 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 MetadataServiceAppImpl

getMetadata, getService, loadMetadata, setUp

Methods inherited from class ServiceAppImpl

createStats, fail, getConfig, getConfigProperties, getDataDir, getJoinTimeout, getProperties, getSourceUUID, getThisLogger, getTimer, onAlert, onServiceNotAvailableException, onServicesReady, onSignal

Methods inherited from class Object

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

Methods inherited from interface ServiceApp

createStats, onAlert, onServicesReady, onSignal

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

Name of the default 'Origin'.

See Also:

Constant Field Values

GENERATED_TRACES

public static final String GENERATED_TRACES

Traces subdirectory.

See Also:

Constant Field Values

MIDNIGHT_ENABLED_PROPERTY

public static final String MIDNIGHT_ENABLED_PROPERTY

Enables the generation of 'Midnight' events.

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

Identifies the 'Origin' entry in the Metadata associated with the service instance.

See Also:

Constant Field Values

Constructor Detail

ClockServiceAppImpl

public ClockServiceAppImpl()

Method Detail

getEntityName

public Optional<String> getEntityName()

Gets the entity name.

Specified by:

getEntityName in interface MetadataServiceApp

Overrides:

getEntityName in class MetadataServiceAppImpl

Returns:

The optional entity name.

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

Overrides:

onEvent in class ServiceAppImpl

Parameters:

event - The event.

Returns:

False to inhibit further actions on the event.

onNewMetadata

public boolean onNewMetadata(Metadata metadata)

Called on new metadata.

Overidden as needed.

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

Specified by:

onNewMetadata in interface MetadataServiceApp

Overrides:

onNewMetadata in class MetadataServiceAppImpl

Parameters:

metadata - The new metadata.

Returns:

False to reject the metadata.

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

Overrides:

onServicesNotReady in class ServiceAppImpl

run

public void run()
         throws InterruptedException

Runs.

Similar to same in Runnable but may throw exceptions.

Specified by:

run in interface ServiceThread.Target

Throws:

InterruptedException

setUp

public boolean setUp(MetadataService 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 MetadataServiceApp

Overrides:

setUp in class MetadataServiceAppImpl

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

Overrides:

start in class ServiceAppImpl

stop

public void stop()

Stops the application.

Overidden as needed by the application.

Called by the framework.

Specified by:

stop in interface ServiceApp

Overrides:

stop in class ServiceAppImpl

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

Overrides:

tearDown in class ServiceAppImpl