com.communote.server.core.service

Class CommunoteServiceManager

java.lang.Object

com.communote.server.core.service.CommunoteServiceManager

All Implemented Interfaces:

EventListener<RestartServiceEvent>

public class CommunoteServiceManager
extends Object
implements EventListener<RestartServiceEvent>

Manages all CommunoteService instances.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
CommunoteServiceManager()

Method Summary

Modifier and Type	Method and Description
String	getNameOfService(Class<? extends CommunoteService> serviceClass) Returns the name of the registered service that has the provided class.
Class<RestartServiceEvent>	getObservedEvent() Defines the types of events about which this listener will be informed.
void	handle(RestartServiceEvent event) Is called by the EventDispatcher when the observed event was fired.
boolean	isRunning(String serviceName) Returns whether the named service is running.
boolean	registerService(CommunoteService service) Registers the service if it is not yet registered.
boolean	registerService(CommunoteService service, boolean start) Registers the service if it is not yet registered.
void	restart(String serviceName) Stops a service by name and restarts it afterwards.
void	shutdown() Stops and unregisters all running services.
void	start(String serviceName) Starts a service by name.
void	stop(String serviceName) Stops a service by name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommunoteServiceManager

public CommunoteServiceManager()

Method Detail

getNameOfService

public String getNameOfService(Class<? extends CommunoteService> serviceClass)

Returns the name of the registered service that has the provided class. In case there is no registered service instance of that class null is returned. In case there is more than one service instance of the provided class the name of the first matching is returned.

Parameters:

serviceClass - the class of the service

Returns:

the name of the service or null

getObservedEvent

public Class<RestartServiceEvent> getObservedEvent()

Defines the types of events about which this listener will be informed.

Specified by:

getObservedEvent in interface EventListener<RestartServiceEvent>

Returns:

the class of the observed event

handle

public void handle(RestartServiceEvent event)

Is called by the EventDispatcher when the observed event was fired.

Specified by:

handle in interface EventListener<RestartServiceEvent>

Parameters:

event - the event that was fired

isRunning

public boolean isRunning(String serviceName)

Returns whether the named service is running. If there is no registered service that has the provided name false is returned, otherwise the return value is the value of CommunoteService.isRunning() of the named service.

Parameters:

serviceName - the name of the service whose status is to be returned

Returns:

true if the service was started and not stopped in the meanwhile

registerService

public boolean registerService(CommunoteService service)

Registers the service if it is not yet registered. The service is identified by the name returned by CommunoteService.getName().

Parameters:

service - the service to register

Returns:

true if the service was registered, false if it was already registered, cannot be registered on this instance or shutdown() had been called

registerService

public boolean registerService(CommunoteService service,
                               boolean start)

Registers the service if it is not yet registered. The service is identified by the name returned by CommunoteService.getName().

Parameters:

service - the service to register

start - whether to directly start the service after registering

Returns:

true if the service was registered, false if it was already registered, cannot be registered on this instance or shutdown() had been called

restart

public void restart(String serviceName)

Stops a service by name and restarts it afterwards. If the service is not registered nothing will happen.

Parameters:

serviceName - the name of the service to restart

shutdown

public void shutdown()

Stops and unregisters all running services.

start

public void start(String serviceName)

Starts a service by name. If the service is not registered or is already running nothing will happen.

Parameters:

serviceName - the name of the service to start

stop

public void stop(String serviceName)

Stops a service by name. If the service is not registered nothing will happen.

Parameters:

serviceName - the name of the service to stop