org.rvpf.service.app

Interface ServiceApp

All Known Subinterfaces:

MetadataServiceApp, SinkServiceApp, StoreServiceApp

All Known Implementing Classes:

ClockServiceAppImpl, CStoreServiceAppImpl, DatabaseServiceAppImpl, DocumentVersionControlAppImpl, ForwarderServiceAppImpl, HTTPServerAppImpl, LoggerServiceAppImpl, MetadataServiceAppImpl, ProcessorServiceAppImpl, ProxyStoreServiceAppImpl, RemoteExecutorAppImpl, RLPServiceAppImpl, ScriptServiceAppImpl, ServiceAppImpl, SinkServiceAppImpl, SOMContainerServiceAppImpl, StoreServiceAppImpl, TheStoreServiceAppImpl

public interface ServiceApp

Service application.

The methods of this interface are calls by the service application holder to its client, the service application.

Method Summary

Modifier and Type	Method and Description
ServiceStats	createStats(StatsOwner statsOwner) Creates a stats instance.
boolean	onAlert(Alert alert) Called when a alert has been received.
boolean	onEvent(Event event) Called when a event has been received.
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.

Method Detail

createStats

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

Creates a stats instance.

Parameters:

statsOwner - The stats owner.

Returns:

The stats instance.

onAlert

@CheckReturnValue
boolean onAlert(@Nonnull
                                   Alert alert)

Called when a alert has been received.

Caution: this is called while synchronized on the service.

Parameters:

alert - The alert.

Returns:

False to inhibit further actions on the alert.

onEvent

@CheckReturnValue
boolean onEvent(@Nonnull
                                   Event event)

Called when a event has been received.

Caution: this is called while synchronized on the service.

Parameters:

event - The event.

Returns:

False to inhibit further actions on the event.

onServicesNotReady

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.

onServicesReady

void onServicesReady()

Called when the pending actions processing is completed.

onSignal

@CheckReturnValue
boolean onSignal(@Nonnull
                                    Signal signal)

Called when a signal has been received.

Caution: this is called while synchronized on the service.

Parameters:

signal - The signal.

Returns:

False to inhibit further actions on the signal.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 Service service)

Sets up the application.

Overidden as needed.

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

Parameters:

service - The service holding this application.

Returns:

True on success.

start

void start()

Starts the application.

Overidden as needed by the application.

Called by the framework.

Should return only when the application is started.

stop

void stop()

Stops the application.

Overidden as needed by the application.

Called by the framework.

tearDown

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.