org.apache.qpid.proton.message.impl

Class MessageImpl

java.lang.Object

org.apache.qpid.proton.message.impl.MessageImpl

All Implemented Interfaces:

Message, ProtonJMessage

public class MessageImpl
extends java.lang.Object
implements ProtonJMessage

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.proton.message.Message

Message.Factory

Field Summary

Fields inherited from interface org.apache.qpid.proton.message.Message

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
MessageImpl() Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a MessageFactory instead
MessageImpl(Header header, DeliveryAnnotations deliveryAnnotations, MessageAnnotations messageAnnotations, Properties properties, ApplicationProperties applicationProperties, Section body, Footer footer) Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a MessageFactory instead

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.
void	decode(java.nio.ByteBuffer buffer)
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.
int	encode(WritableBuffer buffer)
int	encode2(byte[] data, int offset, int length)
java.lang.String	getAddress()
ApplicationProperties	getApplicationProperties()
Section	getBody()
java.lang.String	getContentEncoding()
java.lang.String	getContentType()
java.lang.Object	getCorrelationId()
long	getCreationTime()
DeliveryAnnotations	getDeliveryAnnotations()
long	getDeliveryCount()
MessageError	getError()
long	getExpiryTime()
Footer	getFooter()
java.lang.String	getGroupId()
long	getGroupSequence()
Header	getHeader()
MessageAnnotations	getMessageAnnotations()
MessageFormat	getMessageFormat()
java.lang.Object	getMessageId()
short	getPriority()
Properties	getProperties()
java.lang.String	getReplyTo()
java.lang.String	getReplyToGroupId()
java.lang.String	getSubject()
long	getTtl()
byte[]	getUserId()
boolean	isDurable()
boolean	isFirstAcquirer()
void	load(java.lang.Object data) Loads message body from the data.
java.lang.Object	parseAMQPFormat(java.lang.String value)
java.lang.Object	save() Return the message body in a format determined by Message.getMessageFormat().
void	setAddress(java.lang.String to)
void	setApplicationProperties(ApplicationProperties applicationProperties)
void	setBody(Section body)
void	setContentEncoding(java.lang.String contentEncoding)
void	setContentType(java.lang.String contentType)
void	setCorrelationId(java.lang.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(java.lang.String groupId)
void	setGroupSequence(long groupSequence)
void	setHeader(Header header)
void	setMessageAnnotations(MessageAnnotations messageAnnotations)
void	setMessageFormat(MessageFormat format)
void	setMessageId(java.lang.Object messageId)
void	setPriority(short priority)
void	setProperties(Properties properties)
void	setReplyTo(java.lang.String replyTo)
void	setReplyToGroupId(java.lang.String replyToGroupId)
void	setSubject(java.lang.String subject)
void	setTtl(long ttl)
void	setUserId(byte[] userId)
java.lang.String	toAMQPFormat(java.lang.Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageImpl

@Deprecated
public MessageImpl()

Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a MessageFactory instead

MessageImpl

@Deprecated
public MessageImpl(Header header,
                      DeliveryAnnotations deliveryAnnotations,
                      MessageAnnotations messageAnnotations,
                      Properties properties,
                      ApplicationProperties applicationProperties,
                      Section body,
                      Footer footer)

Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a MessageFactory instead

Method Detail

isDurable

public boolean isDurable()

Specified by:

isDurable in interface Message

getDeliveryCount

public long getDeliveryCount()

Specified by:

getDeliveryCount in interface Message

getPriority

public short getPriority()

Specified by:

getPriority in interface Message

isFirstAcquirer

public boolean isFirstAcquirer()

Specified by:

isFirstAcquirer in interface Message

getTtl

public long getTtl()

Specified by:

getTtl in interface Message

setDurable

public void setDurable(boolean durable)

Specified by:

setDurable in interface Message

setTtl

public void setTtl(long ttl)

Specified by:

setTtl in interface Message

setDeliveryCount

public void setDeliveryCount(long deliveryCount)

Specified by:

setDeliveryCount in interface Message

setFirstAcquirer

public void setFirstAcquirer(boolean firstAcquirer)

Specified by:

setFirstAcquirer in interface Message

setPriority

public void setPriority(short priority)

Specified by:

setPriority in interface Message

getMessageId

public java.lang.Object getMessageId()

Specified by:

getMessageId in interface Message

getGroupSequence

public long getGroupSequence()

Specified by:

getGroupSequence in interface Message

getReplyToGroupId

public java.lang.String getReplyToGroupId()

Specified by:

getReplyToGroupId in interface Message

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface Message

getAddress

public java.lang.String getAddress()

Specified by:

getAddress in interface Message

getUserId

public byte[] getUserId()

Specified by:

getUserId in interface Message

getReplyTo

public java.lang.String getReplyTo()

Specified by:

getReplyTo in interface Message

getGroupId

public java.lang.String getGroupId()

Specified by:

getGroupId in interface Message

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface Message

getExpiryTime

public long getExpiryTime()

Specified by:

getExpiryTime in interface Message

getCorrelationId

public java.lang.Object getCorrelationId()

Specified by:

getCorrelationId in interface Message

getContentEncoding

public java.lang.String getContentEncoding()

Specified by:

getContentEncoding in interface Message

getSubject

public java.lang.String getSubject()

Specified by:

getSubject in interface Message

setGroupSequence

public void setGroupSequence(long groupSequence)

Specified by:

setGroupSequence in interface Message

setUserId

public void setUserId(byte[] userId)

Specified by:

setUserId in interface Message

setCreationTime

public void setCreationTime(long creationTime)

Specified by:

setCreationTime in interface Message

setSubject

public void setSubject(java.lang.String subject)

Specified by:

setSubject in interface Message

setGroupId

public void setGroupId(java.lang.String groupId)

Specified by:

setGroupId in interface Message

setAddress

public void setAddress(java.lang.String to)

Specified by:

setAddress in interface Message

setExpiryTime

public void setExpiryTime(long absoluteExpiryTime)

Specified by:

setExpiryTime in interface Message

setReplyToGroupId

public void setReplyToGroupId(java.lang.String replyToGroupId)

Specified by:

setReplyToGroupId in interface Message

setContentEncoding

public void setContentEncoding(java.lang.String contentEncoding)

Specified by:

setContentEncoding in interface Message

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface Message

setReplyTo

public void setReplyTo(java.lang.String replyTo)

Specified by:

setReplyTo in interface Message

setCorrelationId

public void setCorrelationId(java.lang.Object correlationId)

Specified by:

setCorrelationId in interface Message

setMessageId

public void setMessageId(java.lang.Object messageId)

Specified by:

setMessageId in interface Message

getHeader

public Header getHeader()

Specified by:

getHeader in interface Message

getDeliveryAnnotations

public DeliveryAnnotations getDeliveryAnnotations()

Specified by:

getDeliveryAnnotations in interface Message

getMessageAnnotations

public MessageAnnotations getMessageAnnotations()

Specified by:

getMessageAnnotations in interface Message

getProperties

public Properties getProperties()

Specified by:

getProperties in interface Message

getApplicationProperties

public ApplicationProperties getApplicationProperties()

Specified by:

getApplicationProperties in interface Message

getBody

public Section getBody()

Specified by:

getBody in interface Message

getFooter

public Footer getFooter()

Specified by:

getFooter in interface Message

setHeader

public void setHeader(Header header)

Specified by:

setHeader in interface Message

setDeliveryAnnotations

public void setDeliveryAnnotations(DeliveryAnnotations deliveryAnnotations)

Specified by:

setDeliveryAnnotations in interface Message

setMessageAnnotations

public void setMessageAnnotations(MessageAnnotations messageAnnotations)

Specified by:

setMessageAnnotations in interface Message

setProperties

public void setProperties(Properties properties)

Specified by:

setProperties in interface Message

setApplicationProperties

public void setApplicationProperties(ApplicationProperties applicationProperties)

Specified by:

setApplicationProperties in interface Message

setBody

public void setBody(Section body)

Specified by:

setBody in interface Message

setFooter

public void setFooter(Footer footer)

Specified by:

setFooter in interface Message

decode

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

Description copied from interface: Message

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

Specified by:

decode in interface Message

decode

public void decode(java.nio.ByteBuffer buffer)

encode

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

Description copied from interface: Message

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?

Specified by:

encode in interface Message

Returns:

the number of bytes written to the byte array

encode2

public int encode2(byte[] data,
          int offset,
          int length)

Specified by:

encode2 in interface ProtonJMessage

encode

public int encode(WritableBuffer buffer)

Specified by:

encode in interface ProtonJMessage

load

public void load(java.lang.Object data)

Description copied from interface: Message

Loads message body from the data. TODO describe how the object is interpreted according to the MessageFormat.

Specified by:

load in interface Message

See Also:

Message.setMessageFormat(MessageFormat)

save

public java.lang.Object save()

Description copied from interface: Message

Return the message body in a format determined by Message.getMessageFormat(). TODO describe the formatting process

Specified by:

save in interface Message

toAMQPFormat

public java.lang.String toAMQPFormat(java.lang.Object value)

Specified by:

toAMQPFormat in interface Message

parseAMQPFormat

public java.lang.Object parseAMQPFormat(java.lang.String value)

Specified by:

parseAMQPFormat in interface Message

setMessageFormat

public void setMessageFormat(MessageFormat format)

Specified by:

setMessageFormat in interface Message

getMessageFormat

public MessageFormat getMessageFormat()

Specified by:

getMessageFormat in interface Message

clear

public void clear()

Specified by:

clear in interface Message

getError

public MessageError getError()

Specified by:

getError in interface Message