org.axonframework.messaging.deadletter

Class ShouldEnqueue<M extends Message<?>>

java.lang.Object

org.axonframework.messaging.deadletter.ShouldEnqueue<M>

Type Parameters:

M - An implementation of Message contained in the dead letter that's been made a decision on.

All Implemented Interfaces:

EnqueueDecision<M>

public class ShouldEnqueue<M extends Message<?>>
extends Object
implements EnqueueDecision<M>

An EnqueueDecision stating a dead letter should be enqueued.

Since:

4.6.0

Author:

Steven van Beelen

Constructor Summary

Constructors

Constructor and Description
ShouldEnqueue() Constructs a default EnqueueDecision.
ShouldEnqueue(Throwable enqueueCause) Constructs a default EnqueueDecision to enqueue using the given enqueueCause as the enqueueCause().
ShouldEnqueue(Throwable enqueueCause, Function<DeadLetter<? extends M>,MetaData> diagnosticsBuilder) Constructs a default EnqueueDecision to enqueue using the given enqueueCause as the enqueueCause().

Method Summary

Modifier and Type	Method and Description
Optional<Throwable>	enqueueCause() A Throwable Optional that was part of deciding to enqueue the dead letter in a queue.
boolean	equals(Object o)
int	hashCode()
boolean	shouldEnqueue() The decision whether the dead letter should be enqueued in a queue.
String	toString()
DeadLetter<? extends M>	withDiagnostics(DeadLetter<? extends M> letter) Adds DeadLetter.diagnostics() MetaData to the given letter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShouldEnqueue

public ShouldEnqueue()

Constructs a default EnqueueDecision. This decision does not carry any enqueueCause() or diagnostics.

ShouldEnqueue

public ShouldEnqueue(Throwable enqueueCause)

Constructs a default EnqueueDecision to enqueue using the given enqueueCause as the enqueueCause().

Parameters:

enqueueCause - The Throwable that was used to decide to enqueue.

ShouldEnqueue

public ShouldEnqueue(Throwable enqueueCause,
                     Function<DeadLetter<? extends M>,MetaData> diagnosticsBuilder)

Constructs a default EnqueueDecision to enqueue using the given enqueueCause as the enqueueCause().

Parameters:

enqueueCause - The Throwable that was used to decide to enqueue.

diagnosticsBuilder - A function constructing diagnostics to append during withDiagnostics(DeadLetter).

Method Detail

shouldEnqueue

public boolean shouldEnqueue()

Description copied from interface: EnqueueDecision

The decision whether the dead letter should be enqueued in a queue. When false the dead letter should be evicted.

Specified by:

shouldEnqueue in interface EnqueueDecision<M extends Message<?>>

Returns:

true if the dead letter should be enqueued, false if the dead letter should be evicted.

enqueueCause

public Optional<Throwable> enqueueCause()

Description copied from interface: EnqueueDecision

A Throwable Optional that was part of deciding to enqueue the dead letter in a queue. Empty if the dead letter should be evicted or when there is no failure cause used for deciding to enqueue.

Specified by:

enqueueCause in interface EnqueueDecision<M extends Message<?>>

Returns:

The deciding failure for enqueueing a dead letter, when present.

withDiagnostics

public DeadLetter<? extends M> withDiagnostics(DeadLetter<? extends M> letter)

Description copied from interface: EnqueueDecision

Adds DeadLetter.diagnostics() MetaData to the given letter. The added diagnostics may provide additional information on the decision that may be used to influence future decisions.

By default, the letter is returned as is.

Specified by:

withDiagnostics in interface EnqueueDecision<M extends Message<?>>

Parameters:

letter - The dead letter to add diagnostic MetaData to.

Returns:

A copy of the given letter when diagnostic MetaData was added.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object