org.rvpf.service

Class ServiceActivator

Object

NotificationBroadcasterSupport

StatsHolder

ServiceActivatorBase

ServiceActivator

All Implemented Interfaces:

MBeanRegistration, NotificationBroadcaster, NotificationEmitter, StatsOwner, ServiceActivatorBaseMBean, ServiceActivatorMBean, StatsHolderMBean

Direct Known Subclasses:

ClockServiceActivator, ContainerServiceActivator, CStoreServiceActivator, DatabaseServiceActivator, DocumentVersionControlActivator, ForwarderServiceActivator, HTTPServerActivator, LoggerServiceActivator, MetadataServiceAppHolderActivator, ProcessorServiceActivator, ProxyStoreServiceActivator, RemoteExecutorActivator, RLPServiceActivator, ScriptServiceActivator, ServiceAppHolderActivator, SinkServiceActivator, SOMContainerServiceActivator, TheStoreServiceActivator

public abstract class ServiceActivator
extends ServiceActivatorBase
implements ServiceActivatorMBean

Service activator.

This class supports RVPF services implemented by a ServiceImpl.

Nested Class Summary

Nested classes/interfaces inherited from class StatsHolder

StatsHolder.UpdateNotification

Field Summary

Fields inherited from class ServiceActivatorBase

NAME_ARG_PREFIX, OBJECT_NAME_PROPERTY

Fields inherited from class StatsHolder

ACTIVATOR_CLASS_NAME_SUFFIX, DEFAULT_DOMAIN, DOMAIN_PROPERTY, NAME_KEY, STATS_UPDATE_TYPE, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
ServiceActivator()

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptMainArg(String arg) Accepts a main argument.
void	create() Creates the service.
protected abstract ServiceImpl	createServiceImpl() Creates the service implementation.
protected ServiceImpl	createServiceImpl(Class<? extends ServiceImpl> serviceImplClass) Creates a service implementation.
protected ServiceImpl	createServiceImpl(ClassDef classDef) Creates a service implementation.
void	destroy() Destroys the service.
protected void	export() Allows a subclass to export the JMX agent.
Optional<Config>	getConfig() Gets the service config.
String	getConfigURL() Gets the Configuration URL.
Optional<String>	getObjectVersion() Gets the object's version.
Service	getService() Gets the service.
Optional<Stats>	getStats() Gets the stats.
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	isZombie() Asks if the service is in a 'zombie' state.
void	setConfigURL(String configURL) Sets the configuration file specification.
void	setWait(boolean wait) Sets the wait indicator.
void	start() Starts the service.
void	start(boolean wait) Starts the service.
void	stop() Stops the service.
protected void	tearDownStandAlone() Tears down what has been set up in stand alone mode.
void	updateStats() Updates the stats.

Methods inherited from class ServiceActivatorBase

created, destroyed, equals, getObjectName, getProperties, getProperty, getServer, getVersion, hashCode, postDeregister, postRegister, preDeregister, preRegister, restart, restart, run, setListener, setObjectNameProperty, setProperties, setProperty, started, starting, stopped, stopping, terminate, toString

Methods inherited from class StatsHolder

getDefaultDomain, getStatsStrings, getThisLogger, makeObjectName, makeObjectName, objectName, onStatsUpdated, setObjectName

Methods inherited from class NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ServiceActivatorBaseMBean

getProperties, getProperty, restart, setProperties, setProperty

Methods inherited from interface StatsHolderMBean

getStatsStrings

Constructor Detail

ServiceActivator

public ServiceActivator()

Method Detail

create

public void create()
            throws Exception

Creates the service.

Specified by:

create in interface ServiceActivatorBaseMBean

Overrides:

create in class ServiceActivatorBase

Throws:

Exception - As appropriate for the service.

destroy

public void destroy()

Destroys the service.

Specified by:

destroy in interface ServiceActivatorBaseMBean

Overrides:

destroy in class ServiceActivatorBase

getConfig

@Nonnull
 @CheckReturnValue
public final Optional<Config> getConfig()

Gets the service config.

Returns:

The optional config.

getConfigURL

public final String getConfigURL()

Gets the Configuration URL.

Specified by:

getConfigURL in interface ServiceActivatorMBean

Returns:

The configuration URL.

getObjectVersion

public final Optional<String> getObjectVersion()

Gets the object's version.

Specified by:

getObjectVersion in interface StatsOwner

Overrides:

getObjectVersion in class StatsHolder

Returns:

The optional object's version.

getService

@Nonnull
 @CheckReturnValue
public final Service getService()

Gets the service.

Returns:

The service.

getStats

public final Optional<Stats> getStats()

Gets the stats.

Overrides:

getStats in class ServiceActivatorBase

Returns:

The optional stats.

isRunning

public final boolean isRunning()

Asks if the service is running.

Specified by:

isRunning in interface ServiceActivatorBaseMBean

Overrides:

isRunning in class ServiceActivatorBase

Returns:

True if the service is running.

isStarted

public final boolean isStarted()

Asks if the service has been started.

Specified by:

isStarted in interface ServiceActivatorBaseMBean

Returns:

True if the service has been started.

isStopped

public final boolean isStopped()

Asks if the service has been stopped.

Specified by:

isStopped in interface ServiceActivatorBaseMBean

Overrides:

isStopped in class ServiceActivatorBase

Returns:

True if the service has been started stopped.

isZombie

public final boolean isZombie()

Asks if the service is in a 'zombie' state.

Specified by:

isZombie in interface ServiceActivatorMBean

Returns:

True if the service is in a 'zombie' state.

setConfigURL

public final void setConfigURL(String configURL)

Sets the configuration file specification.

Specified by:

setConfigURL in interface ServiceActivatorMBean

Parameters:

configURL - The configuration file specification.

setWait

public final void setWait(boolean wait)

Sets the wait indicator.

This provides the default value for start().

Parameters:

wait - The wait indicator.

start

public void start()
           throws Exception

Starts the service.

Specified by:

start in interface ServiceActivatorBaseMBean

Overrides:

start in class ServiceActivatorBase

Throws:

Exception - As appropriate for the service.

start

public final void start(boolean wait)
                 throws Exception

Starts the service.

Parameters:

wait - True asks to wait until running.

Throws:

Exception - As appropriate for the service.

stop

public void stop()

Stops the service.

Specified by:

stop in interface ServiceActivatorBaseMBean

Overrides:

stop in class ServiceActivatorBase

updateStats

public final void updateStats()

Updates the stats.

Specified by:

updateStats in interface StatsOwner

Overrides:

updateStats in class ServiceActivatorBase

acceptMainArg

protected boolean acceptMainArg(String arg)

Accepts a main argument.

Overrides:

acceptMainArg in class ServiceActivatorBase

Parameters:

arg - An argument for main args.

Returns:

True if accepted.

createServiceImpl

@Nonnull
 @CheckReturnValue
protected abstract ServiceImpl createServiceImpl()

Creates the service implementation.

This must be implemented by the subclasses to provide the actual service.

Returns:

The service implementation.

createServiceImpl

@Nonnull
 @CheckReturnValue
protected final ServiceImpl createServiceImpl(@Nonnull
                                                                            Class<? extends ServiceImpl> serviceImplClass)

Creates a service implementation.

Parameters:

serviceImplClass - The class of the service implementation.

Returns:

The service implementation.

createServiceImpl

@Nullable
 @CheckReturnValue
protected final ServiceImpl createServiceImpl(@Nonnull
                                                                             ClassDef classDef)

Creates a service implementation.

Parameters:

classDef - The class definition for the service implementation.

Returns:

The service implementation (null on failure).

export

protected final void export()

Allows a subclass to export the JMX agent.

Overrides:

export in class ServiceActivatorBase

tearDownStandAlone

protected void tearDownStandAlone()

Tears down what has been set up in stand alone mode.

Overrides:

tearDownStandAlone in class ServiceActivatorBase