java.lang.Object | |
↳ | com.atlassian.jira.service.JiraServiceContainerImpl |
Proxies calls to JiraService and manages delay between calls.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.atlassian.jira.service.JiraService
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method is called when the service is unloaded (usually when the web application or server
is being shut down).
| |||||||||||
Returns the default property value for a key
| |||||||||||
The length of delay in milliseconds between runs of this service.
| |||||||||||
A textual description of the service.
| |||||||||||
Return the key of this object
| |||||||||||
The time that this service was last run.
| |||||||||||
Returns a property of this object with the specified key as a long
| |||||||||||
A textual name of the service as entered by the user from the web interface.
| |||||||||||
Retrieves an object configuration object with properties that can be set
| |||||||||||
Retrieve all the specified Properties for this object
| |||||||||||
Returns a property of this object with the specified key
| |||||||||||
Returns a property of this object with the specified key, the property is of type text
| |||||||||||
Checks if this object has a particular property
| |||||||||||
Initialise the service.
| |||||||||||
Is this service due to run at the specified time.
| |||||||||||
Indicates whether administrators can delete this service from within the web interface.
| |||||||||||
Returns true if in a clustered environment this service should run locally on every node.
| |||||||||||
Whether a service is currently running.
| |||||||||||
Whether this service class should be unique.
| |||||||||||
Perform the action of this service.
| |||||||||||
Sets the delay between invocation of each service.
| |||||||||||
Set the last run time to be the current time.
| |||||||||||
Used to set the service's name.
| |||||||||||
[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
|
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.Returns the default property value for a key
propertyKey | String key used to retrieve the properties default value |
---|
ObjectConfigurationException |
---|
The length of delay in milliseconds between runs of this service.
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.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 a property of this object with the specified key as a long
propertyKey | String key used to retrieve the property value |
---|
ObjectConfigurationException |
---|
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.Retrieves an object configuration object with properties that can be set
ObjectConfigurationException |
---|
Retrieve all the specified Properties for this object
ObjectConfigurationException |
---|
Returns a property of this object with the specified key
propertyKey | String key used to retrieve the property value |
---|
ObjectConfigurationException |
---|
Returns a property of this object with the specified key, the property is of type text
propertyKey | String key used to retrieve the property value |
---|
ObjectConfigurationException |
---|
Checks if this object has a particular property
propertyKey | to look for |
---|
ObjectConfigurationException |
---|
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.props | initialisation parameters |
---|
ObjectConfigurationException |
---|
Is this service due to run at the specified time.
time | the time to check whether it is due. |
---|
Indicates whether administrators can delete this service from within the web interface.
Generally only Atlassian services should return true from this.Returns true if in a clustered environment this service should run locally on every node.
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.
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 uniquenessPerform 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.Sets the delay between invocation of each service.
delay | The time in milliseconds between runs of the service. |
---|
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.
Used to set the service's name. For details on the services name see getName()
name | service name to set |
---|