com.atlassian.jira.service
Class JiraServiceContainerImpl

java.lang.Object
  extended by com.atlassian.jira.service.JiraServiceContainerImpl
All Implemented Interfaces:
com.atlassian.configurable.ObjectConfigurable, JiraService, JiraServiceContainer

public class JiraServiceContainerImpl
extends Object
implements JiraServiceContainer

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

JiraServiceContainerImpl

public JiraServiceContainerImpl(JiraService service,
                                Long id)
Method Detail

init

public void init(com.opensymphony.module.propertyset.PropertySet props)
          throws com.atlassian.configurable.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
Parameters:
props - initialisation parameters
Throws:
com.atlassian.configurable.ObjectConfigurationException - in case of an error with initialisation parameters

getAcceptedParams

public String[] getAcceptedParams()
Deprecated. 


run

public void run()
Perform the action of this service. The caller of this method assumes that no housekeeping has been done, and will call setLastRun() after the run() method.

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.

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

destroy

public void destroy()
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.

Specified by:
destroy in interface JiraService

isInternal

public boolean isInternal()
Indicates whether administrators can delete this service from within the web interface.

Generally only Atlassian services should return true from this.

Specified by:
isInternal in interface JiraService
Returns:
true if this service is internal to JIRA, false otherwise

getLastRun

public final long getLastRun()
The time that this service was last run. Generally this is called after the service has executed, to ensure that there is X delay between finish of previous run & start of the next one.

Specified by:
getLastRun in interface JiraServiceContainer
Returns:
The time in milliseconds that this service was last run.

setLastRun

public final void setLastRun()
Set the last run time to be the current time. As we do not assume that users will call this in their run method, all code that calls run() should also call this afterwards.

Specified by:
setLastRun in interface JiraServiceContainer
See Also:
run()

setDelay

public void setDelay(long delay)
Sets the delay between invocation of each service.

Specified by:
setDelay in interface JiraServiceContainer
Parameters:
delay - The time in milliseconds between runs of the service.

getDelay

public long getDelay()
The length of delay in milliseconds between runs of this service.

Specified by:
getDelay in interface JiraServiceContainer

isUnique

public boolean isUnique()
Description copied from interface: JiraService
Whether this service class should be unique. Some service are fine to have multiples, and some are not.

Having multiple backup services could be fine - perhaps you want to backup once an hour, and also once a day.

With other services, you may wish to enforce their uniqueness

Specified by:
isUnique in interface JiraService
Returns:
Whether this service class should be unique.

getDescription

public String getDescription()
Description copied from interface: JiraService
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.

Specified by:
getDescription in interface JiraService
Returns:
A HTML description of the service

getName

public String getName()
Description copied from interface: JiraService
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.
This is enforced when adding new services via the web interface.

The value of name does not effect the service, hence can be set to null

Specified by:
getName in interface JiraService
Returns:
The name of the service

setName

public void setName(String name)
Description copied from interface: JiraService
Used to set the service's name. For details on the services name see JiraService.getName()

Specified by:
setName in interface JiraService
Parameters:
name - service name to set

toString

public String toString()
Overrides:
toString in class Object

getObjectConfiguration

public com.atlassian.configurable.ObjectConfiguration getObjectConfiguration()
                                                                      throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
getObjectConfiguration in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

hasProperty

public boolean hasProperty(String propertyKey)
                    throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
hasProperty in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

getProperty

public String getProperty(String propertyKey)
                   throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
getProperty in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

getTextProperty

public String getTextProperty(String propertyKey)
                       throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
getTextProperty in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

getLongProperty

public Long getLongProperty(String propertyKey)
                     throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
getLongProperty in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

getDefaultProperty

public String getDefaultProperty(String propertyKey)
                          throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
getDefaultProperty in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

getProperties

public com.opensymphony.module.propertyset.PropertySet getProperties()
                                                              throws com.atlassian.configurable.ObjectConfigurationException
Specified by:
getProperties in interface com.atlassian.configurable.ObjectConfigurable
Throws:
com.atlassian.configurable.ObjectConfigurationException

isRunning

public boolean isRunning()
Whether a service is currently running. This is needed for services that may potentially run for longer than their delay period. Eg a service that is run every minute, but takes 2 mins to run.

Specified by:
isRunning in interface JiraServiceContainer

setRunning

public void setRunning(boolean running)
Specified by:
setRunning in interface JiraServiceContainer

getKey

public String getKey()
Specified by:
getKey in interface com.atlassian.configurable.ObjectConfigurable

getId

public Long getId()
Specified by:
getId in interface JiraServiceContainer

getServiceClass

public String getServiceClass()
Specified by:
getServiceClass in interface JiraServiceContainer

isUsable

public boolean isUsable()
Specified by:
isUsable in interface JiraServiceContainer


Copyright © 2002-2008 Atlassian. All Rights Reserved.