Service (RVPF-Core API Documentation)

All Superinterfaces:

ServiceBase, Thread.UncaughtExceptionHandler

All Known Subinterfaces:

DatabaseService, MetadataService

All Known Implementing Classes:

ClockServiceImpl, ContainerServiceImpl, CStoreServiceImpl, DatabaseServiceImpl, DocumentVersionControlImpl, ForwarderServiceImpl, HTTPServerImpl, LoggerServiceImpl, MetadataServiceAppHolderImpl, MetadataServiceImpl, ProcessorServiceImpl, ProxyStoreServiceImpl, RemoteExecutorImpl, RLPServiceImpl, ScriptServiceImpl, ServiceAppHolderImpl, ServiceImpl, SinkServiceImpl, SOMContainerServiceImpl, StoreServiceImpl, TheStoreServiceImpl
```
public interface Service
extends ServiceBase
```
Service.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MIDNIGHT_EVENT` The midnight event name.
`static String`	`PING_SIGNAL` The ping signal name.
`static String`	`PONG_EVENT` The pong event name.
`static String`	`RESTART_NOW_SIGNAL` The restart now signal name.
`static String`	`RESTART_SIGNAL` The restart signal name.
`static String`	`RESUME_SIGNAL` The resume signal name.
`static String`	`RESUMED_EVENT` The service resumed event name.
`static String`	`STARTED_EVENT` The service started event name.
`static String`	`STOP_NOW_SIGNAL` The stop now signal name.
`static String`	`STOP_SIGNAL` The stop signal name.
`static String`	`STOPPED_EVENT` The stopped event name.
`static String`	`SUSPEND_SIGNAL` The suspend signal name.
`static String`	`SUSPENDED_EVENT` The service suspended event name.
`static String`	`WATCHDOG_EVENT` The watchdog event name.
`static String`	`ZOMBIE_EVENT` The service is zombie event name.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addAlertListener(Alerter.Listener listener)` Adds an alert listener.
`void`	`disableSuspend()` Disables suspend.
`void`	`enableSuspend()` Enables suspend.
`boolean`	`exportAgent()` Exports the JMX agent.
`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.
`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`	`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.
`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`	`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.
`void`	`setSourceUUID(UUID sourceUUID)` Sets the source UUID.
`void`	`starting()` Informs that the start is progressing.
`void`	`stopping()` Informs that the stop is progressing.
`void`	`suspend()` Suspends.
`boolean`	`trySuspend(long timeout)` Tries to suspend.
`void`	`unregisterServer(String serverName)` Unregisters a RMI server.

Methods inherited from interface ServiceBase
addStats, fail, getServiceName, getStats, getTimer, isJMXRegistrationEnabled, snooze, starting, stopping, wakeUp

Methods inherited from interface Thread.UncaughtExceptionHandler
uncaughtException

- Field Detail
  - MIDNIGHT_EVENT
```
static final String MIDNIGHT_EVENT
```
    The midnight event name.
    
    See Also:
    
    Constant Field Values
  - PING_SIGNAL
```
static final String PING_SIGNAL
```
    The ping signal name.
    
    See Also:
    
    Constant Field Values
  - PONG_EVENT
```
static final String PONG_EVENT
```
    The pong event name.
    
    See Also:
    
    Constant Field Values
  - RESTART_NOW_SIGNAL
```
static final String RESTART_NOW_SIGNAL
```
    The restart now signal name.
    
    See Also:
    
    Constant Field Values
  - RESTART_SIGNAL
```
static final String RESTART_SIGNAL
```
    The restart signal name.
    
    See Also:
    
    Constant Field Values
  - RESUMED_EVENT
```
static final String RESUMED_EVENT
```
    The service resumed event name.
    
    See Also:
    
    Constant Field Values
  - RESUME_SIGNAL
```
static final String RESUME_SIGNAL
```
    The resume signal name.
    
    See Also:
    
    Constant Field Values
  - STARTED_EVENT
```
static final String STARTED_EVENT
```
    The service started event name.
    
    See Also:
    
    Constant Field Values
  - STOPPED_EVENT
```
static final String STOPPED_EVENT
```
    The stopped event name.
    
    See Also:
    
    Constant Field Values
  - STOP_NOW_SIGNAL
```
static final String STOP_NOW_SIGNAL
```
    The stop now signal name.
    
    See Also:
    
    Constant Field Values
  - STOP_SIGNAL
```
static final String STOP_SIGNAL
```
    The stop signal name.
    
    See Also:
    
    Constant Field Values
  - SUSPENDED_EVENT
```
static final String SUSPENDED_EVENT
```
    The service suspended event name.
    
    See Also:
    
    Constant Field Values
  - SUSPEND_SIGNAL
```
static final String SUSPEND_SIGNAL
```
    The suspend signal name.
    
    See Also:
    
    Constant Field Values
  - WATCHDOG_EVENT
```
static final String WATCHDOG_EVENT
```
    The watchdog event name.
    
    See Also:
    
    Constant Field Values
  - ZOMBIE_EVENT
```
static final String ZOMBIE_EVENT
```
    The service is zombie event name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addAlertListener
```
@CheckReturnValue
boolean addAlertListener(@Nonnull
                                            Alerter.Listener listener)
```
    Adds an alert listener.
    
    Parameters:
    
    listener - The listener to be added.
    
    Returns:
    
    True if the alerter is running and the listener has been added.
  - disableSuspend
```
void disableSuspend()
             throws InterruptedException
```
    Disables suspend.
    
    Throws:
    
    InterruptedException - When interrupted.
  - enableSuspend
```
void enableSuspend()
```
    Enables suspend.
  - exportAgent
```
@CheckReturnValue
boolean exportAgent()
```
    Exports the JMX agent.
    
    Returns:
    
    A true value on success.
  - getAlerter
```
@Nonnull
 @CheckReturnValue
Alerter getAlerter()
```
    Gets the alerter.
    
    Returns:
    
    The alerter.
  - getConfig
```
@Nonnull
 @CheckReturnValue
Config getConfig()
```
    Gets the service config.
    
    Returns:
    
    The config.
  - getDataDir
```
@Nonnull
 @CheckReturnValue
File getDataDir()
```
    Gets the data directory.
    
    Returns:
    
    The data directory.
  - getEntityName
```
@Nonnull
 @CheckReturnValue
Optional<String> getEntityName()
```
    Gets the name of the associated entity.
    
    Returns:
    
    The optional name.
  - getJoinTimeout
```
@CheckReturnValue
long getJoinTimeout()
```
    Gets the join timeout.
    
    Returns:
    
    The join timeout.
  - getOptionalSourceUUID
```
@Nonnull
 @CheckReturnValue
Optional<UUID> getOptionalSourceUUID()
```
    Gets the optional source UUID.
    
    Returns:
    
    The optional source UUID.
  - getServiceActivator
```
@Nonnull
 @CheckReturnValue
ServiceActivator getServiceActivator()
```
    Gets the service activator owning this.
    
    Returns:
    
    The service activator.
  - getServiceUUID
```
@Nonnull
 @CheckReturnValue
Optional<UUID> getServiceUUID()
```
    Gets the service UUID.
    
    Returns:
    
    The optional service UUID.
  - getSourceUUID
```
@Nonnull
 @CheckReturnValue
UUID getSourceUUID()
```
    Gets the source UUID.
    
    Returns:
    
    The source UUID.
  - isRunning
```
@CheckReturnValue
boolean isRunning()
```
    Asks if the service is running.
    
    Returns:
    
    A true value if running.
  - isStarted
```
@CheckReturnValue
boolean isStarted()
```
    Asks if the service has been started.
    
    Returns:
    
    A true value if started.
  - isStopped
```
@CheckReturnValue
boolean isStopped()
```
    Asks if the service has been stopped.
    
    Returns:
    
    A true value if stopped.
  - isStopping
```
@CheckReturnValue
boolean isStopping()
```
    Asks if the service is stopping.
    
    Returns:
    
    A true value if stopping.
  - isWait
```
@CheckReturnValue
boolean isWait()
```
    Asks if the service waits until running.
    
    Returns:
    
    True if the service waits until running.
  - isZombie
```
@CheckReturnValue
boolean isZombie()
```
    Asks if the service is a zombie.
    
    Returns:
    
    A true value if zombie.
  - monitorService
```
void monitorService(@Nonnull
                    Optional<String> name,
                    @Nonnull
                    Optional<UUID> uuid,
                    @Nonnull
                    Optional<String> reference)
```
    Registers a service to be monitored.
    Does nothing if the service name and UUID are both empty.
    
    Parameters:
    
    name - The optional service name.
    
    uuid - The optional UUID identifying the service.
    
    reference - An optional service reference.
  - registerServer
```
@Nullable
 @CheckReturnValue
String registerServer(@Nonnull
                                                     SessionFactory server,
                                                     @Nonnull
                                                     String serverPath)
```
    Registers a RMI server.
    
    Parameters:
    
    server - The server object.
    
    serverPath - The path to the server.
    
    Returns:
    
    The server name (null on failure).
  - removeAlertListener
```
@CheckReturnValue
boolean removeAlertListener(@Nonnull
                                               Alerter.Listener listener)
```
    Removes an alert listener.
    
    Parameters:
    
    listener - The listener to be removed.
    
    Returns:
    
    True if it was present.
  - restart
```
void restart(boolean delayed)
```
    Restarts the service.
    
    Parameters:
    
    delayed - A true value if start should be delayed.
  - restoreConfigState
```
void restoreConfigState()
```
    Restores the config state.
  - restoreMonitored
```
void restoreMonitored()
```
    Restores monitored services.
  - resume
```
void resume()
```
    Resumes.
  - saveConfigState
```
void saveConfigState()
```
    Saves the config state.
  - saveMonitored
```
void saveMonitored()
```
    Saves monitored services.
  - sendAlert
```
void sendAlert(@Nonnull
               Alert alert)
```
    Sends an alert.
    
    Parameters:
    
    alert - The alert.
  - sendEvent
```
void sendEvent(@Nonnull
               String name,
               @Nonnull
               Optional<Object> info)
```
    Sends an event.
    
    Parameters:
    
    name - The event's name.
    
    info - Additional optional informations.
  - sendSignal
```
void sendSignal(@Nonnull
                String name,
                @Nonnull
                Optional<?> info)
```
    Sends a signal.
    
    Parameters:
    
    name - The signal's name.
    
    info - Additional optional informations.
  - setRestartEnabled
```
@CheckReturnValue
boolean setRestartEnabled(boolean restartEnabled)
```
    Sets the restart enabled indicator.
    
    Parameters:
    
    restartEnabled - The restart enabled indicator.
    
    Returns:
    
    The previous value of the indicator.
  - setSourceUUID
```
void setSourceUUID(@Nonnull
                   UUID sourceUUID)
```
    Sets the source UUID.
    
    Parameters:
    
    sourceUUID - The source UUID.
  - starting
```
void starting()
```
    Informs that the start is progressing.
  - stopping
```
void stopping()
```
    Informs that the stop is progressing.
  - suspend
```
void suspend()
      throws InterruptedException
```
    Suspends.
    
    Throws:
    
    InterruptedException - When interrupted.
  - trySuspend
```
@CheckReturnValue
boolean trySuspend(long timeout)
                               throws InterruptedException
```
    Tries to suspend.
    
    Parameters:
    
    timeout - The timeout in milliseconds.
    
    Returns:
    
    A true value on success.
    
    Throws:
    
    InterruptedException - When interrupted.
  - unregisterServer
```
void unregisterServer(@Nonnull
                      String serverName)
```
    Unregisters a RMI server.
    
    Parameters:
    
    serverName - The name of the server.

Interface Service

Field Summary

Method Summary

Methods inherited from interface ServiceBase

Methods inherited from interface Thread.UncaughtExceptionHandler

Field Detail

MIDNIGHT_EVENT

PING_SIGNAL

PONG_EVENT

RESTART_NOW_SIGNAL

RESTART_SIGNAL

RESUMED_EVENT

RESUME_SIGNAL

STARTED_EVENT

STOPPED_EVENT

STOP_NOW_SIGNAL

STOP_SIGNAL

SUSPENDED_EVENT

SUSPEND_SIGNAL

WATCHDOG_EVENT

ZOMBIE_EVENT

Method Detail

addAlertListener

disableSuspend

enableSuspend

exportAgent

getAlerter

getConfig

getDataDir

getEntityName

getJoinTimeout

getOptionalSourceUUID

getServiceActivator

getServiceUUID

getSourceUUID

isRunning

isStarted

isStopped

isStopping

isWait

isZombie

monitorService

registerServer

removeAlertListener

restart

restoreConfigState

restoreMonitored

resume

saveConfigState

saveMonitored

sendAlert

sendEvent

sendSignal

setRestartEnabled

setSourceUUID

starting

stopping

suspend

trySuspend

unregisterServer