org.apache.camel.component.mail

Class MailConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.impl.ScheduledPollConsumer

org.apache.camel.impl.ScheduledBatchPollingConsumer

org.apache.camel.component.mail.MailConsumer

All Implemented Interfaces:

java.lang.Runnable, BatchConsumer, Consumer, PollingConsumerPollingStrategy, RouteAware, Service, ShutdownableService, ShutdownAware, ShutdownPrepared, StatefulService, SuspendableService

public class MailConsumer
extends ScheduledBatchPollingConsumer

A Consumer which consumes messages from JavaMail using a Transport and dispatches them to the Processor

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CONSUMER_DELAY
static java.lang.String	POP3_UID

Fields inherited from class org.apache.camel.impl.ScheduledBatchPollingConsumer

maxMessagesPerPoll, pendingExchanges, shutdownRunningTask

Fields inherited from class org.apache.camel.impl.DefaultConsumer

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
MailConsumer(MailEndpoint endpoint, Processor processor, JavaMailSender sender)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Queue<Exchange>	createExchanges(javax.mail.Message[] messages)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
protected java.lang.String	generatePop3Uid(javax.mail.Message message) Generates an UID of the POP3Message
MailEndpoint	getEndpoint() Gets the endpoint this Consumer consumes from.
protected int	poll() The polling method which is invoked periodically to poll this consumer
int	processBatch(java.util.Queue<java.lang.Object> exchanges) Processes the list of Exchange objects in a batch.
protected void	processCommit(javax.mail.Message mail, Exchange exchange) Strategy to flag the message after being processed.
protected void	processExchange(Exchange exchange) Strategy to process the mail message.
protected void	processRollback(javax.mail.Message mail, Exchange exchange) Strategy when processing the exchange failed.

Methods inherited from class org.apache.camel.impl.ScheduledBatchPollingConsumer

deferShutdown, getMaxMessagesPerPoll, getPendingExchangesSize, isBatchAllowed, prepareShutdown, processEmptyMessage, setMaxMessagesPerPoll

Methods inherited from class org.apache.camel.impl.ScheduledPollConsumer

afterPoll, beforePoll, doShutdown, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler

Methods inherited from class org.apache.camel.impl.DefaultConsumer

createUoW, doneUoW, getAsyncProcessor, getExceptionHandler, getProcessor, getRoute, handleException, handleException, setExceptionHandler, setRoute, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

start, stop

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Field Detail

POP3_UID

public static final java.lang.String POP3_UID

See Also:

Constant Field Values

DEFAULT_CONSUMER_DELAY

public static final long DEFAULT_CONSUMER_DELAY

See Also:

Constant Field Values

Constructor Detail

MailConsumer

public MailConsumer(MailEndpoint endpoint,
            Processor processor,
            JavaMailSender sender)

Method Detail

doStart

protected void doStart()
                throws java.lang.Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class ScheduledPollConsumer

Throws:

java.lang.Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws java.lang.Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class ScheduledPollConsumer

Throws:

java.lang.Exception

See Also:

ServiceSupport.doStart()

poll

protected int poll()
            throws java.lang.Exception

Description copied from class: ScheduledPollConsumer

The polling method which is invoked periodically to poll this consumer

Specified by:

poll in class ScheduledPollConsumer

Returns:

number of messages polled, will be 0 if no message was polled at all.

Throws:

java.lang.Exception - can be thrown if an exception occurred during polling

processBatch

public int processBatch(java.util.Queue<java.lang.Object> exchanges)
                 throws java.lang.Exception

Description copied from interface: BatchConsumer

Processes the list of Exchange objects in a batch.

Each message exchange will be processed individually but the batch consumer will add properties with the current index and total in the batch. The items in the Queue may actually be Holder objects that store other data alongside the Exchange.

Parameters:

exchanges - list of items in this batch

Returns:

number of messages actually processed

Throws:

java.lang.Exception - if an internal processing error has occurred.

createExchanges

protected java.util.Queue<Exchange> createExchanges(javax.mail.Message[] messages)
                                             throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

processExchange

protected void processExchange(Exchange exchange)
                        throws java.lang.Exception

Strategy to process the mail message.

Throws:

java.lang.Exception

processCommit

protected void processCommit(javax.mail.Message mail,
                 Exchange exchange)

Strategy to flag the message after being processed.

Parameters:

mail - the mail message

exchange - the exchange

processRollback

protected void processRollback(javax.mail.Message mail,
                   Exchange exchange)

Strategy when processing the exchange failed.

Parameters:

mail - the mail message

exchange - the exchange

generatePop3Uid

protected java.lang.String generatePop3Uid(javax.mail.Message message)

Generates an UID of the POP3Message

Parameters:

message - the POP3Message

Returns:

the generated uid

getEndpoint

public MailEndpoint getEndpoint()

Description copied from interface: Consumer

Gets the endpoint this Consumer consumes from.

Specified by:

getEndpoint in interface Consumer

Overrides:

getEndpoint in class DefaultConsumer

Returns:

the endpoint