org.mule.transport.email
Class AbstractTlsRetrieveMailConnector

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

All Implemented Interfaces:

ExceptionListener, EventListener, javax.resource.spi.work.WorkListener, MuleContextAware, Disposable, Initialisable, Lifecycle, Startable, Stoppable, NamedObject, TlsIndirectKeyStore, TlsIndirectTrustStore, Connectable, Connector

Direct Known Subclasses:

ImapsConnector, Pop3sConnector

public abstract class AbstractTlsRetrieveMailConnector
extends AbstractRetrieveMailConnector
implements TlsIndirectTrustStore, TlsIndirectKeyStore

Support for connecting to and receiving email from a secure mailbox (the exact protocol depends on the subclass).

Field Summary

Fields inherited from class org.mule.transport.email.AbstractRetrieveMailConnector

DEFAULT_CHECK_FREQUENCY

Fields inherited from class org.mule.transport.email.AbstractMailConnector

MAILBOX

Fields inherited from class org.mule.transport.AbstractConnector

connected, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatchers, disposed, exceptionListener, initialised, initialStateStopped, 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

protected

AbstractTlsRetrieveMailConnector(int defaultPort, String namespace, Class defaultSocketFactory)

Method Summary

protected void	doInitialise()
protected void	extendPropertiesForSession(Properties global, Properties local, URLName url) Subclasses should extend this to add further properties.
String	getClientKeyStore()
String	getClientKeyStorePassword()
String	getClientKeyStoreType()
String	getSocketFactory()
String	getSocketFactoryFallback()
String	getTrustStore()
String	getTrustStorePassword()
void	setClientKeyStore(String name)
void	setClientKeyStorePassword(String clientKeyStorePassword)
void	setClientKeyStoreType(String clientKeyStoreType)
void	setSocketFactory(String sslSocketFactory)
void	setSocketFactoryFallback(String socketFactoryFallback)
void	setTrustStore(String trustStore)
void	setTrustStorePassword(String trustStorePassword)

Methods inherited from class org.mule.transport.email.AbstractRetrieveMailConnector

createReceiver, getBackupFolder, getCheckFrequency, getMoveToFolder, isBackupEnabled, isDeleteReadMessages, setBackupEnabled, setBackupFolder, setCheckFrequency, setDeleteReadMessages, setMoveToFolder

Methods inherited from class org.mule.transport.email.AbstractMailConnector

doConnect, doDisconnect, doDispose, doStart, doStop, dumpProperties, getAuthenticator, getBaseProtocol, getDefaultPort, getMailboxFolder, getSessionDetails, newSession, setAuthenticator, setMailboxFolder, urlFromEndpoint

Methods inherited from class org.mule.transport.AbstractConnector

checkDisposed, configureDispatcherPool, connect, createScheduler, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeRequesters, disposeWorkManagers, doUnregisterListener, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMessageAdapter, getMessageAdapter, getMuleContext, getName, getNumberOfConcurrentTransactedReceivers, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, handleException, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isInitialStateStopped, isResponseEnabled, isStarted, isSyncEnabled, isValidateConnections, lookupReceiver, registerListener, registerSupportedMetaProtocol, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, send, setConnected, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherPoolMaxWait, setDispatcherPoolWhenExhaustedAction, setDispatcherThreadingProfile, setDynamicNotification, setExceptionListener, setInitialStateStopped, setMaxDispatchersActive, setMaxRequestersActive, setMuleContext, 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

Constructor Detail

AbstractTlsRetrieveMailConnector

protected AbstractTlsRetrieveMailConnector(int defaultPort,
                                           String namespace,
                                           Class defaultSocketFactory)

Method Detail

doInitialise

protected void doInitialise()
                     throws InitialisationException

Overrides:

doInitialise in class AbstractMailConnector

Throws:

InitialisationException

extendPropertiesForSession

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

Description copied from class: AbstractMailConnector

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

Overrides:

extendPropertiesForSession in class AbstractMailConnector

Parameters:

global - system properties

local - local properties (specific to one session)

url - the endpoint url

getSocketFactory

public String getSocketFactory()

setSocketFactory

public void setSocketFactory(String sslSocketFactory)

getSocketFactoryFallback

public String getSocketFactoryFallback()

setSocketFactoryFallback

public void setSocketFactoryFallback(String socketFactoryFallback)

getTrustStore

public String getTrustStore()

Specified by:

getTrustStore in interface TlsIndirectTrustStore

Returns:

The location (resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates of trusted servers.

getTrustStorePassword

public String getTrustStorePassword()

Specified by:

getTrustStorePassword in interface TlsIndirectTrustStore

Returns:

The password used to protected the trust store defined in TlsIndirectTrustStore.getTrustStore()

setTrustStore

public void setTrustStore(String trustStore)
                   throws IOException

Specified by:

setTrustStore in interface TlsIndirectTrustStore

Parameters:

trustStore - The location of the keystore that contains public certificates of trusted servers.

Throws:

IOException - If the location cannot be resolved via the file system or classpath

setTrustStorePassword

public void setTrustStorePassword(String trustStorePassword)

Specified by:

setTrustStorePassword in interface TlsIndirectTrustStore

Parameters:

trustStorePassword - The password used to protected the trust store defined in TlsIndirectTrustStore.setTrustStore(String)

getClientKeyStore

public String getClientKeyStore()

Specified by:

getClientKeyStore in interface TlsIndirectKeyStore

Returns:

The location (resolved relative to the current classpath and file system, if possible) of the keystore that contains public certificates and private keys for identification.

getClientKeyStorePassword

public String getClientKeyStorePassword()

Specified by:

getClientKeyStorePassword in interface TlsIndirectKeyStore

Returns:

The password used to protect the keystore itself

getClientKeyStoreType

public String getClientKeyStoreType()

Specified by:

getClientKeyStoreType in interface TlsIndirectKeyStore

Returns:

The type of keystore used in TlsIndirectKeyStore.setClientKeyStore(String)

setClientKeyStore

public void setClientKeyStore(String name)
                       throws IOException

Specified by:

setClientKeyStore in interface TlsIndirectKeyStore

Parameters:

name - The location of the keystore that contains public certificates and private keys for identification.

Throws:

IOException - If the location cannot be resolved via the file system or classpath

setClientKeyStorePassword

public void setClientKeyStorePassword(String clientKeyStorePassword)

Specified by:

setClientKeyStorePassword in interface TlsIndirectKeyStore

Parameters:

clientKeyStorePassword - The password used to protect the keystore itself

setClientKeyStoreType

public void setClientKeyStoreType(String clientKeyStoreType)

Specified by:

setClientKeyStoreType in interface TlsIndirectKeyStore