Package org.apache.camel.builder

Class LegacyDefaultErrorHandlerBuilder

java.lang.Object
org.apache.camel.builder.LegacyErrorHandlerBuilderSupport
org.apache.camel.builder.LegacyDefaultErrorHandlerBuilder
All Implemented Interfaces:
LegacyErrorHandlerBuilder, org.apache.camel.ErrorHandlerFactory, DefaultErrorHandlerProperties
Direct Known Subclasses:
LegacyDeadLetterChannelBuilder
@Deprecated public class LegacyDefaultErrorHandlerBuilder extends LegacyErrorHandlerBuilderSupport implements DefaultErrorHandlerProperties
Deprecated.
Legacy error handler for XML DSL in camel-spring-xml/camel-blueprint

  • Constructor Details

    • LegacyDefaultErrorHandlerBuilder

      public LegacyDefaultErrorHandlerBuilder()
      Deprecated.

  • Method Details

    • supportTransacted

      public boolean supportTransacted()
      Deprecated.
      Specified by:
      supportTransacted in interface org.apache.camel.ErrorHandlerFactory
      Overrides:
      supportTransacted in class LegacyErrorHandlerBuilderSupport

    • cloneBuilder

      public LegacyErrorHandlerBuilder cloneBuilder()
      Deprecated.
      Specified by:
      cloneBuilder in interface org.apache.camel.ErrorHandlerFactory

    • cloneBuilder

      protected void cloneBuilder(LegacyDefaultErrorHandlerBuilder other)
      Deprecated.

    • backOffMultiplier

      public LegacyDefaultErrorHandlerBuilder backOffMultiplier(double backOffMultiplier)
      Deprecated.

    • collisionAvoidancePercent

      public LegacyDefaultErrorHandlerBuilder collisionAvoidancePercent(double collisionAvoidancePercent)
      Deprecated.

    • redeliveryDelay

      public LegacyDefaultErrorHandlerBuilder redeliveryDelay(long delay)
      Deprecated.

    • delayPattern

      public LegacyDefaultErrorHandlerBuilder delayPattern(String delayPattern)
      Deprecated.

    • maximumRedeliveries

      public LegacyDefaultErrorHandlerBuilder maximumRedeliveries(int maximumRedeliveries)
      Deprecated.

    • disableRedelivery

      public LegacyDefaultErrorHandlerBuilder disableRedelivery()
      Deprecated.

    • maximumRedeliveryDelay

      public LegacyDefaultErrorHandlerBuilder maximumRedeliveryDelay(long maximumRedeliveryDelay)
      Deprecated.

    • useCollisionAvoidance

      public LegacyDefaultErrorHandlerBuilder useCollisionAvoidance()
      Deprecated.

    • useExponentialBackOff

      public LegacyDefaultErrorHandlerBuilder useExponentialBackOff()
      Deprecated.

    • retriesExhaustedLogLevel

      public LegacyDefaultErrorHandlerBuilder retriesExhaustedLogLevel(org.apache.camel.LoggingLevel retriesExhaustedLogLevel)
      Deprecated.

    • retryAttemptedLogLevel

      public LegacyDefaultErrorHandlerBuilder retryAttemptedLogLevel(org.apache.camel.LoggingLevel retryAttemptedLogLevel)
      Deprecated.

    • retryAttemptedLogInterval

      public LegacyDefaultErrorHandlerBuilder retryAttemptedLogInterval(int retryAttemptedLogInterval)
      Deprecated.

    • logStackTrace

      public LegacyDefaultErrorHandlerBuilder logStackTrace(boolean logStackTrace)
      Deprecated.

    • logRetryStackTrace

      public LegacyDefaultErrorHandlerBuilder logRetryStackTrace(boolean logRetryStackTrace)
      Deprecated.

    • logHandled

      public LegacyDefaultErrorHandlerBuilder logHandled(boolean logHandled)
      Deprecated.

    • logNewException

      public LegacyDefaultErrorHandlerBuilder logNewException(boolean logNewException)
      Deprecated.

    • logExhausted

      public LegacyDefaultErrorHandlerBuilder logExhausted(boolean logExhausted)
      Deprecated.

    • logRetryAttempted

      public LegacyDefaultErrorHandlerBuilder logRetryAttempted(boolean logRetryAttempted)
      Deprecated.

    • logExhaustedMessageHistory

      public LegacyDefaultErrorHandlerBuilder logExhaustedMessageHistory(boolean logExhaustedMessageHistory)
      Deprecated.

    • logExhaustedMessageBody

      public LegacyDefaultErrorHandlerBuilder logExhaustedMessageBody(boolean logExhaustedMessageBody)
      Deprecated.

    • exchangeFormatterRef

      public LegacyDefaultErrorHandlerBuilder exchangeFormatterRef(String exchangeFormatterRef)
      Deprecated.

    • asyncDelayedRedelivery

      public LegacyDefaultErrorHandlerBuilder asyncDelayedRedelivery()
      Deprecated.
      Will allow asynchronous delayed redeliveries. The route, in particular the consumer's component, must support the Asynchronous Routing Engine (e.g. seda)
      Returns:
      the builder
      See Also:
      • RedeliveryPolicy.setAsyncDelayedRedelivery(boolean)

    • allowRedeliveryWhileStopping

      public LegacyDefaultErrorHandlerBuilder allowRedeliveryWhileStopping(boolean allowRedeliveryWhileStopping)
      Deprecated.
      Controls whether to allow redelivery while stopping/shutting down a route that uses error handling.
      Parameters:
      allowRedeliveryWhileStopping - true to allow redelivery, false to reject redeliveries
      Returns:
      the builder

    • executorService

      public LegacyDefaultErrorHandlerBuilder executorService(ScheduledExecutorService executorService)
      Deprecated.
      Sets the thread pool to be used for redelivery.
      Parameters:
      executorService - the scheduled thread pool to use
      Returns:
      the builder.

    • executorServiceRef

      public LegacyDefaultErrorHandlerBuilder executorServiceRef(String ref)
      Deprecated.
      Sets a reference to a thread pool to be used for redelivery.
      Parameters:
      ref - reference to a scheduled thread pool
      Returns:
      the builder.

    • logger

      public LegacyDefaultErrorHandlerBuilder logger(org.apache.camel.spi.CamelLogger logger)
      Deprecated.
      Sets the logger used for caught exceptions
      Parameters:
      logger - the logger
      Returns:
      the builder

    • loggingLevel

      public LegacyDefaultErrorHandlerBuilder loggingLevel(org.apache.camel.LoggingLevel level)
      Deprecated.
      Sets the logging level of exceptions caught
      Parameters:
      level - the logging level
      Returns:
      the builder

    • log

      public LegacyDefaultErrorHandlerBuilder log(org.slf4j.Logger log)
      Deprecated.
      Sets the log used for caught exceptions
      Parameters:
      log - the logger
      Returns:
      the builder

    • log

      public LegacyDefaultErrorHandlerBuilder log(String log)
      Deprecated.
      Sets the log used for caught exceptions
      Parameters:
      log - the log name
      Returns:
      the builder

    • log

      public LegacyDefaultErrorHandlerBuilder log(Class<?> log)
      Deprecated.
      Sets the log used for caught exceptions
      Parameters:
      log - the log class
      Returns:
      the builder

    • onRedelivery

      public LegacyDefaultErrorHandlerBuilder onRedelivery(org.apache.camel.Processor processor)
      Deprecated.
      Sets a processor that should be processed before a redelivery attempt.

      Can be used to change the Exchange before its being redelivered.

      Parameters:
      processor - the processor
      Returns:
      the builder

    • onRedeliveryRef

      public LegacyDefaultErrorHandlerBuilder onRedeliveryRef(String onRedeliveryRef)
      Deprecated.
      Sets a reference for the processor to use before a redelivery attempt.
      Parameters:
      onRedeliveryRef - the processor's reference
      Returns:
      the builder
      See Also:

    • retryWhile

      public LegacyDefaultErrorHandlerBuilder retryWhile(org.apache.camel.Expression retryWhile)
      Deprecated.
      Sets the retry while expression.

      Will continue retrying until expression evaluates to false.

      Parameters:
      retryWhile - expression that determines when to stop retrying
      Returns:
      the builder

    • retryWhileRef

      public LegacyDefaultErrorHandlerBuilder retryWhileRef(String retryWhileRef)
      Deprecated.

    • useOriginalMessage

      public LegacyDefaultErrorHandlerBuilder useOriginalMessage()
      Deprecated.
      Will use the original input Message (original body and headers) when an Exchange is moved to the dead letter queue.

      Notice: this only applies when all redeliveries attempt have failed and the Exchange is doomed for failure.
      Instead of using the current inprogress Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the Exchange again as the IN message is the same as when Camel received it. So you should be able to send the Exchange to the same input.

      The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody.

      The original input message is defensively copied, and the copied message body is converted to StreamCache if possible, to ensure the body can be read when the original message is being used later. If the body is not converted to StreamCache then the body will not be able to re-read when accessed later.

      Important: The original input means the input message that are bounded by the current UnitOfWork. An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message.

      By default this feature is off.

      Returns:
      the builder
      See Also:

    • useOriginalBody

      public LegacyDefaultErrorHandlerBuilder useOriginalBody()
      Deprecated.
      Will use the original input Message body (original body only) when an Exchange is moved to the dead letter queue.

      Notice: this only applies when all redeliveries attempt have failed and the Exchange is doomed for failure.
      Instead of using the current inprogress Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the Exchange again as the IN message is the same as when Camel received it. So you should be able to send the Exchange to the same input.

      The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody.

      The original input message is defensively copied, and the copied message body is converted to StreamCache if possible, to ensure the body can be read when the original message is being used later. If the body is not converted to StreamCache then the body will not be able to re-read when accessed later.

      Important: The original input means the input message that are bounded by the current UnitOfWork. An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message.

      By default this feature is off.

      Returns:
      the builder
      See Also:

    • deadLetterHandleNewException

      public LegacyDefaultErrorHandlerBuilder deadLetterHandleNewException(boolean handleNewException)
      Deprecated.
      Whether the dead letter channel should handle (and ignore) any new exception that may been thrown during sending the message to the dead letter endpoint.

      The default value is true which means any such kind of exception is handled and ignored. Set this to false to let the exception be propagated back on the Exchange. This can be used in situations where you use transactions, and want to use Camel's dead letter channel to deal with exceptions during routing, but if the dead letter channel itself fails because of a new exception being thrown, then by setting this to false the new exceptions is propagated back and set on the Exchange, which allows the transaction to detect the exception, and rollback.

      Parameters:
      handleNewException - true to handle (and ignore), false to catch and propagated the exception on the Exchange
      Returns:
      the builder

    • onPrepareFailure

      public LegacyDefaultErrorHandlerBuilder onPrepareFailure(org.apache.camel.Processor processor)
      Deprecated.
      Sets a custom Processor to prepare the Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue.
      Parameters:
      processor - the processor
      Returns:
      the builder

    • onPrepareFailureRef

      public LegacyDefaultErrorHandlerBuilder onPrepareFailureRef(String onPrepareFailureRef)
      Deprecated.
      Sets a reference for the processor to use before handled by the failure processor.
      Parameters:
      onPrepareFailureRef - the processor's reference
      Returns:
      the builder
      See Also:

    • onExceptionOccurred

      public LegacyDefaultErrorHandlerBuilder onExceptionOccurred(org.apache.camel.Processor processor)
      Deprecated.
      Sets a custom Processor to process the Exchange just after an exception was thrown. This allows to execute the processor at the same time the exception was thrown.

      Important: Any exception thrown from this processor will be ignored.

      Parameters:
      processor - the processor
      Returns:
      the builder

    • onExceptionOccurredRef

      public LegacyDefaultErrorHandlerBuilder onExceptionOccurredRef(String onExceptionOccurredRef)
      Deprecated.
      Sets a reference for the processor to use just after an exception was thrown.
      Parameters:
      onExceptionOccurredRef - the processor's reference
      Returns:
      the builder
      See Also:

    • hasRedeliveryPolicy

      public boolean hasRedeliveryPolicy()
      Deprecated.
      Specified by:
      hasRedeliveryPolicy in interface DefaultErrorHandlerProperties

    • getDefaultRedeliveryPolicy

      public org.apache.camel.processor.errorhandler.RedeliveryPolicy getDefaultRedeliveryPolicy()
      Deprecated.
      Specified by:
      getDefaultRedeliveryPolicy in interface DefaultErrorHandlerProperties

    • getRedeliveryPolicy

      public org.apache.camel.processor.errorhandler.RedeliveryPolicy getRedeliveryPolicy()
      Deprecated.
      Specified by:
      getRedeliveryPolicy in interface DefaultErrorHandlerProperties

    • setRedeliveryPolicy

      public void setRedeliveryPolicy(org.apache.camel.processor.errorhandler.RedeliveryPolicy redeliveryPolicy)
      Deprecated.
      Sets the redelivery policy
      Specified by:
      setRedeliveryPolicy in interface DefaultErrorHandlerProperties

    • hasLogger

      public boolean hasLogger()
      Deprecated.
      Specified by:
      hasLogger in interface DefaultErrorHandlerProperties

    • getLogger

      public org.apache.camel.spi.CamelLogger getLogger()
      Deprecated.
      Specified by:
      getLogger in interface DefaultErrorHandlerProperties

    • setLogger

      public void setLogger(org.apache.camel.spi.CamelLogger logger)
      Deprecated.
      Specified by:
      setLogger in interface DefaultErrorHandlerProperties

    • getOnRedelivery

      public org.apache.camel.Processor getOnRedelivery()
      Deprecated.
      Specified by:
      getOnRedelivery in interface DefaultErrorHandlerProperties

    • setOnRedelivery

      public void setOnRedelivery(org.apache.camel.Processor onRedelivery)
      Deprecated.
      Specified by:
      setOnRedelivery in interface DefaultErrorHandlerProperties

    • getOnRedeliveryRef

      public String getOnRedeliveryRef()
      Deprecated.
      Specified by:
      getOnRedeliveryRef in interface DefaultErrorHandlerProperties

    • setOnRedeliveryRef

      public void setOnRedeliveryRef(String onRedeliveryRef)
      Deprecated.
      Specified by:
      setOnRedeliveryRef in interface DefaultErrorHandlerProperties

    • getRetryWhilePolicy

      public org.apache.camel.Predicate getRetryWhilePolicy(org.apache.camel.CamelContext context)
      Deprecated.

    • getRetryWhile

      public org.apache.camel.Predicate getRetryWhile()
      Deprecated.
      Specified by:
      getRetryWhile in interface DefaultErrorHandlerProperties

    • setRetryWhile

      public void setRetryWhile(org.apache.camel.Predicate retryWhile)
      Deprecated.
      Specified by:
      setRetryWhile in interface DefaultErrorHandlerProperties

    • getRetryWhileRef

      public String getRetryWhileRef()
      Deprecated.
      Specified by:
      getRetryWhileRef in interface DefaultErrorHandlerProperties

    • setRetryWhileRef

      public void setRetryWhileRef(String retryWhileRef)
      Deprecated.
      Specified by:
      setRetryWhileRef in interface DefaultErrorHandlerProperties

    • getDeadLetterUri

      public String getDeadLetterUri()
      Deprecated.
      Specified by:
      getDeadLetterUri in interface DefaultErrorHandlerProperties

    • setDeadLetterUri

      public void setDeadLetterUri(String deadLetterUri)
      Deprecated.
      Specified by:
      setDeadLetterUri in interface DefaultErrorHandlerProperties

    • isDeadLetterHandleNewException

      public boolean isDeadLetterHandleNewException()
      Deprecated.
      Specified by:
      isDeadLetterHandleNewException in interface DefaultErrorHandlerProperties

    • setDeadLetterHandleNewException

      public void setDeadLetterHandleNewException(boolean deadLetterHandleNewException)
      Deprecated.
      Specified by:
      setDeadLetterHandleNewException in interface DefaultErrorHandlerProperties

    • isUseOriginalMessage

      public boolean isUseOriginalMessage()
      Deprecated.
      Specified by:
      isUseOriginalMessage in interface DefaultErrorHandlerProperties

    • setUseOriginalMessage

      public void setUseOriginalMessage(boolean useOriginalMessage)
      Deprecated.
      Specified by:
      setUseOriginalMessage in interface DefaultErrorHandlerProperties

    • isUseOriginalBody

      public boolean isUseOriginalBody()
      Deprecated.
      Specified by:
      isUseOriginalBody in interface DefaultErrorHandlerProperties

    • setUseOriginalBody

      public void setUseOriginalBody(boolean useOriginalBody)
      Deprecated.
      Specified by:
      setUseOriginalBody in interface DefaultErrorHandlerProperties

    • isAsyncDelayedRedelivery

      public boolean isAsyncDelayedRedelivery()
      Deprecated.
      Specified by:
      isAsyncDelayedRedelivery in interface DefaultErrorHandlerProperties

    • setAsyncDelayedRedelivery

      public void setAsyncDelayedRedelivery(boolean asyncDelayedRedelivery)
      Deprecated.
      Specified by:
      setAsyncDelayedRedelivery in interface DefaultErrorHandlerProperties

    • getExecutorService

      public ScheduledExecutorService getExecutorService()
      Deprecated.
      Specified by:
      getExecutorService in interface DefaultErrorHandlerProperties

    • setExecutorService

      public void setExecutorService(ScheduledExecutorService executorService)
      Deprecated.
      Specified by:
      setExecutorService in interface DefaultErrorHandlerProperties

    • getExecutorServiceRef

      public String getExecutorServiceRef()
      Deprecated.
      Specified by:
      getExecutorServiceRef in interface DefaultErrorHandlerProperties

    • setExecutorServiceRef

      public void setExecutorServiceRef(String executorServiceRef)
      Deprecated.
      Specified by:
      setExecutorServiceRef in interface DefaultErrorHandlerProperties

    • getOnPrepareFailure

      public org.apache.camel.Processor getOnPrepareFailure()
      Deprecated.
      Specified by:
      getOnPrepareFailure in interface DefaultErrorHandlerProperties

    • setOnPrepareFailure

      public void setOnPrepareFailure(org.apache.camel.Processor onPrepareFailure)
      Deprecated.
      Specified by:
      setOnPrepareFailure in interface DefaultErrorHandlerProperties

    • getOnPrepareFailureRef

      public String getOnPrepareFailureRef()
      Deprecated.
      Specified by:
      getOnPrepareFailureRef in interface DefaultErrorHandlerProperties

    • setOnPrepareFailureRef

      public void setOnPrepareFailureRef(String onPrepareFailureRef)
      Deprecated.
      Specified by:
      setOnPrepareFailureRef in interface DefaultErrorHandlerProperties

    • getOnExceptionOccurred

      public org.apache.camel.Processor getOnExceptionOccurred()
      Deprecated.
      Specified by:
      getOnExceptionOccurred in interface DefaultErrorHandlerProperties

    • setOnExceptionOccurred

      public void setOnExceptionOccurred(org.apache.camel.Processor onExceptionOccurred)
      Deprecated.
      Specified by:
      setOnExceptionOccurred in interface DefaultErrorHandlerProperties

    • getOnExceptionOccurredRef

      public String getOnExceptionOccurredRef()
      Deprecated.
      Specified by:
      getOnExceptionOccurredRef in interface DefaultErrorHandlerProperties

    • setOnExceptionOccurredRef

      public void setOnExceptionOccurredRef(String onExceptionOccurredRef)
      Deprecated.
      Specified by:
      setOnExceptionOccurredRef in interface DefaultErrorHandlerProperties

    • createRedeliveryPolicy

      protected org.apache.camel.processor.errorhandler.RedeliveryPolicy createRedeliveryPolicy()
      Deprecated.

    • createLogger

      protected org.apache.camel.spi.CamelLogger createLogger()
      Deprecated.

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object