com.atlassian.jira.service.services.file
Class FileService

java.lang.Object
  com.atlassian.jira.service.AbstractService
      com.atlassian.jira.service.services.file.AbstractMessageHandlingService
          com.atlassian.jira.service.services.file.FileService

All Implemented Interfaces:

ObjectConfigurable, JiraService, Runnable

Direct Known Subclasses:

StudioFileService

public class FileService
extends AbstractMessageHandlingService

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.service.services.file.AbstractMessageHandlingService

AbstractMessageHandlingService.HandlerDisablementListener

Field Summary

static String	KEY_SUBDIRECTORY
static String	MAIL_DIR

Fields inherited from class com.atlassian.jira.service.services.file.AbstractMessageHandlingService

KEY_HANDLER, KEY_HANDLER_PARAMS, MAX_READ_MESSAGES_DRY_RUN

Fields inherited from class com.atlassian.jira.service.AbstractService

name

Fields inherited from interface com.atlassian.jira.service.JiraService

NAME_COMPARATOR

Constructor Summary

FileService()

Method Summary

protected String	addHandlerInfo(String msg)
protected List<File>	getFilesOnly(File directory)
protected org.apache.log4j.Logger	getLogger()
ObjectConfiguration	getObjectConfiguration() Retrieves an object configuration object with properties that can be set
void	init(com.opensymphony.module.propertyset.PropertySet props) Initialise the service.
protected void	runImpl(MessageHandlerContext context)

Methods inherited from class com.atlassian.jira.service.services.file.AbstractMessageHandlingService

destroy, getHandler, run, setContext

Methods inherited from class com.atlassian.jira.service.AbstractService

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

Field Detail

MAIL_DIR

public static final String MAIL_DIR

KEY_SUBDIRECTORY

public static final String KEY_SUBDIRECTORY

See Also:

Constant Field Values

Constructor Detail

FileService

public FileService()

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 AbstractMessageHandlingService

Parameters:

props - initialisation parameters

Throws:

ObjectConfigurationException - in case of an error with initialisation parameters

getFilesOnly

protected List<File> getFilesOnly(File directory)

runImpl

protected void runImpl(MessageHandlerContext context)

Specified by:

runImpl in class AbstractMessageHandlingService

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

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractMessageHandlingService

addHandlerInfo

protected String addHandlerInfo(String msg)

Specified by:

addHandlerInfo in class AbstractMessageHandlingService