org.mule.transport.email
Class AbstractMailConnector

java.lang.Object
  org.mule.transport.AbstractConnector
      org.mule.transport.email.AbstractMailConnector

All Implemented Interfaces:

EventListener, javax.resource.spi.work.WorkListener, Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, NameableObject, NamedObject, Connectable, Connector

Direct Known Subclasses:

AbstractRetrieveMailConnector, SmtpConnector

public abstract class AbstractMailConnector
extends AbstractConnector

Abstract superclass for mail connectors. Provides Mule with an Authenticator object and other shared functionality like e.g. MuleSession creation.

Field Summary

static String	ATTACHMENT_HEADERS_PROPERTY_POSTFIX
static String	MAILBOX

Fields inherited from class org.mule.transport.AbstractConnector

createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatcherPoolFactory, dispatchers, initialStateStopped, lifecycleManager, logger, muleContext, muleMessageFactory, name, numberOfConcurrentTransactedReceivers, PROPERTY_POLLING_FREQUENCY, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, startOnConnect

Fields inherited from interface org.mule.api.transport.Connector

INT_VALUE_NOT_SET

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

AbstractMailConnector(int defaultPort, String mailboxFolder, MuleContext context)

Method Summary

protected void	doConnect() Template method where any connections should be made for the connector
protected void	doDisconnect() Template method where any connected resources used by the connector should be disconnected
protected void	doDispose() Template method to perform any work when destroying the connectoe
protected void	doInitialise()
protected void	doStart() Template method to perform any work when starting the connectoe
protected void	doStop() Template method to perform any work when stopping the connectoe
protected void	dumpProperties(String title, Properties properties, boolean filter)
protected void	extendPropertiesForSession(Properties global, Properties local, URLName url) Subclasses should extend this to add further properties.
Authenticator	getAuthenticator()
protected String	getBaseProtocol() Some protocols (eg secure extensions) extend a "base" protocol.
int	getDefaultPort()
String	getMailboxFolder()
SessionDetails	getSessionDetails(ImmutableEndpoint endpoint)
protected SessionDetails	newSession(ImmutableEndpoint endpoint)
void	setAuthenticator(Authenticator authenticator)
void	setMailboxFolder(String mailboxFolder)
URLName	urlFromEndpoint(ImmutableEndpoint endpoint)

Methods inherited from class org.mule.transport.AbstractConnector

clearDispatchers, clearRequesters, configureDispatcherPool, connect, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createMuleMessageFactory, createOperationResource, createReceiver, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, fireNotification, getConnectEventId, getConnectionDescription, getDefaultExchangePattern, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherPoolFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getInboundExchangePatterns, getLifecycleState, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMuleContext, getMuleMessageFactory, getName, getNumberOfConcurrentTransactedReceivers, getOperationResourceFactory, getOutboundExchangePatterns, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, getTransactionalResource, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isConnecting, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isInitialised, isInitialStateStopped, isResponseEnabled, isStarted, isStarting, isStopped, isStopping, isValidateConnections, lookupReceiver, registerListener, registerSupportedMetaProtocol, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, setConnected, setConnecting, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherPoolFactory, setDispatcherPoolMaxWait, setDispatcherPoolWhenExhaustedAction, setDispatcherThreadingProfile, setDynamicNotification, setInitialStateStopped, setMaxDispatchersActive, setMaxRequestersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterPoolMaxWait, setRequesterPoolWhenExhaustedAction, setRequesterThreadingProfile, setRetryPolicyTemplate, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, setValidateConnections, shutdownScheduler, start, startAfterConnect, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, validateConnection, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.Connector

getProtocol

Field Detail

ATTACHMENT_HEADERS_PROPERTY_POSTFIX

public static final String ATTACHMENT_HEADERS_PROPERTY_POSTFIX

See Also:

Constant Field Values

MAILBOX

public static final String MAILBOX

See Also:

Constant Field Values

Constructor Detail

AbstractMailConnector

public AbstractMailConnector(int defaultPort,
                             String mailboxFolder,
                             MuleContext context)

Method Detail

getDefaultPort

public int getDefaultPort()

getAuthenticator

public Authenticator getAuthenticator()

setAuthenticator

public void setAuthenticator(Authenticator authenticator)

getMailboxFolder

public String getMailboxFolder()

setMailboxFolder

public void setMailboxFolder(String mailboxFolder)

getSessionDetails

public SessionDetails getSessionDetails(ImmutableEndpoint endpoint)
                                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

urlFromEndpoint

public URLName urlFromEndpoint(ImmutableEndpoint endpoint)
                        throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getBaseProtocol

protected String getBaseProtocol()

Some protocols (eg secure extensions) extend a "base" protocol. Subclasses for such protocols should override this method.

Returns:

the underlying (eg non-secure) protocol

extendPropertiesForSession

protected void extendPropertiesForSession(Properties global,
                                          Properties local,
                                          URLName url)

Subclasses should extend this to add further properties. Synchronization is managed outside this call (so no need to synchronize further on properties)

Parameters:

global - system properties

local - local properties (specific to one session)

url - the endpoint url

newSession

protected SessionDetails newSession(ImmutableEndpoint endpoint)
                             throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

dumpProperties

protected void dumpProperties(String title,
                              Properties properties,
                              boolean filter)

doInitialise

protected void doInitialise()
                     throws InitialisationException

Specified by:

doInitialise in class AbstractConnector

Throws:

InitialisationException

doDispose

protected void doDispose()

Description copied from class: AbstractConnector

Template method to perform any work when destroying the connectoe

Specified by:

doDispose in class AbstractConnector

doConnect

protected void doConnect()
                  throws Exception

Description copied from class: AbstractConnector

Template method where any connections should be made for the connector

Specified by:

doConnect in class AbstractConnector

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractConnector

Template method where any connected resources used by the connector should be disconnected

Specified by:

doDisconnect in class AbstractConnector

Throws:

Exception

doStart

protected void doStart()
                throws MuleException

Description copied from class: AbstractConnector

Template method to perform any work when starting the connectoe

Specified by:

doStart in class AbstractConnector

Throws:

MuleException - if the method fails

doStop

protected void doStop()
               throws MuleException

Description copied from class: AbstractConnector

Template method to perform any work when stopping the connectoe

Specified by:

doStop in class AbstractConnector

Throws:

MuleException - if the method fails