Package org.apache.camel.component.mail
Class MailConsumer
java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultConsumer
org.apache.camel.support.ScheduledPollConsumer
org.apache.camel.support.ScheduledBatchPollingConsumer
org.apache.camel.component.mail.MailConsumer
- All Implemented Interfaces:
AutoCloseable
,Runnable
,org.apache.camel.BatchConsumer
,org.apache.camel.Consumer
,org.apache.camel.EndpointAware
,org.apache.camel.health.HealthCheckAware
,org.apache.camel.PollingConsumerPollingStrategy
,org.apache.camel.RouteAware
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.RouteIdAware
,org.apache.camel.spi.ShutdownAware
,org.apache.camel.spi.ShutdownPrepared
,org.apache.camel.StatefulService
,org.apache.camel.Suspendable
,org.apache.camel.SuspendableService
public class MailConsumer
extends org.apache.camel.support.ScheduledBatchPollingConsumer
A
Consumer
which consumes messages from JavaMail using a
Transport
and dispatches them to the Processor
-
Field Summary
Fields inherited from class org.apache.camel.support.ScheduledBatchPollingConsumer
maxMessagesPerPoll, pendingExchanges, shutdownRunningTask
Fields inherited from class org.apache.camel.support.service.BaseService
BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
-
Constructor Summary
ConstructorDescriptionMailConsumer
(MailEndpoint endpoint, org.apache.camel.Processor processor, JavaMailSender sender) -
Method Summary
Modifier and TypeMethodDescriptionprotected org.apache.camel.Exchange
createExchange
(org.apache.camel.util.KeyValueHolder<String, jakarta.mail.Message> holder) protected void
doStart()
protected void
doStop()
boolean
boolean
protected int
poll()
int
processBatch
(Queue<Object> exchanges) protected void
processCommit
(jakarta.mail.Message mail, org.apache.camel.Exchange exchange) Strategy to flag the message after being processed.protected void
processExchange
(org.apache.camel.Exchange exchange) Strategy to process the mail message.protected void
processRollback
(jakarta.mail.Message mail, org.apache.camel.Exchange exchange) Strategy when processing the exchange failed.void
setHandleFailedMessage
(boolean handleFailedMessage) void
setSkipFailedMessage
(boolean skipFailedMessage) Methods inherited from class org.apache.camel.support.ScheduledBatchPollingConsumer
deferShutdown, getMaxMessagesPerPoll, getPendingExchangesSize, isBatchAllowed, prepareShutdown, processEmptyMessage, setMaxMessagesPerPoll
Methods inherited from class org.apache.camel.support.ScheduledPollConsumer
addLastErrorDetail, afterConfigureScheduler, afterPoll, beforePoll, doBuild, doInit, doShutdown, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getCounter, getDelay, getErrorCounter, getInitialDelay, getLastError, getLastErrorDetails, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getSuccessCounter, getTimeUnit, initialHealthCheckState, isFirstPollDone, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler
Methods inherited from class org.apache.camel.support.DefaultConsumer
createExchange, createUoW, defaultConsumerCallback, doneUoW, getAsyncProcessor, getExceptionHandler, getHealthCheck, getProcessor, getRoute, getRouteId, handleException, handleException, releaseExchange, setExceptionHandler, setHealthCheck, setRoute, setRouteId, toString
Methods inherited from class org.apache.camel.support.service.BaseService
build, doFail, doLifecycleChange, doResume, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, 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.Consumer
createExchange, defaultConsumerCallback, getProcessor, releaseExchange
Methods inherited from interface org.apache.camel.health.HealthCheckAware
getHealthCheck, setHealthCheck
Methods inherited from interface org.apache.camel.Service
build, close, init, start, stop
Methods inherited from interface org.apache.camel.ShutdownableService
shutdown
Methods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Field Details
-
MAIL_MESSAGE_UID
- See Also:
-
DEFAULT_CONSUMER_DELAY
public static final long DEFAULT_CONSUMER_DELAY- See Also:
-
-
Constructor Details
-
MailConsumer
public MailConsumer(MailEndpoint endpoint, org.apache.camel.Processor processor, JavaMailSender sender)
-
-
Method Details
-
doStart
- Overrides:
doStart
in classorg.apache.camel.support.ScheduledPollConsumer
- Throws:
Exception
-
doStop
- Overrides:
doStop
in classorg.apache.camel.support.ScheduledPollConsumer
- Throws:
Exception
-
poll
- Specified by:
poll
in classorg.apache.camel.support.ScheduledPollConsumer
- Throws:
Exception
-
processBatch
- Throws:
Exception
-
createExchange
protected org.apache.camel.Exchange createExchange(org.apache.camel.util.KeyValueHolder<String, jakarta.mail.Message> holder) throws jakarta.mail.MessagingException- Throws:
jakarta.mail.MessagingException
-
processExchange
Strategy to process the mail message.- Throws:
Exception
-
processCommit
protected void processCommit(jakarta.mail.Message mail, org.apache.camel.Exchange exchange) Strategy to flag the message after being processed.- Parameters:
mail
- the mail messageexchange
- the exchange
-
processRollback
protected void processRollback(jakarta.mail.Message mail, org.apache.camel.Exchange exchange) Strategy when processing the exchange failed.- Parameters:
mail
- the mail messageexchange
- the exchange
-
getEndpoint
- Specified by:
getEndpoint
in interfaceorg.apache.camel.EndpointAware
- Overrides:
getEndpoint
in classorg.apache.camel.support.DefaultConsumer
-
isSkipFailedMessage
public boolean isSkipFailedMessage() -
setSkipFailedMessage
public void setSkipFailedMessage(boolean skipFailedMessage) -
isHandleFailedMessage
public boolean isHandleFailedMessage() -
setHandleFailedMessage
public void setHandleFailedMessage(boolean handleFailedMessage)
-