com.ibm.mqlight.api

Interface Delivery

All Known Subinterfaces:

BytesDelivery, JsonDelivery, MalformedDelivery, StringDelivery

public interface Delivery

This interface is used to represent the delivery of a messages to the MQ Light client. It is sub-classed to represent the delivery of specific types of message data (e.g. binary and textual data).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Delivery.Type Possible types of data that can be associated with this delivery.

Method Summary

Modifier and Type	Method and Description
void	confirm() Confirms receipt of this delivery.
Map<String,Object>	getProperties()
QOS	getQOS()
String	getShare()
String	getTopic()
String	getTopicPattern()
long	getTtl()
Delivery.Type	getType()

Method Detail

getType

Delivery.Type getType()

Returns:

the type of the delivery. This is provided to simplify casting this interface to the more specific BytesDelivery and StringDelivery types.

confirm

void confirm()
      throws StateException

Confirms receipt of this delivery.

Throws:

StateException - if confirmation is not applicable or required. This is the case if any of the following conditions are true:

• the quality of service is QOS.AT_MOST_ONCE.
• auto confirmation of delivery is enabled.
• delivery has already been confirmed.
• the network state is such that delivery cannot be confirmed.

getQOS

QOS getQOS()

Returns:

the quality of service used to receive the messaging being delivered.

getShare

String getShare()

Returns:

the share name associated with the destination from which the message was received. A value of null is returned if the destination was not subscribed to with a share value.

getTopic

String getTopic()

Returns:

the topic to which the message, being delivered, was originally published.

getTopicPattern

String getTopicPattern()

Returns:

the topic pattern that was used to subscribe to the destination from which this message was delivered.

getTtl

long getTtl()

Returns:

the remaining time-to-live time, for the message being delivered, in milliseconds.

getProperties

Map<String,Object> getProperties()

Returns:

a Map of properties associated with the message being delivered. Keys will be non-null and values will be one of the following types: null, Boolean, Byte, Short, Integer, Long, Float, Double, byte[], and String.