|
||||||||||
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 and 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 |
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 |
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 |
com.opensymphony.module.propertyset.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()
|
Class |
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(com.opensymphony.module.propertyset.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 |
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. |
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 ObjectConfigurationException
JiraService
init
in interface JiraService
props
- initialisation parameters
ObjectConfigurationException
- in case of an error with initialisation parameterspublic void run()
run
in interface JiraService
run
in interface Runnable
JiraService.init(com.opensymphony.module.propertyset.PropertySet)
public void destroy()
destroy
in interface JiraService
public boolean isInternal()
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 isDueAt(long time)
JiraServiceContainer
isDueAt
in interface JiraServiceContainer
time
- the time to check whether it is due.
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
name
- service name to setpublic ObjectConfiguration getObjectConfiguration() throws ObjectConfigurationException
ObjectConfigurable
getObjectConfiguration
in interface ObjectConfigurable
ObjectConfigurationException
public boolean hasProperty(String propertyKey) throws ObjectConfigurationException
ObjectConfigurable
hasProperty
in interface ObjectConfigurable
propertyKey
- to look for
ObjectConfigurationException
public String getProperty(String propertyKey) throws ObjectConfigurationException
ObjectConfigurable
getProperty
in interface ObjectConfigurable
propertyKey
- String key used to retrieve the property value
ObjectConfigurationException
public String getTextProperty(String propertyKey) throws ObjectConfigurationException
ObjectConfigurable
getTextProperty
in interface ObjectConfigurable
propertyKey
- String key used to retrieve the property value
ObjectConfigurationException
public Long getLongProperty(String propertyKey) throws ObjectConfigurationException
ObjectConfigurable
getLongProperty
in interface ObjectConfigurable
propertyKey
- String key used to retrieve the property value
ObjectConfigurationException
public String getDefaultProperty(String propertyKey) throws ObjectConfigurationException
ObjectConfigurable
getDefaultProperty
in interface ObjectConfigurable
propertyKey
- String key used to retrieve the properties default value
ObjectConfigurationException
public com.opensymphony.module.propertyset.PropertySet getProperties() throws ObjectConfigurationException
ObjectConfigurable
getProperties
in interface ObjectConfigurable
ObjectConfigurationException
public boolean isRunning()
isRunning
in interface JiraServiceContainer
public String getKey()
ObjectConfigurable
getKey
in interface ObjectConfigurable
public Long getId()
getId
in interface JiraServiceContainer
public String getServiceClass()
getServiceClass
in interface JiraServiceContainer
@Nonnull public Class getServiceClassObject()
getServiceClassObject
in interface JiraServiceContainer
public boolean isUsable()
isUsable
in interface JiraServiceContainer
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |