org.rvpf.service

Interface ServiceActivatorBaseMBean

All Superinterfaces:

StatsHolderMBean

All Known Subinterfaces:

HTTPServerActivatorMBean, ServiceActivatorMBean

All Known Implementing Classes:

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

public interface ServiceActivatorBaseMBean
extends StatsHolderMBean

Service activator base MBean interface.

Method Summary

Modifier and Type	Method and Description
void	create() Creates the service.
void	destroy() Destroys the service.
Properties	getProperties() Gets the MBean properties.
Optional<String>	getProperty(String key) Gets the value of a property.
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.
void	restart() Restarts the service.
void	setProperties(Properties properties) Sets the MBean properties.
void	setProperty(String key, String value) Sets a property.
void	start() Starts the service.
void	stop() Stops the service.

Methods inherited from interface StatsHolderMBean

getStatsStrings

Method Detail

create

void create()
     throws Exception

Creates the service.

Throws:

Exception - As appropriate for the service.

destroy

void destroy()

Destroys the service.

getProperties

@Nonnull
 @CheckReturnValue
Properties getProperties()

Gets the MBean properties.

Returns:

The MBean properties.

getProperty

@Nonnull
 @CheckReturnValue
Optional<String> getProperty(@Nonnull
                                                           String key)

Gets the value of a property.

Parameters:

key - The name of the property.

Returns:

The value of the property (may be empty).

isRunning

@CheckReturnValue
boolean isRunning()

Asks if the service is running.

Returns:

True if the service is running.

isStarted

@CheckReturnValue
boolean isStarted()

Asks if the service has been started.

Returns:

True if the service has been started.

isStopped

@CheckReturnValue
boolean isStopped()

Asks if the service has been stopped.

Returns:

True if the service has been started stopped.

restart

void restart()
      throws Exception

Restarts the service.

Throws:

Exception - As appropriate for the service.

setProperties

void setProperties(@Nonnull
                   Properties properties)

Sets the MBean properties.

Parameters:

properties - The MBean properties.

setProperty

void setProperty(@Nonnull
                 String key,
                 @Nonnull
                 String value)

Sets a property.

Parameters:

key - The name of the property.

value - The value of the property.

start

void start()
    throws Exception

Starts the service.

Throws:

Exception - As appropriate for the service.

stop

void stop()

Stops the service.