com.atlassian.jira.service.services.export
Class ExportService

java.lang.Object
  extended by com.atlassian.jira.service.AbstractService
      extended by com.atlassian.jira.service.services.export.ExportService
All Implemented Interfaces:
ObjectConfigurable, JiraService, java.lang.Runnable

public class ExportService
extends AbstractService


Field Summary
static java.lang.String DIR_NAME
           
static java.lang.String EXPORT_SUBDIRECTORY
          The subdirectory of jira-home that exports go to when we use the default directory
static java.lang.String OPT_DATE_FORMAT
           
static java.lang.String USE_DEFAULT_DIRECTORY
           
static java.lang.String USEZIP
           
 
Fields inherited from class com.atlassian.jira.service.AbstractService
name
 
Fields inherited from interface com.atlassian.jira.service.JiraService
NAME_COMPARATOR
 
Constructor Summary
ExportService(JiraHome jiraHome)
           
 
Method Summary
 void destroy()
          This method is called when the service is unloaded (usually when the web application or server is being shut down).
 ObjectConfiguration getObjectConfiguration()
          Retrieves an object configuration object with properties that can be set
 void init(com.opensymphony.module.propertyset.PropertySet props)
          Initialise the service.
 boolean isUnique()
          Can have multiple export services, all running at different times
 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
getDefaultProperty, getDescription, getKey, getLongProperty, getName, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty, isInternal, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

USE_DEFAULT_DIRECTORY

public static final java.lang.String USE_DEFAULT_DIRECTORY
See Also:
Constant Field Values

DIR_NAME

public static final java.lang.String DIR_NAME
See Also:
Constant Field Values

USEZIP

public static final java.lang.String USEZIP
See Also:
Constant Field Values

OPT_DATE_FORMAT

public static final java.lang.String OPT_DATE_FORMAT
See Also:
Constant Field Values

EXPORT_SUBDIRECTORY

public static final java.lang.String EXPORT_SUBDIRECTORY
The subdirectory of jira-home that exports go to when we use the default directory

See Also:
Constant Field Values
Constructor Detail

ExportService

public ExportService(JiraHome jiraHome)
Method Detail

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 java.lang.Runnable
Specified by:
run in class AbstractService
See Also:
JiraService.init(com.opensymphony.module.propertyset.PropertySet)

destroy

public void destroy()
Description copied from class: AbstractService
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
Overrides:
destroy in class AbstractService

isUnique

public boolean isUnique()
Can have multiple export services, all running at different times

Specified by:
isUnique in interface JiraService
Overrides:
isUnique in class AbstractService
Returns:
false

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


Copyright © 2002-2010 Atlassian. All Rights Reserved.