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

Class ClientDelivery

java.lang.Object

org.apache.qpid.protonj2.client.impl.ClientDeliverable<ClientDelivery,ClientReceiver>

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

All Implemented Interfaces:

Delivery

public final class ClientDelivery
extends ClientDeliverable<ClientDelivery,ClientReceiver>
implements Delivery

Client inbound delivery object.

Field Summary

Fields inherited from class org.apache.qpid.protonj2.client.impl.ClientDeliverable

delivery, receiver

Method Summary

Modifier and Type	Method	Description
Map<String,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.
<E> Message<E>	message()	Decode the Delivery payload and return an Message object.
InputStream	rawInputStream()	Create and return an InputStream that reads the raw payload bytes of the given Delivery.
Receiver	receiver()
protected ClientDelivery	self()

Methods inherited from class org.apache.qpid.protonj2.client.impl.ClientDeliverable

accept, disposition, messageFormat, modified, reject, release, remoteSettled, remoteState, settle, settled, state

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.protonj2.client.Delivery

accept, disposition, messageFormat, modified, reject, release, remoteSettled, remoteState, settle, settled, state

Method Detail

self

protected ClientDelivery self()

Specified by:

self in class ClientDeliverable<ClientDelivery,ClientReceiver>

receiver

public Receiver receiver()

Specified by:

receiver in interface Delivery

Returns:

the Receiver that originated this Delivery.

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.

Care should be taken if attempting to specify anything other than the wild card type for the body of the returned message as the wrong type specification can lead to an exception.

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 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 Map<String,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.