com.atlassian.jira.service
Class MockJiraServiceContainer

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

public class MockJiraServiceContainer
extends Object
implements JiraServiceContainer


Nested Class Summary
static class MockJiraServiceContainer.Builder
           
 
Field Summary
 
Fields inherited from interface com.atlassian.jira.service.JiraService
NAME_COMPARATOR
 
Method Summary
 void destroy()
          This method is called when the service is unloaded (usually when the web application or server is being shut down).
 boolean equals(Object obj)
           
 String getDefaultProperty(String propertyKey)
          Returns the default property value for a key
 long getDelay()
           
 String getDescription()
          A textual description of the service.
 Long getId()
           
 String getKey()
          Return the key of this object
 long getLastRun()
           
 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()
           
 boolean isUnique()
          Whether this service class should be unique.
 boolean isUsable()
           
 void run()
          Perform the action of this service.
 void setDelay(long delay)
           
 void setLastRun()
          Record when run.
 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getDelay

public long getDelay()
Specified by:
getDelay in interface JiraServiceContainer

getId

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

getLastRun

public long getLastRun()
Specified by:
getLastRun in interface JiraServiceContainer

isDueAt

public boolean isDueAt(long time)
Description copied from interface: JiraServiceContainer
Is this service due to run at the specified time.

Specified by:
isDueAt in interface JiraServiceContainer
Parameters:
time - the time to check whether it is due.
Returns:
true if due.

getServiceClass

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

getServiceClassObject

public Class getServiceClassObject()
Specified by:
getServiceClassObject in interface JiraServiceContainer
Returns:
the Class object of the underlying service, or null if service could not be loaded

isRunning

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

isUsable

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

setDelay

public void setDelay(long delay)
Specified by:
setDelay in interface JiraServiceContainer

setLastRun

public void setLastRun()
Description copied from interface: JiraServiceContainer
Record when run.

Specified by:
setLastRun in interface JiraServiceContainer

setRunning

public void setRunning(boolean running)

destroy

public void destroy()
Description copied from interface: JiraService
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

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

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
Parameters:
props - initialisation parameters
Throws:
ObjectConfigurationException - in case of an error with initialisation parameters

isInternal

public boolean isInternal()
Description copied from interface: JiraService
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

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.

run

public void run()
Description copied from interface: JiraService
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
Specified by:
run in interface Runnable
See Also:
JiraService.init(com.opensymphony.module.propertyset.PropertySet)

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

getDefaultProperty

public String getDefaultProperty(String propertyKey)
                          throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Returns the default property value for a key

Specified by:
getDefaultProperty in interface ObjectConfigurable
Parameters:
propertyKey - String key used to retrieve the properties default value
Returns:
Default property key
Throws:
ObjectConfigurationException

getKey

public String getKey()
Description copied from interface: ObjectConfigurable
Return the key of this object

Specified by:
getKey in interface ObjectConfigurable
Returns:
Key of object

getLongProperty

public Long getLongProperty(String propertyKey)
                     throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Returns a property of this object with the specified key as a long

Specified by:
getLongProperty in interface ObjectConfigurable
Parameters:
propertyKey - String key used to retrieve the property value
Returns:
Property value
Throws:
ObjectConfigurationException

getObjectConfiguration

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

Specified by:
getObjectConfiguration in interface ObjectConfigurable
Returns:
ObjectConfiguration object
Throws:
ObjectConfigurationException

getProperties

public com.opensymphony.module.propertyset.PropertySet getProperties()
                                                              throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Retrieve all the specified Properties for this object

Specified by:
getProperties in interface ObjectConfigurable
Returns:
Set of properties for this object
Throws:
ObjectConfigurationException

getProperty

public String getProperty(String propertyKey)
                   throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Returns a property of this object with the specified key

Specified by:
getProperty in interface ObjectConfigurable
Parameters:
propertyKey - String key used to retrieve the property value
Returns:
Property value
Throws:
ObjectConfigurationException

getTextProperty

public String getTextProperty(String propertyKey)
                       throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Returns a property of this object with the specified key, the property is of type text

Specified by:
getTextProperty in interface ObjectConfigurable
Parameters:
propertyKey - String key used to retrieve the property value
Returns:
Property value
Throws:
ObjectConfigurationException

hasProperty

public boolean hasProperty(String propertyKey)
                    throws ObjectConfigurationException
Description copied from interface: ObjectConfigurable
Checks if this object has a particular property

Specified by:
hasProperty in interface ObjectConfigurable
Parameters:
propertyKey - to look for
Returns:
true If there is a value
Throws:
ObjectConfigurationException

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2002-2014 Atlassian. All Rights Reserved.