public interface Message
MessageFactory
implementation.Modifier and Type | Field and Description |
---|---|
static short |
DEFAULT_PRIORITY |
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() |
MessageFormat |
getMessageFormat() |
Object |
getMessageId() |
short |
getPriority() |
Properties |
getProperties() |
String |
getReplyTo() |
String |
getReplyToGroupId() |
String |
getSubject() |
long |
getTtl() |
byte[] |
getUserId() |
boolean |
isDurable() |
boolean |
isFirstAcquirer() |
void |
load(Object data)
Loads message body from the
data . |
Object |
parseAMQPFormat(String value) |
Object |
save()
Return the message body in a format determined by
getMessageFormat() . |
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 |
setMessageFormat(MessageFormat format) |
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) |
String |
toAMQPFormat(Object value) |
static final short DEFAULT_PRIORITY
boolean isDurable()
long getDeliveryCount()
short getPriority()
boolean isFirstAcquirer()
long getTtl()
void setDurable(boolean durable)
void setTtl(long ttl)
void setDeliveryCount(long deliveryCount)
void setFirstAcquirer(boolean firstAcquirer)
void setPriority(short priority)
Object getMessageId()
long getGroupSequence()
String getReplyToGroupId()
long getCreationTime()
String getAddress()
byte[] getUserId()
String getReplyTo()
String getGroupId()
String getContentType()
long getExpiryTime()
Object getCorrelationId()
String getContentEncoding()
String getSubject()
void setGroupSequence(long groupSequence)
void setUserId(byte[] userId)
void setCreationTime(long creationTime)
void setSubject(String subject)
void setGroupId(String groupId)
void setAddress(String to)
void setExpiryTime(long absoluteExpiryTime)
void setReplyToGroupId(String replyToGroupId)
void setContentEncoding(String contentEncoding)
void setContentType(String contentType)
void setReplyTo(String replyTo)
void setCorrelationId(Object correlationId)
void setMessageId(Object messageId)
Header getHeader()
DeliveryAnnotations getDeliveryAnnotations()
MessageAnnotations getMessageAnnotations()
Properties getProperties()
ApplicationProperties getApplicationProperties()
Section getBody()
Footer getFooter()
void setHeader(Header header)
void setDeliveryAnnotations(DeliveryAnnotations deliveryAnnotations)
void setMessageAnnotations(MessageAnnotations messageAnnotations)
void setProperties(Properties properties)
void setApplicationProperties(ApplicationProperties applicationProperties)
void setBody(Section body)
void setFooter(Footer footer)
int decode(byte[] data, int offset, int length)
int encode(byte[] data, int offset, int length)
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?void load(Object data)
data
.
TODO describe how the object is interpreted according to the MessageFormat.setMessageFormat(MessageFormat)
Object save()
getMessageFormat()
.
TODO describe the formatting processvoid setMessageFormat(MessageFormat format)
MessageFormat getMessageFormat()
void clear()
MessageError getError()
Copyright © 2014 The Apache Software Foundation. All rights reserved.