|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.service.JiraServiceContainerImpl
public class JiraServiceContainerImpl
Proxies calls to JiraService & manages delay between calls.
Field Summary |
---|
Fields inherited from interface com.atlassian.jira.service.JiraService |
---|
NAME_COMPARATOR |
Constructor Summary | |
---|---|
JiraServiceContainerImpl(JiraService service,
Long id)
|
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[] |
getAcceptedParams()
Deprecated. |
String |
getDefaultProperty(String propertyKey)
|
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()
|
long |
getLastRun()
The time that this service was last run. |
Long |
getLongProperty(String propertyKey)
|
String |
getName()
A textual name of the service as entered by the user from the web interface. |
com.atlassian.configurable.ObjectConfiguration |
getObjectConfiguration()
|
com.opensymphony.module.propertyset.PropertySet |
getProperties()
|
String |
getProperty(String propertyKey)
|
String |
getServiceClass()
|
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 |
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 |
setDelay(long delay)
Sets the delay between invocation of each service. |
void |
setLastRun()
Set the last run time to be the current time. |
void |
setName(String name)
Used to set the service's name. |
void |
setRunning(boolean running)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public JiraServiceContainerImpl(JiraService service, Long id)
Method Detail |
---|
public void init(com.opensymphony.module.propertyset.PropertySet props) throws com.atlassian.configurable.ObjectConfigurationException
JiraService
init
in interface JiraService
com.atlassian.configurable.ObjectConfigurationException
public String[] getAcceptedParams()
public void run()
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.
run
in interface JiraService
JiraService.init(com.opensymphony.module.propertyset.PropertySet)
public void destroy()
You may wish to remove any connections that you have established, eg. database connections.
destroy
in interface JiraService
public boolean isInternal()
Generally only Atlassian services should return true from this.
isInternal
in interface JiraService
public final long getLastRun()
getLastRun
in interface JiraServiceContainer
public final void setLastRun()
setLastRun
in interface JiraServiceContainer
run()
public void setDelay(long delay)
setDelay
in interface JiraServiceContainer
delay
- The time in milliseconds between runs of the service.public long getDelay()
getDelay
in interface JiraServiceContainer
public boolean isUnique()
JiraService
isUnique
in interface JiraService
public String getDescription()
JiraService
getDescription
in interface JiraService
public String getName()
JiraService
getName
in interface JiraService
public void setName(String name)
JiraService
JiraService.getName()
setName
in interface JiraService
public String toString()
toString
in class Object
public com.atlassian.configurable.ObjectConfiguration getObjectConfiguration() throws com.atlassian.configurable.ObjectConfigurationException
getObjectConfiguration
in interface com.atlassian.configurable.ObjectConfigurable
com.atlassian.configurable.ObjectConfigurationException
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
public boolean isRunning()
isRunning
in interface JiraServiceContainer
public void setRunning(boolean running)
setRunning
in interface JiraServiceContainer
public String getKey()
getKey
in interface com.atlassian.configurable.ObjectConfigurable
public Long getId()
getId
in interface JiraServiceContainer
public String getServiceClass()
getServiceClass
in interface JiraServiceContainer
public boolean isUsable()
isUsable
in interface JiraServiceContainer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |