Annotation Interface Messaging.OnFailure

Enclosing class:

Messaging

@Documented
@Retention(CLASS)
@Target(METHOD)
public static @interface Messaging.OnFailure

Declares default delivery failure handling for the incoming channel named by Messaging.ReceiveFrom. The policy is channel- and delivery-scoped, so it covers sibling handlers and downstream outputs participating in the same source delivery rather than only the annotated method invocation. An explicitly configured failure option for the incoming channel overrides the corresponding declared option. Configuring failure.retry replaces the complete retry declared by this annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	deadLetterChannel	Logical channel used for dead-letter delivery.
int	maxAttempts	Maximum total delivery attempts, including the initial attempt.
FailureDisposition	onExhausted	Terminal disposition after delivery attempts are exhausted.
String	retryDelay	Delay before retrying a failed delivery, in Duration format.

Element Details

retryDelay

String retryDelay

Delay before retrying a failed delivery, in Duration format. This populates the retry prototype's RetryConfig.delay().

Returns:

retry delay

Default:

"PT1S"

maxAttempts

int maxAttempts

Maximum total delivery attempts, including the initial attempt. Zero uses the messaging default of Integer.MAX_VALUE calls. Positive values populate the retry prototype's RetryConfig.calls(). A pre-dispatch mapping failure reported through ConnectorDeliveryReservation.startFailed(MessageBatch, RuntimeException) or ConnectorDeliveryReservation.tryStartFailed(MessageBatch, RuntimeException) is treated as exhausted after its initial attempt because the runtime cannot repeat transport mapping.

Returns:

maximum delivery attempts, or zero for the messaging default

Default:

0

onExhausted

FailureDisposition onExhausted

Terminal disposition after delivery attempts are exhausted.

Returns:

terminal disposition

Default:

FAIL

deadLetterChannel

String deadLetterChannel

Logical channel used for dead-letter delivery. This is required for FailureDisposition.DEAD_LETTER and is not valid for other dispositions. A non-empty value populates DeadLetterConfig.channel().

Returns:

dead-letter channel, or an empty string when none is declared

Default:

""