|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mule.transport.AbstractConnector
org.mule.transport.email.AbstractMailConnector
public abstract class AbstractMailConnector
Abstract superclass for mail connectors. Provides Mule with an Authenticator object and other shared functionality like e.g. MuleSession creation.
Field Summary | |
---|---|
static java.lang.String |
ATTACHMENT_HEADERS_PROPERTY_POSTFIX
|
static java.lang.String |
MAILBOX
|
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,
java.lang.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(java.lang.String title,
java.util.Properties properties,
boolean filter)
|
protected void |
extendPropertiesForSession(java.util.Properties global,
java.util.Properties local,
javax.mail.URLName url)
Subclasses should extend this to add further properties. |
javax.mail.Authenticator |
getAuthenticator()
|
protected java.lang.String |
getBaseProtocol()
Some protocols (eg secure extensions) extend a "base" protocol. |
int |
getDefaultPort()
|
java.lang.String |
getMailboxFolder()
|
SessionDetails |
getSessionDetails(ImmutableEndpoint endpoint)
|
protected SessionDetails |
newSession(ImmutableEndpoint endpoint)
|
void |
setAuthenticator(javax.mail.Authenticator authenticator)
|
void |
setMailboxFolder(java.lang.String mailboxFolder)
|
javax.mail.URLName |
urlFromEndpoint(ImmutableEndpoint endpoint)
|
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 |
---|
public static final java.lang.String ATTACHMENT_HEADERS_PROPERTY_POSTFIX
public static final java.lang.String MAILBOX
Constructor Detail |
---|
public AbstractMailConnector(int defaultPort, java.lang.String mailboxFolder, MuleContext context)
Method Detail |
---|
public int getDefaultPort()
public javax.mail.Authenticator getAuthenticator()
public void setAuthenticator(javax.mail.Authenticator authenticator)
public java.lang.String getMailboxFolder()
public void setMailboxFolder(java.lang.String mailboxFolder)
public SessionDetails getSessionDetails(ImmutableEndpoint endpoint) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public javax.mail.URLName urlFromEndpoint(ImmutableEndpoint endpoint) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
protected java.lang.String getBaseProtocol()
protected void extendPropertiesForSession(java.util.Properties global, java.util.Properties local, javax.mail.URLName url)
global
- system propertieslocal
- local properties (specific to one session)url
- the endpoint urlprotected SessionDetails newSession(ImmutableEndpoint endpoint) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
protected void dumpProperties(java.lang.String title, java.util.Properties properties, boolean filter)
protected void doInitialise() throws InitialisationException
doInitialise
in class AbstractConnector
InitialisationException
protected void doDispose()
AbstractConnector
doDispose
in class AbstractConnector
protected void doConnect() throws java.lang.Exception
AbstractConnector
doConnect
in class AbstractConnector
java.lang.Exception
protected void doDisconnect() throws java.lang.Exception
AbstractConnector
doDisconnect
in class AbstractConnector
java.lang.Exception
protected void doStart() throws MuleException
AbstractConnector
doStart
in class AbstractConnector
MuleException
- if the method failsprotected void doStop() throws MuleException
AbstractConnector
doStop
in class AbstractConnector
MuleException
- if the method fails
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |