Package org.apache.qpid.protonj2.client

Interface StreamDelivery

All Superinterfaces:

Delivery

All Known Implementing Classes:

ClientStreamDelivery

public interface StreamDelivery
extends Delivery

A specialized Delivery type that is returned from the StreamReceiver which can be used to read incoming large messages that are streamed via multiple incoming AMQP Transfer frames.

Method Summary

Modifier and Type	Method	Description
boolean	aborted()	Check if the StreamDelivery has been marked as aborted by the remote sender.
StreamDelivery	accept()	Accepts and settles the delivery.
boolean	completed()	Check if the StreamDelivery has been marked as complete by the remote sender.
StreamDelivery	disposition(DeliveryState state, boolean settle)	Updates the DeliveryState, and optionally settle the delivery as well.
StreamReceiverMessage	message()	Decode the Delivery payload and return an Message object.
StreamDelivery	modified(boolean deliveryFailed, boolean undeliverableHere)	Modifies and settles the delivery.
StreamReceiver	receiver()
StreamDelivery	reject(java.lang.String condition, java.lang.String description)	Rejects and settles the delivery, sending supplied error information along with the rejection.
StreamDelivery	release()	Releases and settles the delivery.
StreamDelivery	settle()	Settles the delivery locally.

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

annotations, messageFormat, rawInputStream, remoteSettled, remoteState, settled, state

Method Detail

receiver

StreamReceiver receiver()

Specified by:

receiver in interface Delivery

Returns:

the StreamReceiver that originated this StreamDelivery.

message

StreamReceiverMessage message()
                       throws ClientException

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

Returns:

a StreamReceiverMessage instance that can be used to read the incoming message stream.

Throws:

ClientException - if an error occurs while decoding the payload.

aborted

boolean aborted()

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

Returns:

true if this context has been marked as aborted previously.

completed

boolean completed()

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

Returns:

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

accept

StreamDelivery accept()
               throws ClientException

Accepts and settles the delivery.

Specified by:

accept in interface Delivery

Returns:

the StreamReceiver that originated this StreamDelivery.

Throws:

ClientException - if an error occurs while sending the disposition

release

StreamDelivery release()
                throws ClientException

Releases and settles the delivery.

Specified by:

release in interface Delivery

Returns:

the StreamReceiver that originated this StreamDelivery.

Throws:

ClientException - if an error occurs while sending the disposition

reject

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

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:

the StreamReceiver that originated this StreamDelivery.

Throws:

ClientException - if an error occurs while sending the disposition

modified

StreamDelivery modified(boolean deliveryFailed,
                        boolean undeliverableHere)
                 throws ClientException

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:

the StreamReceiver that originated this StreamDelivery.

Throws:

ClientException - if an error occurs while sending the disposition

disposition

StreamDelivery disposition(DeliveryState state,
                           boolean settle)
                    throws ClientException

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:

the StreamReceiver that originated this StreamDelivery.

Throws:

ClientException - if an error occurs while sending the disposition

settle

StreamDelivery settle()
               throws ClientException

Settles the delivery locally.

Specified by:

settle in interface Delivery

Returns:

the StreamReceiver that originated this StreamDelivery.

Throws:

ClientException - if an error occurs while sending the disposition