Package org.apache.qpid.protonj2.client.impl

Class ClientDelivery

java.lang.Object

org.apache.qpid.protonj2.client.impl.ClientDelivery

All Implemented Interfaces:

Delivery

public final class ClientDelivery
extends java.lang.Object
implements Delivery

Client inbound delivery object.

Method Summary

Modifier and Type	Method	Description
Delivery	accept()	Accepts and settles the delivery.
java.util.Map<java.lang.String,java.lang.Object>	annotations()	Decodes the Delivery payload and returns a Map containing a copy of any associated DeliveryAnnotations that were transmitted with the Message payload of this Delivery.
Delivery	disposition(DeliveryState state, boolean settle)	Updates the DeliveryState, and optionally settle the delivery as well.
<E> Message<E>	message()	Decode the Delivery payload and return an Message object.
int	messageFormat()	Gets the message format for the current delivery.
Delivery	modified(boolean deliveryFailed, boolean undeliverableHere)	Modifies and settles the delivery.
java.io.InputStream	rawInputStream()	Create and return an InputStream that reads the raw payload bytes of the given Delivery.
Receiver	receiver()
Delivery	reject(java.lang.String condition, java.lang.String description)	Rejects and settles the delivery, sending supplied error information along with the rejection.
Delivery	release()	Releases and settles the delivery.
boolean	remoteSettled()	Gets whether the delivery was settled by the remote peer yet.
DeliveryState	remoteState()	Gets the current remote state for the delivery.
Delivery	settle()	Settles the delivery locally.
boolean	settled()
DeliveryState	state()	Gets the current local state for the delivery.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

message

public <E> Message<E> message()
                       throws ClientException

Description copied from interface: Delivery

Decode the Delivery payload and return an Message object.

If the incoming message carried any delivery annotations they can be accessed via the Delivery.annotations() method. Re-sending the returned message will not also send the incoming delivery annotations, the sender must include them in the Sender.send(Message, Map) call if they are to be forwarded onto the next recipient.

Calling this message claims the payload of the delivery for the returned Message and excludes use of the Delivery.rawInputStream() method of the Delivery object. Calling the Delivery.rawInputStream() method after calling this method throws ClientIllegalStateException.

Specified by:

message in interface Delivery

Type Parameters:

E - The type of message body that should be contained in the returned Message.

Returns:

a Message instance that wraps the decoded payload.

Throws:

ClientException - if an error occurs while decoding the payload.

rawInputStream

public java.io.InputStream rawInputStream()
                                   throws ClientException

Description copied from interface: Delivery

Create and return an InputStream that reads the raw payload bytes of the given Delivery.

Calling this method claims the payload of the delivery for the returned InputStream and excludes use of the Delivery.message() and Delivery.annotations() methods of the Delivery object. Closing the returned input stream discards any unread bytes from the delivery payload. Calling the Delivery.message() or Delivery.annotations() methods after calling this method throws ClientIllegalStateException.

Specified by:

rawInputStream in interface Delivery

Returns:

an InputStream instance that can be used to read the raw delivery payload.

Throws:

ClientException - if an error occurs while decoding the payload.

annotations

public java.util.Map<java.lang.String,java.lang.Object> annotations()
                                                                   throws ClientException

Description copied from interface: Delivery

Decodes the Delivery payload and returns a Map containing a copy of any associated DeliveryAnnotations that were transmitted with the Message payload of this Delivery.

Calling this message claims the payload of the delivery for the returned Map and the decoded Message that can be accessed via the Delivery.message() method and excludes use of the Delivery.rawInputStream() method of the Delivery object. Calling the Delivery.rawInputStream() method after calling this method throws ClientIllegalStateException.

Specified by:

annotations in interface Delivery

Returns:

copy of the delivery annotations that were transmitted with the Message payload.

Throws:

ClientException - if an error occurs while decoding the payload.

accept

public Delivery accept()
                throws ClientException

Description copied from interface: Delivery

Accepts and settles the delivery.

Specified by:

accept in interface Delivery

Returns:

this Delivery instance.

Throws:

ClientException - if an error occurs while sending the disposition

release

public Delivery release()
                 throws ClientException

Description copied from interface: Delivery

Releases and settles the delivery.

Specified by:

release in interface Delivery

Returns:

this Delivery instance.

Throws:

ClientException - if an error occurs while sending the disposition

reject

public Delivery reject(java.lang.String condition,
                       java.lang.String description)
                throws ClientException

Description copied from interface: Delivery

Rejects and settles the delivery, sending supplied error information along with the rejection.

Specified by:

reject in interface Delivery

Parameters:

condition - The error condition value to supply with the rejection.

description - The error description value to supply with the rejection.

Returns:

this Delivery instance.

Throws:

ClientException - if an error occurs while sending the disposition

modified

public Delivery modified(boolean deliveryFailed,
                         boolean undeliverableHere)
                  throws ClientException

Description copied from interface: Delivery

Modifies and settles the delivery.

Specified by:

modified in interface Delivery

Parameters:

deliveryFailed - Indicates if the modified delivery failed.

undeliverableHere - Indicates if the modified delivery should not be returned here again.

Returns:

this Delivery instance.

Throws:

ClientException - if an error occurs while sending the disposition

disposition

public Delivery disposition(DeliveryState state,
                            boolean settle)
                     throws ClientException

Description copied from interface: Delivery

Updates the DeliveryState, and optionally settle the delivery as well.

Specified by:

disposition in interface Delivery

Parameters:

state - the delivery state to apply

settle - whether to Delivery.settle() the delivery at the same time

Returns:

this Delivery instance.

Throws:

ClientException - if an error occurs while sending the disposition

settle

public Delivery settle()
                throws ClientException

Description copied from interface: Delivery

Settles the delivery locally.

Specified by:

settle in interface Delivery

Returns:

the delivery

Throws:

ClientException - if an error occurs while sending the disposition

state

public DeliveryState state()

Description copied from interface: Delivery

Gets the current local state for the delivery.

Specified by:

state in interface Delivery

Returns:

the delivery state

remoteState

public DeliveryState remoteState()

Description copied from interface: Delivery

Gets the current remote state for the delivery.

Specified by:

remoteState in interface Delivery

Returns:

the remote delivery state

remoteSettled

public boolean remoteSettled()

Description copied from interface: Delivery

Gets whether the delivery was settled by the remote peer yet.

Specified by:

remoteSettled in interface Delivery

Returns:

whether the delivery is remotely settled

messageFormat

public int messageFormat()

Description copied from interface: Delivery

Gets the message format for the current delivery.

Specified by:

messageFormat in interface Delivery

Returns:

the message format

receiver

public Receiver receiver()

Specified by:

receiver in interface Delivery

Returns:

the Receiver that originated this Delivery.

settled

public boolean settled()

Specified by:

settled in interface Delivery

Returns:

true if the delivery has been locally settled.