com.atlassian.jira.mail

Interface MailLoggingManager

All Known Implementing Classes:

DefaultMailLoggingManager

public interface MailLoggingManager

Central place for manipulating logging/debug state for mail servers. Part of JIRA API because mail handlers (e.g. MailFetcherService and its descendants) may need to access JIRA mail logging configuration in order to behave well.

Apache Log4J (1.2+) is used as the logging mechanism and its Loggers are directly exposed via API

Since:

v5.0

Method Summary

Modifier and Type	Method and Description
void	configureLogging(com.atlassian.mail.server.MailServer mailServer) Normally you don't need to use this method, unless you explicitely creates instances of MailServer classes, then it's advisable to configure their logging level by calling this method.
org.apache.log4j.Logger	getIncomingMailChildLogger(String subname) Clients willing to log to incoming mail log (by default written to a separate log file) can use this method to obtain their more specific logger, which will inherit the appenders from the main incoming mail logger, thus information sent there will be logged also in the incoming mail log file.
org.apache.log4j.Logger	getIncomingMailLogger() Clients willing to log to incoming mail log (by default written to a separate log file) can use this logger.
org.apache.log4j.Level	getIncomingMailLoggingLevel() Retrieves currently configured logging level for incoming mail
org.apache.log4j.Logger	getOutgoingMailLogger() Clients willing to log to outgoing mail log (by default written to a separate log file) can use this logger.
org.apache.log4j.Level	getOutgoingMailLoggingLevel() Retrieves currently configured logging level for outgoing mail
boolean	isMailRelatedLogger(org.apache.log4j.Logger logger)
void	setIncomingMailLoggingLevel(org.apache.log4j.Level loggingLevel) Sets new logging level for incoming mail
void	setOutgoingMailLoggingLevel(org.apache.log4j.Level loggingLevel) Sets new logging level for outgoing mail

Method Detail

getOutgoingMailLoggingLevel

org.apache.log4j.Level getOutgoingMailLoggingLevel()

Retrieves currently configured logging level for outgoing mail

Returns:

currently configured logging level for outgoing mail

getIncomingMailLoggingLevel

org.apache.log4j.Level getIncomingMailLoggingLevel()

Retrieves currently configured logging level for incoming mail

Returns:

currently configured logging level for incoming mail

setOutgoingMailLoggingLevel

void setOutgoingMailLoggingLevel(org.apache.log4j.Level loggingLevel)

Sets new logging level for outgoing mail

Parameters:

loggingLevel - new logging level

setIncomingMailLoggingLevel

void setIncomingMailLoggingLevel(org.apache.log4j.Level loggingLevel)

Sets new logging level for incoming mail

Parameters:

loggingLevel - new logging level

getOutgoingMailLogger

org.apache.log4j.Logger getOutgoingMailLogger()

Clients willing to log to outgoing mail log (by default written to a separate log file) can use this logger.

Returns:

logger which can be used to log outgoing mail handling details

getIncomingMailLogger

org.apache.log4j.Logger getIncomingMailLogger()

Clients willing to log to incoming mail log (by default written to a separate log file) can use this logger.

Returns:

logger which can be used to log incoming mail handling details

getIncomingMailChildLogger

org.apache.log4j.Logger getIncomingMailChildLogger(String subname)

Clients willing to log to incoming mail log (by default written to a separate log file) can use this method to obtain their more specific logger, which will inherit the appenders from the main incoming mail logger, thus information sent there will be logged also in the incoming mail log file.

Parameters:

subname - additional name for this logger. It will be concatenated with the main incoming mail logger using "." (dot).

Returns:

logger which can be used to log incoming mail handling details

isMailRelatedLogger

boolean isMailRelatedLogger(org.apache.log4j.Logger logger)

configureLogging

void configureLogging(com.atlassian.mail.server.MailServer mailServer)

Normally you don't need to use this method, unless you explicitely creates instances of MailServer classes, then it's advisable to configure their logging level by calling this method.

Parameters:

mailServer - configures logging for given server.