com.atlassian.jira.service.services.cluster

Class ClusterMessageCleaningService

java.lang.Object

com.atlassian.jira.service.AbstractService

com.atlassian.jira.service.services.cluster.ClusterMessageCleaningService

All Implemented Interfaces:

ObjectConfigurable, JiraService, Runnable

public class ClusterMessageCleaningService
extends AbstractService

Service for flushing the cluster message table

Since:

v6.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	RETENTION_PERIOD

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
ClusterMessageCleaningService(OfBizClusterMessageStore ofBizClusterMessageStore, JiraDurationUtils jiraDurationUtils, JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method and Description
ObjectConfiguration	getObjectConfiguration() Retrieves an object configuration object with properties that can be set
long	getRetentionPeriod()
void	init(com.opensymphony.module.propertyset.PropertySet props) Initialise the service.
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

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

Methods inherited from class java.lang.Object

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

Field Detail

RETENTION_PERIOD

public static final String RETENTION_PERIOD

See Also:

Constant Field Values

Constructor Detail

ClusterMessageCleaningService

public ClusterMessageCleaningService(OfBizClusterMessageStore ofBizClusterMessageStore,
                                     JiraDurationUtils jiraDurationUtils,
                                     JiraAuthenticationContext jiraAuthenticationContext)

Method Detail

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

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)

getObjectConfiguration

public ObjectConfiguration getObjectConfiguration()
                                           throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Retrieves an object configuration object with properties that can be set

Returns:

ObjectConfiguration object

Throws:

ObjectConfigurationException

getRetentionPeriod

public long getRetentionPeriod()