org.rvpf.service

Class ServiceActivatorBase

Object

NotificationBroadcasterSupport

StatsHolder

ServiceActivatorBase

All Implemented Interfaces:

MBeanRegistration, NotificationBroadcaster, NotificationEmitter, StatsOwner, ServiceActivatorBaseMBean, StatsHolderMBean

Direct Known Subclasses:

ServiceActivator

@ThreadSafe
public abstract class ServiceActivatorBase
extends StatsHolder
implements ServiceActivatorBaseMBean, MBeanRegistration

Base for service activator.

This class establishes the base behavior of RVPF services. It supports the create(), start(), stop() and destroy() sequence. It also can synthetize a default object name and supports standalone operation.

Nested Class Summary

Nested classes/interfaces inherited from class StatsHolder

StatsHolder.UpdateNotification

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_ARG_PREFIX Name argument prefix property.
static String	OBJECT_NAME_PROPERTY JMX 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
ServiceActivatorBase()

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptMainArg(String arg) Accepts a main argument.
void	create() Creates the service.
protected void	created() Completes the 'create' processing.
void	destroy() Destroys the service.
protected void	destroyed() Completes the 'destroy' processing.
boolean	equals(Object other)
protected void	export() Allows a subclass to export the JMX agent.
ObjectName	getObjectName() Gets the object name.
Properties	getProperties() Gets the MBean properties.
Optional<String>	getProperty(String key) Gets the value of a property.
protected MBeanServer	getServer() Gets the MBean server instance.
Optional<? extends Stats>	getStats() Gets the stats.
Version	getVersion() Gets the version object.
int	hashCode()
boolean	isRunning() Asks if the service is running.
boolean	isStopped() Asks if the service has been stopped.
void	postDeregister()
void	postRegister(Boolean done)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name) This implementation saves the MBeanServer reference for possible use by subclasses.
void	restart() Restarts the service.
void	restart(Optional<ElapsedTime> delay) Restarts the service.
protected void	run(String[] args) Runs the service.
void	setListener(ServiceActivatorListener listener) Sets the service listener.
void	setObjectNameProperty(Optional<String> propertyName) Sets the object name property.
void	setProperties(Properties properties) Sets the MBean properties.
void	setProperty(String key, String value) Sets a property.
void	start() Starts the service.
protected void	started() Completes the 'start' processing.
void	starting(Optional<ElapsedTime> waitHint) Informs that the start is progressing.
void	stop() Stops the service.
protected void	stopped() Completes the 'stop' processing.
void	stopping(Optional<ElapsedTime> waitHint) Informs that the stop is progressing.
protected void	tearDownStandAlone() Tears down what has been set up in stand alone mode.
void	terminate() Terminates the service.
String	toString()
void	updateStats() Updates the stats.

Methods inherited from class StatsHolder

getDefaultDomain, getObjectVersion, 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

isStarted

Methods inherited from interface StatsHolderMBean

getStatsStrings

Field Detail

NAME_ARG_PREFIX

public static final String NAME_ARG_PREFIX

Name argument prefix property.

See Also:

Constant Field Values

OBJECT_NAME_PROPERTY

public static final String OBJECT_NAME_PROPERTY

JMX object name property.

See Also:

Constant Field Values

Constructor Detail

ServiceActivatorBase

public ServiceActivatorBase()

Method Detail

create

public void create()
            throws Exception

Creates the service.

Specified by:

create in interface ServiceActivatorBaseMBean

Throws:

Exception - As appropriate for the service.

destroy

public void destroy()

Destroys the service.

Specified by:

destroy in interface ServiceActivatorBaseMBean

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

getObjectName

public final ObjectName getObjectName()

Gets the object name.

Specified by:

getObjectName in interface StatsOwner

Overrides:

getObjectName in class StatsHolder

Returns:

The object name.

getProperties

public final Properties getProperties()

Gets the MBean properties.

Specified by:

getProperties in interface ServiceActivatorBaseMBean

Returns:

The MBean properties.

getProperty

public final Optional<String> getProperty(String key)

Gets the value of a property.

Specified by:

getProperty in interface ServiceActivatorBaseMBean

Parameters:

key - The name of the property.

Returns:

The value of the property (may be empty).

getStats

public Optional<? extends Stats> getStats()

Gets the stats.

Specified by:

getStats in class StatsHolder

Returns:

The optional stats.

getVersion

@Nonnull
 @CheckReturnValue
public Version getVersion()

Gets the version object.

Returns:

The version object.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

isRunning

public boolean isRunning()

Asks if the service is running.

Specified by:

isRunning in interface ServiceActivatorBaseMBean

Returns:

True if the service is running.

isStopped

public boolean isStopped()

Asks if the service has been stopped.

Specified by:

isStopped in interface ServiceActivatorBaseMBean

Returns:

True if the service has been started stopped.

postDeregister

public final void postDeregister()

Specified by:

postDeregister in interface MBeanRegistration

postRegister

public final void postRegister(Boolean done)

Specified by:

postRegister in interface MBeanRegistration

preDeregister

public final void preDeregister()

Specified by:

preDeregister in interface MBeanRegistration

preRegister

public final ObjectName preRegister(MBeanServer server,
                                    ObjectName name)
                             throws Exception

This implementation saves the MBeanServer reference for possible use by subclasses. It also supplies a default name if none is given.

Specified by:

preRegister in interface MBeanRegistration

Throws:

Exception

restart

public void restart()
             throws Exception

Restarts the service.

Specified by:

restart in interface ServiceActivatorBaseMBean

Throws:

Exception - As appropriate for the service.

restart

public final void restart(@Nonnull
                          Optional<ElapsedTime> delay)
                   throws Exception

Restarts the service.

Parameters:

delay - An optional number of milliseconds to wait between the stop and the restart.

Throws:

Exception - As appropriate for the service.

setListener

public final void setListener(@Nonnull
                              ServiceActivatorListener listener)

Sets the service listener.

Parameters:

listener - The service listener.

setObjectNameProperty

public final void setObjectNameProperty(@Nonnull
                                        Optional<String> propertyName)

Sets the object name property.

Parameters:

propertyName - The optional object name property.

setProperties

public final void setProperties(Properties properties)

Sets the MBean properties.

Specified by:

setProperties in interface ServiceActivatorBaseMBean

Parameters:

properties - The MBean properties.

setProperty

public final void setProperty(String key,
                              String value)

Sets a property.

Specified by:

setProperty in interface ServiceActivatorBaseMBean

Parameters:

key - The name of the property.

value - The value of the property.

start

public void start()
           throws Exception

Starts the service.

Specified by:

start in interface ServiceActivatorBaseMBean

Throws:

Exception - As appropriate for the service.

starting

public final void starting(@Nonnull
                           Optional<ElapsedTime> waitHint)

Informs that the start is progressing.

Parameters:

waitHint - An optional dditional time in milliseconds.

stop

public void stop()

Stops the service.

Specified by:

stop in interface ServiceActivatorBaseMBean

stopping

public final void stopping(@Nonnull
                           Optional<ElapsedTime> waitHint)

Informs that the stop is progressing.

Parameters:

waitHint - An optional additional elapsed time.

terminate

public void terminate()

Terminates the service.

This is called by the service implementation or one of its children when an unexpected condition is detected.

toString

public final String toString()

Overrides:

toString in class Object

updateStats

public void updateStats()

Updates the stats.

Specified by:

updateStats in interface StatsOwner

Specified by:

updateStats in class StatsHolder

acceptMainArg

@CheckReturnValue
protected boolean acceptMainArg(@Nonnull
                                                   String arg)

Accepts a main argument.

Parameters:

arg - An argument for main args.

Returns:

True if accepted.

created

protected void created()

Completes the 'create' processing.

destroyed

protected void destroyed()

Completes the 'destroy' processing.

export

protected void export()

Allows a subclass to export the JMX agent.

getServer

@Nonnull
 @CheckReturnValue
protected final MBeanServer getServer()

Gets the MBean server instance.

Returns:

The MBean server instance.

run

protected final void run(@Nonnull
                         String[] args)

Runs the service.

Parameters:

args - The program arguments.

started

protected void started()

Completes the 'start' processing.

stopped

protected void stopped()

Completes the 'stop' processing.

tearDownStandAlone

protected void tearDownStandAlone()

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