com.atlassian.jira.jelly.service
Class JellyService

java.lang.Object
  extended by com.atlassian.jira.service.AbstractService
      extended by com.atlassian.jira.jelly.service.JellyService
All Implemented Interfaces:
ObjectConfigurable, JiraService, Runnable

public class JellyService
extends AbstractService

Responsible for periodically running a Jelly script.


Field Summary
 
Fields inherited from class com.atlassian.jira.service.AbstractService
name
 
Fields inherited from interface com.atlassian.jira.service.JiraService
NAME_COMPARATOR
 
Constructor Summary
JellyService()
           
 
Method Summary
 ObjectConfiguration getObjectConfiguration()
          Retrieves an object configuration object with properties that can be set
 void init(com.opensymphony.module.propertyset.PropertySet props)
          Initialise the service.
 void run()
          This method must be implemented in a subclass, and performs the functionality that the service performs.
 
Methods inherited from class com.atlassian.jira.service.AbstractService
destroy, getDefaultProperty, getDescription, getKey, getLongProperty, getName, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty, isInternal, isUnique, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JellyService

public JellyService()
Method Detail

getObjectConfiguration

public ObjectConfiguration getObjectConfiguration()
                                           throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Retrieves an object configuration object with properties that can be set

Returns:
ObjectConfiguration object
Throws:
ObjectConfigurationException

init

public void init(com.opensymphony.module.propertyset.PropertySet props)
          throws ObjectConfigurationException
Description copied from interface: JiraService
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.

Specified by:
init in interface JiraService
Overrides:
init in class AbstractService
Parameters:
props - initialisation parameters
Throws:
ObjectConfigurationException - in case of an error with initialisation parameters

run

public void run()
Description copied from class: AbstractService
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.

Specified by:
run in interface JiraService
Specified by:
run in interface Runnable
Specified by:
run in class AbstractService
See Also:
JiraService.init(com.opensymphony.module.propertyset.PropertySet)


Copyright © 2002-2012 Atlassian. All Rights Reserved.