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

Class ClientStreamDelivery

java.lang.Object

org.apache.qpid.protonj2.client.impl.ClientDeliverable<ClientStreamDelivery,ClientStreamReceiver>

org.apache.qpid.protonj2.client.impl.ClientStreamDelivery

All Implemented Interfaces:

StreamDelivery

public final class ClientStreamDelivery
extends ClientDeliverable<ClientStreamDelivery,ClientStreamReceiver>
implements StreamDelivery

A StreamDelivery implementation that provides the mechanics of reading message types from an incoming split framed transfer.

Field Summary

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

delivery

Method Summary

Modifier and Type	Method	Description
boolean	aborted()	Check if the StreamDelivery has been marked as aborted by the remote sender.
Map<String,Object>	annotations()	Decodes the StreamDelivery payload and returns a Map containing a copy of any associated DeliveryAnnotations that were transmitted with the Message payload of this StreamDelivery.
boolean	completed()	Check if the StreamDelivery has been marked as complete by the remote sender.
ClientStreamReceiverMessage	message()	Decode the StreamDelivery payload and return an Message object.
InputStream	rawInputStream()	Create and return an InputStream that reads the raw payload bytes of the given StreamDelivery.
ClientStreamReceiver	receiver()
protected ClientStreamDelivery	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.StreamDelivery

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

Method Detail

self

protected ClientStreamDelivery self()

Specified by:

self in class ClientDeliverable<ClientStreamDelivery,ClientStreamReceiver>

receiver

public ClientStreamReceiver receiver()

Specified by:

receiver in interface StreamDelivery

Returns:

the StreamReceiver that originated this StreamDelivery.

aborted

public boolean aborted()

Description copied from interface: StreamDelivery

Check if the StreamDelivery has been marked as aborted by the remote sender.

Specified by:

aborted in interface StreamDelivery

Returns:

true if this context has been marked as aborted previously.

completed

public boolean completed()

Description copied from interface: StreamDelivery

Check if the StreamDelivery has been marked as complete by the remote sender.

Specified by:

completed in interface StreamDelivery

Returns:

true if this context has been marked as being the complete.

message

public ClientStreamReceiverMessage message()
                                    throws ClientException

Description copied from interface: StreamDelivery

Decode the StreamDelivery payload and return an Message object.

If the incoming message carried any delivery annotations they can be accessed via the StreamDelivery.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 StreamDelivery.rawInputStream() method of the StreamDelivery object. Calling the StreamDelivery.rawInputStream() method after calling this method throws ClientIllegalStateException.

Specified by:

message in interface StreamDelivery

Returns:

a Message instance that wraps the decoded payload.

Throws:

ClientException - if an error occurs while decoding the payload.

annotations

public Map<String,Object> annotations()
                                     throws ClientException

Description copied from interface: StreamDelivery

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

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

Specified by:

annotations in interface StreamDelivery

Returns:

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

Throws:

ClientException - if an error occurs while decoding the payload.

rawInputStream

public InputStream rawInputStream()
                           throws ClientException

Description copied from interface: StreamDelivery

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

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

Specified by:

rawInputStream in interface StreamDelivery

Returns:

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

Throws:

ClientException - if an error occurs while decoding the payload.