java.lang.Object | |
↳ | com.atlassian.jira.service.AbstractService |
Known Direct Subclasses |
Known Indirect Subclasses |
Clients of @PublicSpi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicSpi
as per each product's API policy (clients should refer to each product's API policy for
the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).
@PublicSpi
interfaces and classes are specifically designed to be implemented/extended by clients.
Hence, the guarantee of binary compatibility is different to that of @PublicApi
elements (if an element
is both @PublicApi
and @PublicSpi
, both guarantees apply).
A convenience class - if you extend this class, all that needs to be implemented is run()
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | SERVICE_EVENT |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
log | |||||||||||
name |
[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
| |||||||||||
A textual description of the service.
| |||||||||||
Return the key of this object
| |||||||||||
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.
| |||||||||||
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.
| |||||||||||
By default, returns false.
| |||||||||||
By default, services are not unique.
| |||||||||||
This method must be implemented in a subclass, and performs the functionality
that the service performs.
| |||||||||||
Used to set the service's name.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.configurable.ObjectConfigurable
| |||||||||||
From interface
com.atlassian.jira.service.JiraService
| |||||||||||
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 |
---|
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 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.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 |
---|
By default, returns false.
By default, services are not unique.
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.
Used to set the service's name. For details on the services name see getName()
name | service name to set |
---|
ObjectConfigurationException |
---|