ErrorHandlerDefinition (Camel :: Spring XML 3.14.0 API)

java.lang.Object
- org.apache.camel.model.IdentifiedType
- - org.apache.camel.spring.xml.ErrorHandlerDefinition

@Metadata(label="spring,configuration,error")
public class ErrorHandlerDefinition
extends org.apache.camel.model.IdentifiedType

Error handler settings

Constructor Summary

Constructors
Constructor and Description

ErrorHandlerDefinition()

Constructors
Constructor and Description
`ErrorHandlerDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDeadLetterHandleNewException()`
`String`	`getDeadLetterUri()`
`String`	`getExecutorServiceRef()`
`org.apache.camel.LoggingLevel`	`getLevel()`
`String`	`getLogName()`
`String`	`getOnExceptionOccurredRef()`
`String`	`getOnPrepareFailureRef()`
`String`	`getOnRedeliveryRef()`
`CamelRedeliveryPolicyFactoryBean`	`getRedeliveryPolicy()`
`String`	`getRedeliveryPolicyRef()`
`String`	`getRetryWhileRef()`
`org.apache.camel.LoggingLevel`	`getRollbackLoggingLevel()`
`String`	`getTransactionManagerRef()`
`String`	`getTransactionTemplateRef()`
`ErrorHandlerType`	`getType()`
`Boolean`	`getUseOriginalBody()`
`Boolean`	`getUseOriginalMessage()`
`void`	`setDeadLetterHandleNewException(String deadLetterHandleNewException)` 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.
`void`	`setDeadLetterUri(String deadLetterUri)` The dead letter endpoint uri for the Dead Letter error handler.
`void`	`setExecutorServiceRef(String executorServiceRef)` Sets a reference to a thread pool to be used by the error handler
`void`	`setLevel(org.apache.camel.LoggingLevel level)` Logging level to use when using the logging error handler type.
`void`	`setLogName(String logName)` Name of the logger to use for the logging error handler
`void`	`setOnExceptionOccurredRef(String onExceptionOccurredRef)` Sets a reference to a processor that should be processed just after an exception occurred.
`void`	`setOnPrepareFailureRef(String onPrepareFailureRef)` Sets a reference to a processor to prepare the `Exchange` before handled by the failure processor / dead letter channel.
`void`	`setOnRedeliveryRef(String onRedeliveryRef)` Sets a reference to a processor that should be processed before a redelivery attempt.
`void`	`setRedeliveryPolicy(CamelRedeliveryPolicyFactoryBean redeliveryPolicy)` Sets the redelivery settings
`void`	`setRedeliveryPolicyRef(String redeliveryPolicyRef)` Sets a reference to a `RedeliveryPolicy` to be used for redelivery settings.
`void`	`setRetryWhileRef(String retryWhileRef)` Sets a reference to an retry while expression.
`void`	`setRollbackLoggingLevel(org.apache.camel.LoggingLevel rollbackLoggingLevel)` Sets the logging level to use for logging transactional rollback.
`void`	`setTransactionManagerRef(String transactionManagerRef)` References to the `PlatformTransactionManager` to use with the transaction error handler.
`void`	`setTransactionTemplateRef(String transactionTemplateRef)` References to the `TransactionTemplate` to use with the transaction error handler.
`void`	`setType(ErrorHandlerType type)` The type of the error handler
`void`	`setUseOriginalBody(Boolean useOriginalBody)` Will use the original input `Message` body (original body only) when an `Exchange` is moved to the dead letter queue.
`void`	`setUseOriginalMessage(Boolean useOriginalMessage)` Will use the original input `Message` (original body and headers) when an `Exchange` is moved to the dead letter queue.

Methods inherited from class org.apache.camel.model.IdentifiedType
getId, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ErrorHandlerDefinition
```
public ErrorHandlerDefinition()
```
- Method Detail
  - getType
```
public ErrorHandlerType getType()
```
  - setType
```
public void setType(ErrorHandlerType type)
```
    The type of the error handler
  - getDeadLetterUri
```
public String getDeadLetterUri()
```
  - setDeadLetterUri
```
public void setDeadLetterUri(String deadLetterUri)
```
    The dead letter endpoint uri for the Dead Letter error handler.
  - getDeadLetterHandleNewException
```
public String getDeadLetterHandleNewException()
```
  - setDeadLetterHandleNewException
```
public void setDeadLetterHandleNewException(String deadLetterHandleNewException)
```
    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.
  - getLevel
```
public org.apache.camel.LoggingLevel getLevel()
```
  - setLevel
```
public void setLevel(org.apache.camel.LoggingLevel level)
```
    Logging level to use when using the logging error handler type.
  - getRollbackLoggingLevel
```
public org.apache.camel.LoggingLevel getRollbackLoggingLevel()
```
  - setRollbackLoggingLevel
```
public void setRollbackLoggingLevel(org.apache.camel.LoggingLevel rollbackLoggingLevel)
```
    Sets the logging level to use for logging transactional rollback.
    This option is default WARN.
  - getLogName
```
public String getLogName()
```
  - setLogName
```
public void setLogName(String logName)
```
    Name of the logger to use for the logging error handler
  - getUseOriginalMessage
```
public Boolean getUseOriginalMessage()
```
  - setUseOriginalMessage
```
public void setUseOriginalMessage(Boolean useOriginalMessage)
```
    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.
    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 splitted 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.
    
    See Also:
    
    setUseOriginalBody(Boolean)
  - getUseOriginalBody
```
public Boolean getUseOriginalBody()
```
  - setUseOriginalBody
```
public void setUseOriginalBody(Boolean useOriginalBody)
```
    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.
    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 splitted 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.
    
    See Also:
    
    setUseOriginalMessage(Boolean)
  - getTransactionTemplateRef
```
public String getTransactionTemplateRef()
```
  - setTransactionTemplateRef
```
public void setTransactionTemplateRef(String transactionTemplateRef)
```
    References to the TransactionTemplate to use with the transaction error handler.
  - getTransactionManagerRef
```
public String getTransactionManagerRef()
```
  - setTransactionManagerRef
```
public void setTransactionManagerRef(String transactionManagerRef)
```
    References to the PlatformTransactionManager to use with the transaction error handler.
  - getOnRedeliveryRef
```
public String getOnRedeliveryRef()
```
  - setOnRedeliveryRef
```
public void setOnRedeliveryRef(String onRedeliveryRef)
```
    Sets a reference to a processor that should be processed before a redelivery attempt.
    Can be used to change the Exchange before its being redelivered.
  - getOnExceptionOccurredRef
```
public String getOnExceptionOccurredRef()
```
  - setOnExceptionOccurredRef
```
public void setOnExceptionOccurredRef(String onExceptionOccurredRef)
```
    Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened.
    Important: Any exception thrown from this processor will be ignored.
  - getOnPrepareFailureRef
```
public String getOnPrepareFailureRef()
```
  - setOnPrepareFailureRef
```
public void setOnPrepareFailureRef(String onPrepareFailureRef)
```
    Sets a reference to a 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.
  - getRetryWhileRef
```
public String getRetryWhileRef()
```
  - setRetryWhileRef
```
public void setRetryWhileRef(String retryWhileRef)
```
    Sets a reference to an retry while expression.
    Will continue retrying until expression evaluates to false.
  - getRedeliveryPolicyRef
```
public String getRedeliveryPolicyRef()
```
  - setRedeliveryPolicyRef
```
public void setRedeliveryPolicyRef(String redeliveryPolicyRef)
```
    Sets a reference to a RedeliveryPolicy to be used for redelivery settings.
  - getExecutorServiceRef
```
public String getExecutorServiceRef()
```
  - setExecutorServiceRef
```
public void setExecutorServiceRef(String executorServiceRef)
```
    Sets a reference to a thread pool to be used by the error handler
  - getRedeliveryPolicy
```
public CamelRedeliveryPolicyFactoryBean getRedeliveryPolicy()
```
  - setRedeliveryPolicy
```
public void setRedeliveryPolicy(CamelRedeliveryPolicyFactoryBean redeliveryPolicy)
```
    Sets the redelivery settings

Class ErrorHandlerDefinition

Constructor Summary

Method Summary

Methods inherited from class org.apache.camel.model.IdentifiedType

Methods inherited from class java.lang.Object

Constructor Detail

ErrorHandlerDefinition

Method Detail

getType

setType

getDeadLetterUri

setDeadLetterUri

getDeadLetterHandleNewException

setDeadLetterHandleNewException

getLevel

setLevel

getRollbackLoggingLevel

setRollbackLoggingLevel

getLogName

setLogName

getUseOriginalMessage

setUseOriginalMessage

getUseOriginalBody

setUseOriginalBody

getTransactionTemplateRef

setTransactionTemplateRef

getTransactionManagerRef

setTransactionManagerRef

getOnRedeliveryRef

setOnRedeliveryRef

getOnExceptionOccurredRef

setOnExceptionOccurredRef

getOnPrepareFailureRef

setOnPrepareFailureRef

getRetryWhileRef

setRetryWhileRef

getRedeliveryPolicyRef

setRedeliveryPolicyRef

getExecutorServiceRef

setExecutorServiceRef

getRedeliveryPolicy

setRedeliveryPolicy