org.mule.transport.email
Class AbstractMailConnector

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

All Implemented Interfaces:

ExceptionListener, EventListener, javax.resource.spi.work.WorkListener, org.mule.api.context.MuleContextAware, org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Lifecycle, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.NamedObject, org.mule.api.transport.Connectable, org.mule.api.transport.Connector

Direct Known Subclasses:

AbstractRetrieveMailConnector, SmtpConnector

public abstract class AbstractMailConnector
extends org.mule.transport.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

MAILBOX

Fields inherited from class org.mule.transport.AbstractConnector

connected, connecting, connectionStrategy, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatchers, disposed, disposing, exceptionListener, initialised, logger, muleContext, name, numberOfConcurrentTransactedReceivers, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect

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

INT_VALUE_NOT_SET

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

AbstractMailConnector(int defaultPort, String mailboxFolder)

Method Summary

protected void	doConnect()
protected void	doDisconnect()
protected void	doDispose()
protected void	doInitialise()
protected void	doStart()
protected void	doStop()
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(org.mule.api.endpoint.ImmutableEndpoint endpoint)
protected SessionDetails	newSession(org.mule.api.endpoint.ImmutableEndpoint endpoint)
void	setAuthenticator(Authenticator authenticator)
void	setMailboxFolder(String mailboxFolder)
URLName	urlFromEndpoint(org.mule.api.endpoint.ImmutableEndpoint endpoint)

Methods inherited from class org.mule.transport.AbstractConnector

checkDisposed, connect, createReceiver, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeRequesters, disposeWorkManagers, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getConnectionStrategy, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMaxRequestersActive, getMessageAdapter, getMuleContext, getName, getNumberOfConcurrentTransactedReceivers, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isDisposing, isEnableMessageEvents, isRemoteSyncEnabled, isStarted, isSyncEnabled, lookupReceiver, registerListener, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, send, setConnectionStrategy, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherThreadingProfile, setDynamicNotification, setExceptionListener, setMaxDispatchersActive, setMaxRequestersActive, setMuleContext, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterThreadingProfile, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, start, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, 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

MAILBOX

public static final String MAILBOX

See Also:

Constant Field Values

Constructor Detail

AbstractMailConnector

public AbstractMailConnector(int defaultPort,
                             String mailboxFolder)

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(org.mule.api.endpoint.ImmutableEndpoint endpoint)

urlFromEndpoint

public URLName urlFromEndpoint(org.mule.api.endpoint.ImmutableEndpoint endpoint)

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(org.mule.api.endpoint.ImmutableEndpoint endpoint)

dumpProperties

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

doInitialise

protected void doInitialise()
                     throws org.mule.api.lifecycle.InitialisationException

Specified by:

doInitialise in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.lifecycle.InitialisationException

doDispose

protected void doDispose()

Specified by:

doDispose in class org.mule.transport.AbstractConnector

doConnect

protected void doConnect()
                  throws Exception

Specified by:

doConnect in class org.mule.transport.AbstractConnector

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class org.mule.transport.AbstractConnector

Throws:

Exception

doStart

protected void doStart()
                throws org.mule.api.MuleException

Specified by:

doStart in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.MuleException

doStop

protected void doStop()
               throws org.mule.api.MuleException

Specified by:

doStop in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.MuleException