com.communote.server.core.service

Interface CommunoteService

All Known Subinterfaces:

CommunoteSingletonService

All Known Implementing Classes:

MailFetchingService, VirusScannerService, XMPPService

public interface CommunoteService

A component which provides some service functionality. A service can be enabled, disabled, started and stopped.

Author:

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

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the service that is used to address it in the CommunoteServiceManager.
boolean	isEnabled()
boolean	isRunning() Returns true if the service is currently running.
void	start(boolean triggeredLocally) Non-blocking function that starts the service.
void	stop() Stops the service and returns after the service was stopped.
boolean	supportsRestart() Returns whether the service can be restarted at runtime.

Method Detail

getName

String getName()

Returns the name of the service that is used to address it in the CommunoteServiceManager.

Returns:

the name of the service

isEnabled

boolean isEnabled()

Returns:

True, when the service is enabled, else false.

isRunning

boolean isRunning()

Returns true if the service is currently running.

Returns:

true if the service is running, false otherwise

start

void start(boolean triggeredLocally)

Non-blocking function that starts the service. It is not checked whether the service is enabled. The caller should do this.

Parameters:

triggeredLocally - true if the service was triggered on this Communote instance, false if it was triggered by an event from another Communote instance when running a clustered setup

stop

void stop()

Stops the service and returns after the service was stopped. If the service is not running nothing must happen.

supportsRestart

boolean supportsRestart()

Returns whether the service can be restarted at runtime. False should be returned if a restart would lead to loss of data.

Returns:

true if the service can be restarted when it is already running.