Package com.atlassian.jira.service.services.mail

Class MailFetcherService

java.lang.Object

com.atlassian.jira.service.AbstractService

com.atlassian.jira.service.services.file.AbstractMessageHandlingService

com.atlassian.jira.service.services.mail.MailFetcherService

All Implemented Interfaces:

ObjectConfigurable, JiraService, Runnable

@Internal
public class MailFetcherService
extends AbstractMessageHandlingService
implements ObjectConfigurable

Mail fetcher for both POP and IMAP protocols. This class is going to be hopefully moved to JIRA Mail Plugin.

Nested Class Summary

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

AbstractMessageHandlingService.HandlerDisablementListener

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	configurationIdentifier
protected static final String	DEFAULT_FOLDER
static final String	FOLDER_NAME_KEY
static final String	FORWARD_EMAIL
static final String	KEY_MAIL_SERVER
protected Long	mailserverId
static final String	MARK_AS_SEEN_KEY

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

log, name, SERVICE_EVENT

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

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
MailFetcherService()	Deprecated.
MailFetcherService(com.atlassian.jira.service.services.mail.MailFetcherService.ErrorEmailForwarder errorEmailForwarder, com.atlassian.jira.service.services.mail.MailFetcherService.MessageProvider messageProvider, MailReaderFactory mailReaderFactory, MailSettings.Fetch settings, com.atlassian.jira.service.services.mail.DeadLetterStore deadLetterStore, com.atlassian.beehive.ClusterLockService clusterLockService, FeatureManager featureManager, MailboxCleanupPause mailboxCleanupPause)

Method Summary

Modifier and Type	Method	Description
protected String	addHandlerInfo(String msg)	JRA-13590 Small decorator to add the service handler name and the mail service ID to log messages to make it easier if you have multiple services configured to determine which one is throwing exceptions.
protected org.apache.log4j.Logger	getLogger()
protected com.atlassian.jira.service.services.mail.MailFetcherService.MailProcessMode	getMailProcessMode(com.atlassian.mail.MailProtocol mailProtocol, FeatureManager featureManager)
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	init(com.opensymphony.module.propertyset.PropertySet props, long configurationIdentifier)	Initialise the service passing configuration identifier which is unique per configuration of the service.
protected boolean	isMarkAsSeen()
protected void	runImpl(MessageHandlerContext context)	Connect to the POP / IMAPemail box and then handle each message.

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

asString, 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

Methods inherited from interface com.atlassian.configurable.ObjectConfigurable

getDefaultProperty, getKey, getLongProperty, getProperties, getProperty, getTextProperty, hasProperty

Field Details

KEY_MAIL_SERVER

public static final String KEY_MAIL_SERVER

See Also:

• Constant Field Values

mailserverId

protected Long mailserverId

configurationIdentifier

protected Long configurationIdentifier

FORWARD_EMAIL

public static final String FORWARD_EMAIL

See Also:

• Constant Field Values

DEFAULT_FOLDER

protected static final String DEFAULT_FOLDER

See Also:

• Constant Field Values

FOLDER_NAME_KEY

public static final String FOLDER_NAME_KEY

See Also:

• Constant Field Values

MARK_AS_SEEN_KEY

public static final String MARK_AS_SEEN_KEY

See Also:

• Constant Field Values

Constructor Details

MailFetcherService

@Deprecated
public MailFetcherService()

Deprecated.

MailFetcherService

public MailFetcherService(com.atlassian.jira.service.services.mail.MailFetcherService.ErrorEmailForwarder errorEmailForwarder,
 com.atlassian.jira.service.services.mail.MailFetcherService.MessageProvider messageProvider,
 MailReaderFactory mailReaderFactory,
 MailSettings.Fetch settings,
 com.atlassian.jira.service.services.mail.DeadLetterStore deadLetterStore,
 com.atlassian.beehive.ClusterLockService clusterLockService,
 FeatureManager featureManager,
 MailboxCleanupPause mailboxCleanupPause)

Method Details

init

public void init(com.opensymphony.module.propertyset.PropertySet props,
 long configurationIdentifier)
          throws ObjectConfigurationException

Description copied from interface: JiraService

Initialise the service passing configuration identifier which is unique per configuration of the service.

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.

this method may be called multiple times during the services lifetime.

Specified by:

init in interface JiraService

Parameters:

props - initialisation parameters

configurationIdentifier - identifier of the configuration of the service

Throws:

ObjectConfigurationException - in case of an error with initialisation parameters

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

See Also:

• JiraService.init(PropertySet, long)

getMailProcessMode

protected com.atlassian.jira.service.services.mail.MailFetcherService.MailProcessMode getMailProcessMode(com.atlassian.mail.MailProtocol mailProtocol,
 FeatureManager featureManager)

runImpl

protected void runImpl(MessageHandlerContext context)

Connect to the POP / IMAPemail box and then handle each message.

Specified by:

runImpl in class AbstractMessageHandlingService

isMarkAsSeen

protected boolean isMarkAsSeen()

addHandlerInfo

protected String addHandlerInfo(String msg)

JRA-13590 Small decorator to add the service handler name and the mail service ID to log messages to make it easier if you have multiple services configured to determine which one is throwing exceptions.

Specified by:

addHandlerInfo in class AbstractMessageHandlingService

Parameters:

msg - log message

Returns:

log message decorated with handler name and mail server ID

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

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractMessageHandlingService