|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.service.AbstractService
public abstract class AbstractService
A convenience class - if you extend this class, all that needs to be implemented is run()
Field Summary | |
---|---|
protected org.apache.log4j.Category |
log
|
protected String |
name
|
Fields inherited from interface com.atlassian.jira.service.JiraService |
---|
NAME_COMPARATOR |
Constructor Summary | |
---|---|
AbstractService()
|
Method Summary | |
---|---|
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)
|
String |
getDescription()
A textual description of the service. |
String |
getKey()
|
Long |
getLongProperty(String propertyKey)
|
String |
getName()
A textual name of the service as entered by the user from the web interface. |
protected com.atlassian.configurable.ObjectConfiguration |
getObjectConfiguration(String id,
String xmlfile,
Map params)
|
com.opensymphony.module.propertyset.PropertySet |
getProperties()
|
String |
getProperty(String propertyKey)
|
String |
getTextProperty(String propertyKey)
|
boolean |
hasProperty(String propertyKey)
|
void |
init(com.opensymphony.module.propertyset.PropertySet props)
Initialise the service. |
boolean |
isInternal()
Indicates whether administrators can delete this service from within the web interface. |
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.configurable.ObjectConfigurable |
---|
getObjectConfiguration |
Field Detail |
---|
protected org.apache.log4j.Category log
protected String name
Constructor Detail |
---|
public AbstractService()
Method Detail |
---|
public abstract void run()
run
in interface JiraService
JiraService.init(com.opensymphony.module.propertyset.PropertySet)
public void init(com.opensymphony.module.propertyset.PropertySet props) throws com.atlassian.configurable.ObjectConfigurationException
JiraService
init
in interface JiraService
com.atlassian.configurable.ObjectConfigurationException
public void destroy()
You may wish to remove any connections that you have established, eg. database connections.
destroy
in interface JiraService
public boolean isInternal()
JiraService
isInternal
in interface JiraService
public String getKey()
getKey
in interface com.atlassian.configurable.ObjectConfigurable
public boolean isUnique()
isUnique
in interface JiraService
public String getDescription()
JiraService
getDescription
in interface JiraService
public boolean hasProperty(String propertyKey) throws com.atlassian.configurable.ObjectConfigurationException
hasProperty
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
public String getProperty(String propertyKey) throws com.atlassian.configurable.ObjectConfigurationException
getProperty
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
public String getTextProperty(String propertyKey) throws com.atlassian.configurable.ObjectConfigurationException
getTextProperty
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
public Long getLongProperty(String propertyKey) throws com.atlassian.configurable.ObjectConfigurationException
getLongProperty
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
public String getDefaultProperty(String propertyKey) throws com.atlassian.configurable.ObjectConfigurationException
getDefaultProperty
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
public com.opensymphony.module.propertyset.PropertySet getProperties() throws com.atlassian.configurable.ObjectConfigurationException
getProperties
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
protected com.atlassian.configurable.ObjectConfiguration getObjectConfiguration(String id, String xmlfile, Map params) throws com.atlassian.configurable.ObjectConfigurationException
com.atlassian.configurable.ObjectConfigurationException
public String getName()
JiraService
getName
in interface JiraService
public void setName(String name)
JiraService
JiraService.getName()
setName
in interface JiraService
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |