com.atlassian.jira.service

Class AbstractService

java.lang.Object

com.atlassian.jira.service.AbstractService

All Implemented Interfaces:

ObjectConfigurable, JiraService, Runnable

Direct Known Subclasses:

AbstractMessageHandlingService, AuditLogCleaningService, CacheFlusher, ClusterMessageCleaningService, DebugService, ExportService, ImapService, IndexSnapshotService, JiraHomeReplicatorService, MailQueueService, NodeStateCheckerService, PopService, ReplicatedIndexCleaningService

@PublicSpi
public abstract class AbstractService
extends Object
implements JiraService

A convenience class - if you extend this class, all that needs to be implemented is run()

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	log
protected String	name
static String	SERVICE_EVENT

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

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractService()

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).
String	getDefaultProperty(String propertyKey) Returns the default property value for a key
String	getDescription() A textual description of the service.
String	getKey() Return the key of this object
Long	getLongProperty(String propertyKey) Returns a property of this object with the specified key as a long
String	getName() A textual name of the service as entered by the user from the web interface.
protected ObjectConfiguration	getObjectConfiguration(String id, String xmlfile, Map<String,String[]> params)
com.opensymphony.module.propertyset.PropertySet	getProperties() Retrieve all the specified Properties for this object
String	getProperty(String propertyKey) Returns a property of this object with the specified key
String	getTextProperty(String propertyKey) Returns a property of this object with the specified key, the property is of type text
boolean	hasProperty(String propertyKey) Checks if this object has a particular property
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.
abstract void	run() This method must be implemented in a subclass, and performs the functionality that the service performs.
void	setName(String name) Used to set the service's name.

Methods inherited from class java.lang.Object

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

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

init

Methods inherited from interface com.atlassian.configurable.ObjectConfigurable

getObjectConfiguration

Field Detail

SERVICE_EVENT

public static final String SERVICE_EVENT

See Also:

Constant Field Values

log

protected org.apache.log4j.Logger log

name

protected String name

Constructor Detail

AbstractService

public AbstractService()

Method Detail

run

public abstract void run()

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

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

Parameters:

props - initialisation parameters

Throws:

ObjectConfigurationException - in case of an error with initialisation parameters

See Also:

JiraService.init(PropertySet, long)

destroy

public void destroy()

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

isInternal

public boolean isInternal()

By default, returns false.

Specified by:

isInternal in interface JiraService

Returns:

false

getKey

public String getKey()

Description copied from interface: ObjectConfigurable

Return the key of this object

Specified by:

getKey in interface ObjectConfigurable

Returns:

Key of object

isUnique

public boolean isUnique()

By default, services are not unique.

Specified by:

isUnique in interface JiraService

Returns:

false.

getDescription

public String getDescription()

Description copied from interface: JiraService

A textual description of the service. You can include HTML if required, but do not use tables, or DHTML, as the description may be displayed inside tables / frames.

A good description will describe what this service does, and then explains the parameters required for configuring the service.

If no description is appropriate, return null.

Specified by:

getDescription in interface JiraService

Returns:

A HTML description of the service

hasProperty

public boolean hasProperty(String propertyKey)
                    throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Checks if this object has a particular property

Specified by:

hasProperty in interface ObjectConfigurable

Parameters:

propertyKey - to look for

Returns:

true If there is a value

Throws:

ObjectConfigurationException

getProperty

public String getProperty(String propertyKey)
                   throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Returns a property of this object with the specified key

Specified by:

getProperty in interface ObjectConfigurable

Parameters:

propertyKey - String key used to retrieve the property value

Returns:

Property value

Throws:

ObjectConfigurationException

getTextProperty

public String getTextProperty(String propertyKey)
                       throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Returns a property of this object with the specified key, the property is of type text

Specified by:

getTextProperty in interface ObjectConfigurable

Parameters:

propertyKey - String key used to retrieve the property value

Returns:

Property value

Throws:

ObjectConfigurationException

getLongProperty

public Long getLongProperty(String propertyKey)
                     throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Returns a property of this object with the specified key as a long

Specified by:

getLongProperty in interface ObjectConfigurable

Parameters:

propertyKey - String key used to retrieve the property value

Returns:

Property value

Throws:

ObjectConfigurationException

getDefaultProperty

public String getDefaultProperty(String propertyKey)
                          throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Returns the default property value for a key

Specified by:

getDefaultProperty in interface ObjectConfigurable

Parameters:

propertyKey - String key used to retrieve the properties default value

Returns:

Default property key

Throws:

ObjectConfigurationException

getProperties

public com.opensymphony.module.propertyset.PropertySet getProperties()
                                                              throws ObjectConfigurationException

Description copied from interface: ObjectConfigurable

Retrieve all the specified Properties for this object

Specified by:

getProperties in interface ObjectConfigurable

Returns:

Set of properties for this object

Throws:

ObjectConfigurationException

getObjectConfiguration

protected ObjectConfiguration getObjectConfiguration(String id,
                                                     String xmlfile,
                                                     Map<String,String[]> params)
                                              throws ObjectConfigurationException

Throws:

ObjectConfigurationException

getName

public String getName()

Description copied from interface: JiraService

A textual name of the service as entered by the user from the web interface.

The name should be unique to identify services of the same class.
This is enforced when adding new services via the web interface.

The value of name does not effect the service, hence can be set to null

Specified by:

getName in interface JiraService

Returns:

The name of the service

setName

public void setName(String name)

Description copied from interface: JiraService

Used to set the service's name. For details on the services name see JiraService.getName()

Specified by:

setName in interface JiraService

Parameters:

name - service name to set