com.communote.server.core.mail.fetching

Class MailFetchingService

java.lang.Object

com.communote.server.core.mail.fetching.MailFetchingService

All Implemented Interfaces:

CommunoteService, CommunoteSingletonService

public class MailFetchingService
extends Object
implements CommunoteSingletonService

Service that fetches e-mails from an external server and creates notes.

Author:

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

Constructor Summary

Constructors

Constructor and Description
MailFetchingService(String name) Creates a new MailFetching service with the given name.

Method Summary

Modifier and Type	Method and Description
static MailFetchingService	createDefaultMailFetchingService() Factory method to create the default mail fetching service.
protected MailFetcher	getMailFetcher()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailFetchingService

public MailFetchingService(String name)

Creates a new MailFetching service with the given name.

Parameters:

name - the name of the service

Method Detail

createDefaultMailFetchingService

public static MailFetchingService createDefaultMailFetchingService()

Factory method to create the default mail fetching service.

Returns:

the mail fetching service

getMailFetcher

protected MailFetcher getMailFetcher()

getName

public String getName()

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

Specified by:

getName in interface CommunoteService

Returns:

the name of the service

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface CommunoteService

Returns:

True, when the service is enabled, else false.

isRunning

public boolean isRunning()

Returns true if the service is currently running.

Specified by:

isRunning in interface CommunoteService

Returns:

true if the service is running, false otherwise

start

public 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.

Specified by:

start in interface CommunoteService

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

public void stop()

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

Specified by:

stop in interface CommunoteService

supportsRestart

public boolean supportsRestart()

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

Specified by:

supportsRestart in interface CommunoteService

Returns:

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