Package org.apache.qpid.protonj2.client

Interface DeliveryState

All Known Implementing Classes:

ClientDeliveryState, ClientDeliveryState.ClientAccepted, ClientDeliveryState.ClientModified, ClientDeliveryState.ClientRejected, ClientDeliveryState.ClientReleased, ClientDeliveryState.ClientTransactional

public interface DeliveryState

Conveys the outcome of a Delivery either incoming or outgoing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DeliveryState.Type

Method Summary

Modifier and Type	Method	Description
static DeliveryState	accepted()
DeliveryState.Type	getType()
default boolean	isAccepted()
static DeliveryState	modified(boolean failed, boolean undeliverable)	Create a new Modified outcome with the given failure state.
static DeliveryState	modified(boolean failed, boolean undeliverable, java.util.Map<java.lang.String,java.lang.Object> annotations)	Create a new Modified outcome with the given failure state.
static DeliveryState	rejected(java.lang.String condition, java.lang.String description)	Create a new Rejected outcome with the given condition and description.
static DeliveryState	rejected(java.lang.String condition, java.lang.String description, java.util.Map<java.lang.String,java.lang.Object> info)	Create a new Rejected outcome with the given condition and description.
static DeliveryState	released()

Method Detail

getType

DeliveryState.Type getType()

Returns:

the type that the given DeliveryState represents.

isAccepted

default boolean isAccepted()

Returns:

true if the DeliveryState represents an Accepted outcome.

accepted

static DeliveryState accepted()

Returns:

an instance of an AMQP Accepted delivery outcome.

released

static DeliveryState released()

Returns:

an instance of an AMQP Released delivery outcome.

rejected

static DeliveryState rejected(java.lang.String condition,
                              java.lang.String description)

Create a new Rejected outcome with the given condition and description.

Parameters:

condition - the condition that lead to the rejected outcome.

description - a meaningful description of the reason for the rejection.

Returns:

an instance of an AMQP Rejected delivery outcome.

rejected

static DeliveryState rejected(java.lang.String condition,
                              java.lang.String description,
                              java.util.Map<java.lang.String,java.lang.Object> info)

Create a new Rejected outcome with the given condition and description.

Parameters:

condition - the condition that lead to the rejected outcome.

description - a meaningful description of the reason for the rejection.

info - a Map containing additional information about the rejection.

Returns:

an instance of an AMQP Rejected delivery outcome.

modified

static DeliveryState modified(boolean failed,
                              boolean undeliverable)

Create a new Modified outcome with the given failure state.

Parameters:

failed - boolean indicating if delivery failed or not.

undeliverable - boolean indicating if the delivery cannot be sent to this receiver again.

Returns:

an instance of an AMQP Modified delivery outcome.

modified

static DeliveryState modified(boolean failed,
                              boolean undeliverable,
                              java.util.Map<java.lang.String,java.lang.Object> annotations)

Create a new Modified outcome with the given failure state.

Parameters:

failed - boolean indicating if delivery failed or not.

undeliverable - boolean indicating if the delivery cannot be sent to this receiver again.

annotations - updated annotation for the delivery that this outcome applies to.

Returns:

an instance of an AMQP Modified delivery outcome.