|
Spring Integration | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.integration.context.IntegrationObjectSupport org.springframework.integration.mail.AbstractMailReceiver
public abstract class AbstractMailReceiver
Base class for MailReceiver
implementations.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.springframework.integration.mail.MailReceiver |
---|
MailReceiver.MailReceiverContext |
Field Summary | |
---|---|
protected int |
folderOpenMode
|
protected boolean |
initialized
|
protected org.apache.commons.logging.Log |
logger
|
static java.lang.String |
SI_USER_FLAG
|
Constructor Summary | |
---|---|
AbstractMailReceiver()
|
|
AbstractMailReceiver(java.lang.String url)
|
|
AbstractMailReceiver(javax.mail.URLName urlName)
|
Method Summary | |
---|---|
void |
closeContextAfterFailure(MailReceiver.MailReceiverContext context)
|
void |
closeContextAfterSuccess(MailReceiver.MailReceiverContext context)
Delete and expunge messages after success. |
protected void |
deleteMessages(javax.mail.Message[] messages)
Deletes the given messages from this receiver's folder. |
void |
destroy()
|
protected void |
fetchMessages(javax.mail.Message[] messages)
Fetches the specified messages from this receiver's folder. |
protected javax.mail.Folder |
getFolder()
|
MailReceiver.MailReceiverContext |
getTransactionContext()
|
protected void |
onInit()
Subclasses may implement this for initialization logic. |
protected void |
openFolder()
|
javax.mail.Message[] |
receive()
|
protected abstract javax.mail.Message[] |
searchForNewMessages()
Subclasses must implement this method to return new mail messages. |
protected void |
setAdditionalFlags(javax.mail.Message message)
Optional method allowing you to set additional flags. |
void |
setJavaMailAuthenticator(javax.mail.Authenticator javaMailAuthenticator)
Optional, sets the Authenticator to be used to obtain a session. |
void |
setJavaMailProperties(java.util.Properties javaMailProperties)
A new Session will be created with these properties (and the JavaMailAuthenticator if provided). |
void |
setMaxFetchSize(int maxFetchSize)
Specify the maximum number of Messages to fetch per call to receive() . |
void |
setProtocol(java.lang.String protocol)
|
void |
setSelectorExpression(org.springframework.expression.Expression selectorExpression)
|
void |
setSession(javax.mail.Session session)
Set the Session . |
void |
setShouldDeleteMessages(boolean shouldDeleteMessages)
Specify whether mail messages should be deleted after retrieval. |
protected boolean |
shouldDeleteMessages()
Indicates whether the mail messages should be deleted after being received. |
java.lang.String |
toString()
|
Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport |
---|
afterPropertiesSet, getBeanFactory, getComponentName, getComponentType, getConversionService, getTaskScheduler, setBeanFactory, setBeanName, setComponentName, setConversionService, setTaskScheduler |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SI_USER_FLAG
protected final org.apache.commons.logging.Log logger
protected volatile int folderOpenMode
protected volatile boolean initialized
Constructor Detail |
---|
public AbstractMailReceiver()
public AbstractMailReceiver(javax.mail.URLName urlName)
public AbstractMailReceiver(java.lang.String url)
Method Detail |
---|
public void setSelectorExpression(org.springframework.expression.Expression selectorExpression)
public void setProtocol(java.lang.String protocol)
public void setSession(javax.mail.Session session)
Session
. Otherwise, the Session will be created by invocation of
Session.getInstance(Properties)
or Session.getInstance(Properties, Authenticator)
.
setJavaMailProperties(Properties)
,
setJavaMailAuthenticator(Authenticator)
public void setJavaMailProperties(java.util.Properties javaMailProperties)
Session
will be created with these properties (and the JavaMailAuthenticator if provided).
Use either this method or setSession(javax.mail.Session)
, but not both.
setJavaMailAuthenticator(Authenticator)
,
setSession(Session)
public void setJavaMailAuthenticator(javax.mail.Authenticator javaMailAuthenticator)
setSession(javax.mail.Session)
has been used to configure the Session
directly.
setSession(Session)
public void setMaxFetchSize(int maxFetchSize)
receive()
.
public void setShouldDeleteMessages(boolean shouldDeleteMessages)
protected boolean shouldDeleteMessages()
protected javax.mail.Folder getFolder()
public MailReceiver.MailReceiverContext getTransactionContext()
getTransactionContext
in interface MailReceiver
protected abstract javax.mail.Message[] searchForNewMessages() throws javax.mail.MessagingException
javax.mail.MessagingException
protected void openFolder() throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Message[] receive() throws javax.mail.MessagingException
receive
in interface MailReceiver
javax.mail.MessagingException
protected void fetchMessages(javax.mail.Message[] messages) throws javax.mail.MessagingException
fetches
every FetchProfile.Item
.
messages
- the messages to fetch
javax.mail.MessagingException
- in case of JavaMail errorsprotected void deleteMessages(javax.mail.Message[] messages) throws javax.mail.MessagingException
messages
- the messages to delete
javax.mail.MessagingException
- in case of JavaMail errorsprotected void setAdditionalFlags(javax.mail.Message message) throws javax.mail.MessagingException
message
-
javax.mail.MessagingException
public void destroy() throws java.lang.Exception
destroy
in interface org.springframework.beans.factory.DisposableBean
java.lang.Exception
protected void onInit() throws java.lang.Exception
IntegrationObjectSupport
onInit
in class IntegrationObjectSupport
java.lang.Exception
public java.lang.String toString()
toString
in class IntegrationObjectSupport
public void closeContextAfterSuccess(MailReceiver.MailReceiverContext context)
closeContextAfterSuccess
in interface MailReceiver
context
- public void closeContextAfterFailure(MailReceiver.MailReceiverContext context)
closeContextAfterFailure
in interface MailReceiver
|
Spring Integration | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |