com.atlassian.jira.service.services.mail

Class MailQueueService

java.lang.Object

com.atlassian.jira.service.AbstractService

com.atlassian.jira.service.services.mail.MailQueueService

All Implemented Interfaces:

ObjectConfigurable, JiraService, LocalService, Runnable

public class MailQueueService
extends AbstractService
implements LocalService

Field Summary

Fields inherited from class com.atlassian.jira.service.AbstractService

log, name, SERVICE_EVENT

Fields inherited from interface com.atlassian.jira.service.JiraService

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
MailQueueService()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method is called when the service is unloaded (usually when the web application or server is being shut down).
ObjectConfiguration	getObjectConfiguration() Retrieves an object configuration object with properties that can be set
void	init(com.opensymphony.module.propertyset.PropertySet props) Initialise the service.
boolean	isInternal() By default, returns false.
boolean	isUnique() By default, services are not unique.
void	run() This method must be implemented in a subclass, and performs the functionality that the service performs.

Methods inherited from class com.atlassian.jira.service.AbstractService

getDefaultProperty, getDescription, getKey, getLongProperty, getName, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

MailQueueService

public MailQueueService()

Method Detail

run

public void run()

Description copied from class: AbstractService

This method must be implemented in a subclass, and performs the functionality that the service performs. This method is called after the duration specified through the administration web interface.

Specified by:

run in interface JiraService

Specified by:

run in interface Runnable

Specified by:

run in class AbstractService

See Also:

JiraService.init(com.opensymphony.module.propertyset.PropertySet)

init

public void init(com.opensymphony.module.propertyset.PropertySet props)
          throws ObjectConfigurationException

Description copied from interface: JiraService

Initialise the service. This method is guaranteed to be called before the first call to run().

As the parameters are gained from the user's interaction with the website, it is not guaranteed to be called with the correct, or indeed with any parameters.

init() may be called multiple times during the services lifetime.

Specified by:

init in interface JiraService

Overrides:

init in class AbstractService

Parameters:

props - initialisation parameters

Throws:

ObjectConfigurationException - in case of an error with initialisation parameters

isUnique

public boolean isUnique()

Description copied from class: AbstractService

By default, services are not unique.

Specified by:

isUnique in interface JiraService

Overrides:

isUnique in class AbstractService

Returns:

false.

isInternal

public boolean isInternal()

Description copied from class: AbstractService

By default, returns false.

Specified by:

isInternal in interface JiraService

Overrides:

isInternal in class AbstractService

Returns:

false

destroy

public void destroy()

Description copied from class: AbstractService

This method is called when the service is unloaded (usually when the web application or server is being shut down).

You may wish to remove any connections that you have established, eg. database connections.

Specified by:

destroy in interface JiraService

Overrides:

destroy in class AbstractService

getObjectConfiguration

public ObjectConfiguration getObjectConfiguration()
                                           throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Retrieves an object configuration object with properties that can be set

Specified by:

getObjectConfiguration in interface ObjectConfigurable

Returns:

ObjectConfiguration object

Throws:

ObjectConfigurationException