Package org.apache.axis2.transport.mail

Class MailTransportListener

java.lang.Object

org.apache.axis2.transport.base.AbstractTransportListener

org.apache.axis2.transport.base.AbstractTransportListenerEx<T>

org.apache.axis2.transport.base.AbstractPollingTransportListener<PollTableEntry>

org.apache.axis2.transport.mail.MailTransportListener

All Implemented Interfaces:

TransportListener, TransportErrorSource, ManagementSupport

public class MailTransportListener
extends AbstractPollingTransportListener<PollTableEntry>
implements ManagementSupport, TransportErrorSource

This mail transport lister implementation uses the base transport framework and is a polling transport. i.e. a service can register itself with custom a custom mail configuration (i.e. pop3 or imap) and specify its polling duration, and what action to be taken after processing messages. The transport always deletes processed mails from the folder they were fetched from and can be configured to be optionally moved to a different folder, if the server supports it (e.g. with imap). When checking for new mail, the transport ignores messages already flaged as SEEN and DELETED

Field Summary

Fields

Modifier and Type	Field	Description
static String	DELETE
static String	MOVE

Fields inherited from class org.apache.axis2.transport.base.AbstractTransportListener

cfgCtx, config, isNonBlocking, log, metrics, state, useAxis2ThreadPool, workerPool

Fields inherited from interface org.apache.axis2.kernel.TransportListener

HOST_ADDRESS, PARAM_PORT

Constructor Summary

Constructors

Constructor	Description
MailTransportListener()

Method Summary

Modifier and Type	Method	Description
void	addErrorListener(TransportErrorListener listener)
protected PollTableEntry	createEndpoint()
protected void	doInit()	Initialize the transport.
protected void	poll(PollTableEntry entry)
void	removeErrorListener(TransportErrorListener listener)

Methods inherited from class org.apache.axis2.transport.base.AbstractPollingTransportListener

destroy, maintenenceShutdown, onPollCompletion, pause, processFailure, resume, startEndpoint, stopEndpoint

Methods inherited from class org.apache.axis2.transport.base.AbstractTransportListenerEx

getEndpoints, getEPRsForService, init, start, startListeningForService, stop, stopListeningForService

Methods inherited from class org.apache.axis2.transport.base.AbstractTransportListener

createMessageContext, disableTransportForService, getActiveThreadCount, getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getConfigurationContext, getEPRForService, getEPRsForService, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsCollector, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getQueueSize, getResponseCodeTable, getSessionContext, getTimeoutsReceiving, getTimeoutsSending, getTransportInDescription, getTransportName, handleException, handleIncomingMessage, logException, resetStatistics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.axis2.transport.base.ManagementSupport

getActiveThreadCount, getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getQueueSize, getResponseCodeTable, getTimeoutsReceiving, getTimeoutsSending, maintenenceShutdown, pause, resetStatistics, resume

Field Detail

DELETE

public static final String DELETE

See Also:

Constant Field Values

MOVE

public static final String MOVE

See Also:

Constant Field Values

Constructor Detail

MailTransportListener

public MailTransportListener()

Method Detail

doInit

protected void doInit()
               throws AxisFault

Description copied from class: AbstractTransportListenerEx

Initialize the transport. This method will be called after the initialization work in AbstractTransportListener and before the first endpoint is created, i.e. before the first call to AbstractTransportListenerEx.createEndpoint().

Overrides:

doInit in class AbstractPollingTransportListener<PollTableEntry>

Throws:

AxisFault

poll

protected void poll(PollTableEntry entry)

Specified by:

poll in class AbstractPollingTransportListener<PollTableEntry>

createEndpoint

protected PollTableEntry createEndpoint()

Specified by:

createEndpoint in class AbstractTransportListenerEx<PollTableEntry>

addErrorListener

public void addErrorListener(TransportErrorListener listener)

Specified by:

addErrorListener in interface TransportErrorSource

removeErrorListener

public void removeErrorListener(TransportErrorListener listener)

Specified by:

removeErrorListener in interface TransportErrorSource