org.apache.qpid.proton.message

Interface Message

All Known Subinterfaces:

ProtonJMessage

All Known Implementing Classes:

MessageImpl

public interface Message

Represents a Message within Proton. Create instances of Message using Message.Factory.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Message.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static short	DEFAULT_PRIORITY

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
int	decode(byte[] data, int offset, int length) TODO describe what happens if the data does not represent a complete message.
int	encode(byte[] data, int offset, int length) Encodes up to length bytes of the message into the provided byte array, starting at position offset.
String	getAddress()
ApplicationProperties	getApplicationProperties()
Section	getBody()
String	getContentEncoding()
String	getContentType()
Object	getCorrelationId()
long	getCreationTime()
DeliveryAnnotations	getDeliveryAnnotations()
long	getDeliveryCount()
MessageError	getError()
long	getExpiryTime()
Footer	getFooter()
String	getGroupId()
long	getGroupSequence()
Header	getHeader()
MessageAnnotations	getMessageAnnotations()
Object	getMessageId()
short	getPriority()
Properties	getProperties()
String	getReplyTo()
String	getReplyToGroupId()
String	getSubject()
long	getTtl()
byte[]	getUserId()
boolean	isDurable()
boolean	isFirstAcquirer()
void	setAddress(String to)
void	setApplicationProperties(ApplicationProperties applicationProperties)
void	setBody(Section body)
void	setContentEncoding(String contentEncoding)
void	setContentType(String contentType)
void	setCorrelationId(Object correlationId)
void	setCreationTime(long creationTime)
void	setDeliveryAnnotations(DeliveryAnnotations deliveryAnnotations)
void	setDeliveryCount(long deliveryCount)
void	setDurable(boolean durable)
void	setExpiryTime(long absoluteExpiryTime)
void	setFirstAcquirer(boolean firstAcquirer)
void	setFooter(Footer footer)
void	setGroupId(String groupId)
void	setGroupSequence(long groupSequence)
void	setHeader(Header header)
void	setMessageAnnotations(MessageAnnotations messageAnnotations)
void	setMessageId(Object messageId)
void	setPriority(short priority)
void	setProperties(Properties properties)
void	setReplyTo(String replyTo)
void	setReplyToGroupId(String replyToGroupId)
void	setSubject(String subject)
void	setTtl(long ttl)
void	setUserId(byte[] userId)

Field Detail

DEFAULT_PRIORITY

static final short DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

isDurable

boolean isDurable()

getDeliveryCount

long getDeliveryCount()

getPriority

short getPriority()

isFirstAcquirer

boolean isFirstAcquirer()

getTtl

long getTtl()

setDurable

void setDurable(boolean durable)

setTtl

void setTtl(long ttl)

setDeliveryCount

void setDeliveryCount(long deliveryCount)

setFirstAcquirer

void setFirstAcquirer(boolean firstAcquirer)

setPriority

void setPriority(short priority)

getMessageId

Object getMessageId()

getGroupSequence

long getGroupSequence()

getReplyToGroupId

String getReplyToGroupId()

getCreationTime

long getCreationTime()

getAddress

String getAddress()

getUserId

byte[] getUserId()

getReplyTo

String getReplyTo()

getGroupId

String getGroupId()

getContentType

String getContentType()

getExpiryTime

long getExpiryTime()

getCorrelationId

Object getCorrelationId()

getContentEncoding

String getContentEncoding()

getSubject

String getSubject()

setGroupSequence

void setGroupSequence(long groupSequence)

setUserId

void setUserId(byte[] userId)

setCreationTime

void setCreationTime(long creationTime)

setSubject

void setSubject(String subject)

setGroupId

void setGroupId(String groupId)

setAddress

void setAddress(String to)

setExpiryTime

void setExpiryTime(long absoluteExpiryTime)

setReplyToGroupId

void setReplyToGroupId(String replyToGroupId)

setContentEncoding

void setContentEncoding(String contentEncoding)

setContentType

void setContentType(String contentType)

setReplyTo

void setReplyTo(String replyTo)

setCorrelationId

void setCorrelationId(Object correlationId)

setMessageId

void setMessageId(Object messageId)

getHeader

Header getHeader()

getDeliveryAnnotations

DeliveryAnnotations getDeliveryAnnotations()

getMessageAnnotations

MessageAnnotations getMessageAnnotations()

getProperties

Properties getProperties()

getApplicationProperties

ApplicationProperties getApplicationProperties()

getBody

Section getBody()

getFooter

Footer getFooter()

setHeader

void setHeader(Header header)

setDeliveryAnnotations

void setDeliveryAnnotations(DeliveryAnnotations deliveryAnnotations)

setMessageAnnotations

void setMessageAnnotations(MessageAnnotations messageAnnotations)

setProperties

void setProperties(Properties properties)

setApplicationProperties

void setApplicationProperties(ApplicationProperties applicationProperties)

setBody

void setBody(Section body)

setFooter

void setFooter(Footer footer)

decode

int decode(byte[] data,
         int offset,
         int length)

TODO describe what happens if the data does not represent a complete message. Currently this appears to leave the message in an unknown state.

encode

int encode(byte[] data,
         int offset,
         int length)

Encodes up to length bytes of the message into the provided byte array, starting at position offset. TODO describe what happens if length is smaller than the encoded form, Currently Proton-J throws an exception. What does Proton-C do?

Returns:

the number of bytes written to the byte array

clear

void clear()

getError

MessageError getError()