public class

JiraServiceContainerImpl

extends Object
implements JiraServiceContainer
java.lang.Object
   ↳ com.atlassian.jira.service.JiraServiceContainerImpl

Class Overview

Proxies calls to JiraService and manages scheduling.

Summary

[Expand]
Inherited Fields
From interface com.atlassian.jira.service.JiraService
Public Constructors
JiraServiceContainerImpl(JiraService service, Long id)
Public Methods
void destroy()
This method is called when the service is unloaded (usually when the web application or server is being shut down).
String getCronExpression()
Get the cron expression.
String getDefaultProperty(String propertyKey)
Returns the default property value for a key
long getDelay()
The length of delay in milliseconds between runs of this service.
String getDescription()
A textual description of the service.
Long getId()
String getKey()
Return the key of this object
final long getLastRun()
The time that this service was last run.
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.
ObjectConfiguration getObjectConfiguration()
Retrieves an object configuration object with properties that can be set
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 getServiceClass()
@Nonnull Class<? extends JiraService> getServiceClassObject()
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(PropertySet props)
Initialise the service.
boolean isDueAt(long time)
Is this service due to run at the specified time.
boolean isInternal()
Indicates whether administrators can delete this service from within the web interface.
boolean isLocalService()
Returns true if in a clustered environment this service should run locally on every node.
boolean isRunning()
Whether a service is currently running.
boolean isUnique()
Whether this service class should be unique.
boolean isUsable()
void run()
Perform the action of this service.
void setCronExpression(String cronExpression)
Set the cron expression.
void setDelay(long delay)
Sets the delay between invocation of each service.
final void setLastRun()
Set the last run time to be the current time.
void setName(String name)
Used to set the service's name.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.configurable.ObjectConfigurable
From interface com.atlassian.jira.service.JiraService
From interface com.atlassian.jira.service.JiraServiceContainer
From interface java.lang.Runnable

Public Constructors

public JiraServiceContainerImpl (JiraService service, Long id)

Public Methods

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.

public String getCronExpression ()

Get the cron expression.

Returns
  • cron Cron Expression

public String getDefaultProperty (String propertyKey)

Returns the default property value for a key

Parameters
propertyKey String key used to retrieve the properties default value
Returns
  • Default property key
Throws
ObjectConfigurationException

public long getDelay ()

The length of delay in milliseconds between runs of this service.

Returns
  • the interval delay for scheduling the service

public String getDescription ()

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.

Returns
  • A HTML description of the service

public Long getId ()

public String getKey ()

Return the key of this object

Returns
  • Key of object

public final long getLastRun ()

The time that this service was last run. Generally this is called after the service has executed, to ensure that there is X delay between finish of previous run & start of the next one.

Returns
  • The time in milliseconds that this service was last run.

public Long getLongProperty (String propertyKey)

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

Parameters
propertyKey String key used to retrieve the property value
Returns
  • Property value
Throws
ObjectConfigurationException

public String getName ()

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

Returns
  • The name of the service

public ObjectConfiguration getObjectConfiguration ()

Retrieves an object configuration object with properties that can be set

Returns
  • ObjectConfiguration object
Throws
ObjectConfigurationException

public PropertySet getProperties ()

Retrieve all the specified Properties for this object

Returns
  • Set of properties for this object
Throws
ObjectConfigurationException

public String getProperty (String propertyKey)

Returns a property of this object with the specified key

Parameters
propertyKey String key used to retrieve the property value
Returns
  • Property value
Throws
ObjectConfigurationException

public String getServiceClass ()

@Nonnull public Class<? extends JiraService> getServiceClassObject ()

public String getTextProperty (String propertyKey)

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

Parameters
propertyKey String key used to retrieve the property value
Returns
  • Property value
Throws
ObjectConfigurationException

public boolean hasProperty (String propertyKey)

Checks if this object has a particular property

Parameters
propertyKey to look for
Returns
  • true If there is a value
Throws
ObjectConfigurationException

public void init (PropertySet props)

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.

Parameters
props initialisation parameters
Throws
ObjectConfigurationException

public boolean isDueAt (long time)

Is this service due to run at the specified time.

Parameters
time the time to check whether it is due.
Returns
  • true if due.

public boolean isInternal ()

Indicates whether administrators can delete this service from within the web interface.

Generally only Atlassian services should return true from this.

Returns
  • true if this service is internal to JIRA, false otherwise

public boolean isLocalService ()

Returns true if in a clustered environment this service should run locally on every node.

Returns
  • true if in a clustered environment this service should run locally on every node.

public boolean isRunning ()

Whether a service is currently running. This is needed for services that may potentially run for longer than their delay period. Eg a service that is run every minute, but takes 2 mins to run.

public boolean isUnique ()

Whether this service class should be unique. Some service are fine to have multiples, and some are not.

Having multiple backup services could be fine - perhaps you want to backup once an hour, and also once a day.

With other services, you may wish to enforce their uniqueness

Returns
  • Whether this service class should be unique.

public boolean isUsable ()

public void run ()

Perform the action of this service. The caller of this method assumes that no housekeeping has been done, and will call setLastRun() after the run() method.

init() is guaranteed to be called before run(), but the parameters passed to init() are not guaranteed to be correct. Any parameters expected to be set by init() should be checked in this method upon each invocation.

See Also

public void setCronExpression (String cronExpression)

Set the cron expression.

Parameters
cronExpression Cron Expression

public void setDelay (long delay)

Sets the delay between invocation of each service.

Parameters
delay The time in milliseconds between runs of the service.

public final void setLastRun ()

Set the last run time to be the current time. As we do not assume that users will call this in their run method, all code that calls run() should also call this afterwards.

See Also

public void setName (String name)

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

Parameters
name service name to set

public String toString ()