org.apache.activemq.artemis.core.client.impl

Class ClientMessageImpl

java.lang.Object

org.apache.activemq.artemis.core.message.impl.MessageImpl

org.apache.activemq.artemis.core.client.impl.ClientMessageImpl

All Implemented Interfaces:

ClientMessage, Message, ClientMessageInternal, MessageInternal

Direct Known Subclasses:

ClientLargeMessageImpl

public class ClientMessageImpl
extends MessageImpl
implements ClientMessageInternal

A ClientMessageImpl

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleString	REPLYTO_HEADER_NAME

Fields inherited from class org.apache.activemq.artemis.core.message.impl.MessageImpl

address, BODY_OFFSET, bodyBuffer, buffer, BUFFER_HEADER_SPACE, bufferValid, durable, HDR_BRIDGE_DUPLICATE_ID, HDR_ROUTE_TO_ACK_IDS, HDR_ROUTE_TO_IDS, HDR_SCALEDOWN_TO_IDS, messageID, priority, properties, timestamp, type

Fields inherited from interface org.apache.activemq.artemis.api.core.Message

BYTES_TYPE, DEFAULT_TYPE, HDR_ACTUAL_EXPIRY_TIME, HDR_CONTENT_TYPE, HDR_DUPLICATE_DETECTION_ID, HDR_GROUP_ID, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIGINAL_ADDRESS, HDR_ORIGINAL_QUEUE, HDR_SCHEDULED_DELIVERY_TIME, HDR_VALIDATED_USER, MAP_TYPE, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
ClientMessageImpl()
ClientMessageImpl(byte type, boolean durable, long expiration, long timestamp, byte priority, int initialMessageBufferSize)

Method Summary

Modifier and Type	Method and Description
ClientMessageImpl	acknowledge() Acknowledges reception of this message.
void	discardBody() Discard unused packets (used on large-message)
BodyEncoder	getBodyEncoder()
InputStream	getBodyInputStream()
int	getBodySize() Returns the size (in bytes) of this message's body
int	getDeliveryCount() Returns the number of times this message was delivered.
int	getFlowControlSize() Size used for FlowControl
ClientMessageImpl	individualAcknowledge() Acknowledges reception of a single message.
boolean	isCompressed()
boolean	isLargeMessage() Returns whether this message is a large message or a regular message.
boolean	isServerMessage()
void	onReceipt(ClientConsumerInternal consumer)
ClientMessageImpl	putBooleanProperty(SimpleString key, boolean value) Puts a boolean property in this message.
ClientMessageImpl	putBooleanProperty(String key, boolean value) Overridden from Message to enable fluent API
ClientMessageImpl	putByteProperty(SimpleString key, byte value) Puts a byte property in this message.
ClientMessageImpl	putByteProperty(String key, byte value) Overridden from Message to enable fluent API
ClientMessageImpl	putBytesProperty(SimpleString key, byte[] value) Puts a byte[] property in this message.
ClientMessageImpl	putBytesProperty(String key, byte[] value) Overridden from Message to enable fluent API
ClientMessageImpl	putCharProperty(SimpleString key, char value) Puts a char property in this message.
ClientMessageImpl	putCharProperty(String key, char value) Overridden from Message to enable fluent API
ClientMessageImpl	putDoubleProperty(SimpleString key, double value) Puts a double property in this message.
ClientMessageImpl	putDoubleProperty(String key, double value) Overridden from Message to enable fluent API
ClientMessageImpl	putFloatProperty(SimpleString key, float value) Puts a float property in this message.
ClientMessageImpl	putFloatProperty(String key, float value) Overridden from Message to enable fluent API
ClientMessageImpl	putIntProperty(SimpleString key, int value) Puts an int property in this message.
ClientMessageImpl	putIntProperty(String key, int value) Overridden from Message to enable fluent API
ClientMessageImpl	putLongProperty(SimpleString key, long value) Puts a long property in this message.
ClientMessageImpl	putLongProperty(String key, long value) Overridden from Message to enable fluent API
ClientMessageImpl	putObjectProperty(SimpleString key, Object value) Puts an Object property in this message.
ClientMessageImpl	putObjectProperty(String key, Object value)
ClientMessageImpl	putShortProperty(SimpleString key, short value) Puts a short property in this message.
ClientMessageImpl	putShortProperty(String key, short value) Overridden from Message to enable fluent API
ClientMessageImpl	putStringProperty(SimpleString key, SimpleString value) Puts a SimpleString property in this message.
ClientMessageImpl	putStringProperty(String key, String value) Puts a String property in this message.
void	saveToOutputStream(OutputStream out) Saves the content of the message to the OutputStream.
ClientMessageImpl	setBodyInputStream(InputStream bodyInputStream) Sets the body's IntputStream.
ClientMessageImpl	setDeliveryCount(int deliveryCount) Sets the delivery count for this message.
void	setFlowControlSize(int flowControlSize) Size used for FlowControl
ClientMessageImpl	setOutputStream(OutputStream out) Sets the OutputStream that will receive the content of a message received in a non blocking way.
String	toString()
boolean	waitOutputStreamCompletion(long timeMilliseconds) Wait the outputStream completion of the message.
ClientMessageImpl	writeBodyBufferBytes(byte[] bytes) Writes the input byte array to the message body ActiveMQBuffer
ClientMessageImpl	writeBodyBufferString(String string) Writes the input String to the message body ActiveMQBuffer

Methods inherited from class org.apache.activemq.artemis.core.message.impl.MessageImpl

bodyChanged, bodyToString, checkCompletion, containsProperty, containsProperty, copyHeadersAndProperties, createBody, decode, decodeFromBuffer, decodeHeadersAndProperties, encode, encodeHeadersAndProperties, equals, getAddress, getBodyBuffer, getBodyBufferDuplicate, getBooleanProperty, getBooleanProperty, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getDoubleProperty, getDoubleProperty, getEncodedBuffer, getEncodeSize, getEndOfBodyPosition, getEndOfMessagePosition, getExpiration, getFloatProperty, getFloatProperty, getHeadersAndPropertiesEncodeSize, getIntProperty, getIntProperty, getLongProperty, getLongProperty, getMessageID, getObjectProperty, getObjectProperty, getPriority, getProperties, getPropertyNames, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getType, getTypedProperties, getUserID, getWholeBuffer, hashCode, isDurable, isExpired, putTypedProperties, removeProperty, removeProperty, setAddress, setAddressTransient, setDurable, setExpiration, setPriority, setTimestamp, setType, setUserID, toMap, toPropertyMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.activemq.artemis.core.client.impl.ClientMessageInternal

getProperties, setAddressTransient

Methods inherited from interface org.apache.activemq.artemis.api.core.client.ClientMessage

checkCompletion

Methods inherited from interface org.apache.activemq.artemis.api.core.Message

containsProperty, containsProperty, getAddress, getBodyBuffer, getBodyBufferDuplicate, getBooleanProperty, getBooleanProperty, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getDoubleProperty, getDoubleProperty, getEncodeSize, getExpiration, getFloatProperty, getFloatProperty, getIntProperty, getIntProperty, getLongProperty, getLongProperty, getMessageID, getObjectProperty, getObjectProperty, getPriority, getPropertyNames, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getType, getUserID, isDurable, isExpired, removeProperty, removeProperty, setAddress, setDurable, setExpiration, setPriority, setTimestamp, setUserID, toMap, toPropertyMap

Field Detail

REPLYTO_HEADER_NAME

public static final SimpleString REPLYTO_HEADER_NAME

Constructor Detail

ClientMessageImpl

public ClientMessageImpl()

ClientMessageImpl

public ClientMessageImpl(byte type,
                         boolean durable,
                         long expiration,
                         long timestamp,
                         byte priority,
                         int initialMessageBufferSize)

Method Detail

isServerMessage

public boolean isServerMessage()

Specified by:

isServerMessage in interface MessageInternal

onReceipt

public void onReceipt(ClientConsumerInternal consumer)

Specified by:

onReceipt in interface ClientMessageInternal

setDeliveryCount

public ClientMessageImpl setDeliveryCount(int deliveryCount)

Description copied from interface: ClientMessage

Sets the delivery count for this message.

This method is not meant to be called by ActiveMQ Artemis clients.

Specified by:

setDeliveryCount in interface ClientMessage

Parameters:

deliveryCount - message delivery count

Returns:

this ClientMessage

getDeliveryCount

public int getDeliveryCount()

Description copied from interface: ClientMessage

Returns the number of times this message was delivered.

Specified by:

getDeliveryCount in interface ClientMessage

acknowledge

public ClientMessageImpl acknowledge()
                              throws ActiveMQException

Description copied from interface: ClientMessage

Acknowledges reception of this message.

If the session responsible to acknowledge this message has autoCommitAcks set to true, the transaction will automatically commit the current transaction. Otherwise, this acknowledgement will not be committed until the client commits the session transaction.

Specified by:

acknowledge in interface ClientMessage

Throws:

ActiveMQException - if an error occurred while acknowledging the message.

See Also:

ClientSession.isAutoCommitAcks()

individualAcknowledge

public ClientMessageImpl individualAcknowledge()
                                        throws ActiveMQException

Description copied from interface: ClientMessage

Acknowledges reception of a single message.

If the session responsible to acknowledge this message has autoCommitAcks set to true, the transaction will automatically commit the current transaction. Otherwise, this acknowledgement will not be committed until the client commits the session transaction.

Specified by:

individualAcknowledge in interface ClientMessage

Throws:

ActiveMQException - if an error occurred while acknowledging the message.

See Also:

ClientSession.isAutoCommitAcks()

getFlowControlSize

public int getFlowControlSize()

Description copied from interface: ClientMessageInternal

Size used for FlowControl

Specified by:

getFlowControlSize in interface ClientMessageInternal

setFlowControlSize

public void setFlowControlSize(int flowControlSize)

Description copied from interface: ClientMessageInternal

Size used for FlowControl

Specified by:

setFlowControlSize in interface ClientMessageInternal

isLargeMessage

public boolean isLargeMessage()

Description copied from interface: Message

Returns whether this message is a large message or a regular message.

Specified by:

isLargeMessage in interface Message

Returns:

the largeMessage

isCompressed

public boolean isCompressed()

Specified by:

isCompressed in interface ClientMessageInternal

getBodySize

public int getBodySize()

Description copied from interface: ClientMessage

Returns the size (in bytes) of this message's body

Specified by:

getBodySize in interface ClientMessage

toString

public String toString()

Overrides:

toString in class Object

saveToOutputStream

public void saveToOutputStream(OutputStream out)
                        throws ActiveMQException

Description copied from interface: ClientMessage

Saves the content of the message to the OutputStream. It will block until the entire content is transferred to the OutputStream.

Specified by:

saveToOutputStream in interface ClientMessage

Throws:

ActiveMQException

setOutputStream

public ClientMessageImpl setOutputStream(OutputStream out)
                                  throws ActiveMQException

Description copied from interface: ClientMessage

Sets the OutputStream that will receive the content of a message received in a non blocking way.
This method is used when consuming large messages

Specified by:

setOutputStream in interface ClientMessage

Returns:

this ClientMessage

Throws:

ActiveMQException

waitOutputStreamCompletion

public boolean waitOutputStreamCompletion(long timeMilliseconds)
                                   throws ActiveMQException

Description copied from interface: ClientMessage

Wait the outputStream completion of the message. This method is used when consuming large messages

Specified by:

waitOutputStreamCompletion in interface ClientMessage

Parameters:

timeMilliseconds - - 0 means wait forever

Returns:

true if it reached the end

Throws:

ActiveMQException

discardBody

public void discardBody()

Description copied from interface: ClientMessageInternal

Discard unused packets (used on large-message)

Specified by:

discardBody in interface ClientMessageInternal

getBodyInputStream

public InputStream getBodyInputStream()

Specified by:

getBodyInputStream in interface MessageInternal

Returns:

the bodyInputStream

setBodyInputStream

public ClientMessageImpl setBodyInputStream(InputStream bodyInputStream)

Description copied from interface: ClientMessage

Sets the body's IntputStream.
This method is used when sending large messages

Specified by:

setBodyInputStream in interface ClientMessage

Parameters:

bodyInputStream - the bodyInputStream to set

Returns:

this ClientMessage

getBodyEncoder

public BodyEncoder getBodyEncoder()
                           throws ActiveMQException

Specified by:

getBodyEncoder in interface MessageInternal

Overrides:

getBodyEncoder in class MessageImpl

Throws:

ActiveMQException

putBooleanProperty

public ClientMessageImpl putBooleanProperty(SimpleString key,
                                            boolean value)

Description copied from interface: Message

Puts a boolean property in this message.

Specified by:

putBooleanProperty in interface ClientMessage

Specified by:

putBooleanProperty in interface Message

Overrides:

putBooleanProperty in class MessageImpl

Parameters:

key - property name

value - property value

putByteProperty

public ClientMessageImpl putByteProperty(SimpleString key,
                                         byte value)

Description copied from interface: Message

Puts a byte property in this message.

Specified by:

putByteProperty in interface ClientMessage

Specified by:

putByteProperty in interface Message

Overrides:

putByteProperty in class MessageImpl

Parameters:

key - property name

value - property value

putBytesProperty

public ClientMessageImpl putBytesProperty(SimpleString key,
                                          byte[] value)

Description copied from interface: Message

Puts a byte[] property in this message.

Specified by:

putBytesProperty in interface ClientMessage

Specified by:

putBytesProperty in interface Message

Overrides:

putBytesProperty in class MessageImpl

Parameters:

key - property name

value - property value

putCharProperty

public ClientMessageImpl putCharProperty(SimpleString key,
                                         char value)

Description copied from interface: Message

Puts a char property in this message.

Specified by:

putCharProperty in interface ClientMessage

Specified by:

putCharProperty in interface Message

Overrides:

putCharProperty in class MessageImpl

Parameters:

key - property name

value - property value

putCharProperty

public ClientMessageImpl putCharProperty(String key,
                                         char value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putCharProperty in interface ClientMessage

Specified by:

putCharProperty in interface Message

Overrides:

putCharProperty in class MessageImpl

See Also:

Message.putCharProperty(SimpleString, char)

putShortProperty

public ClientMessageImpl putShortProperty(SimpleString key,
                                          short value)

Description copied from interface: Message

Puts a short property in this message.

Specified by:

putShortProperty in interface ClientMessage

Specified by:

putShortProperty in interface Message

Overrides:

putShortProperty in class MessageImpl

Parameters:

key - property name

value - property value

putIntProperty

public ClientMessageImpl putIntProperty(SimpleString key,
                                        int value)

Description copied from interface: Message

Puts an int property in this message.

Specified by:

putIntProperty in interface ClientMessage

Specified by:

putIntProperty in interface Message

Overrides:

putIntProperty in class MessageImpl

Parameters:

key - property name

value - property value

putLongProperty

public ClientMessageImpl putLongProperty(SimpleString key,
                                         long value)

Description copied from interface: Message

Puts a long property in this message.

Specified by:

putLongProperty in interface ClientMessage

Specified by:

putLongProperty in interface Message

Overrides:

putLongProperty in class MessageImpl

Parameters:

key - property name

value - property value

putFloatProperty

public ClientMessageImpl putFloatProperty(SimpleString key,
                                          float value)

Description copied from interface: Message

Puts a float property in this message.

Specified by:

putFloatProperty in interface ClientMessage

Specified by:

putFloatProperty in interface Message

Overrides:

putFloatProperty in class MessageImpl

Parameters:

key - property name

value - property value

putDoubleProperty

public ClientMessageImpl putDoubleProperty(SimpleString key,
                                           double value)

Description copied from interface: Message

Puts a double property in this message.

Specified by:

putDoubleProperty in interface ClientMessage

Specified by:

putDoubleProperty in interface Message

Overrides:

putDoubleProperty in class MessageImpl

Parameters:

key - property name

value - property value

putStringProperty

public ClientMessageImpl putStringProperty(SimpleString key,
                                           SimpleString value)

Description copied from interface: Message

Puts a SimpleString property in this message.

Specified by:

putStringProperty in interface ClientMessage

Specified by:

putStringProperty in interface Message

Overrides:

putStringProperty in class MessageImpl

Parameters:

key - property name

value - property value

putObjectProperty

public ClientMessageImpl putObjectProperty(SimpleString key,
                                           Object value)
                                    throws ActiveMQPropertyConversionException

Description copied from interface: Message

Puts an Object property in this message.
Accepted types are:

• Boolean
• Byte
• Short
• Character
• Integer
• Long
• Float
• Double
• String
• SimpleString

Using any other type will throw a PropertyConversionException.

Specified by:

putObjectProperty in interface Message

Overrides:

putObjectProperty in class MessageImpl

Parameters:

key - property name

value - property value

Throws:

ActiveMQPropertyConversionException - if the value is not one of the accepted property types.

putObjectProperty

public ClientMessageImpl putObjectProperty(String key,
                                           Object value)
                                    throws ActiveMQPropertyConversionException

Specified by:

putObjectProperty in interface Message

Overrides:

putObjectProperty in class MessageImpl

Throws:

ActiveMQPropertyConversionException

See Also:

Message.putObjectProperty(SimpleString, Object)

putBooleanProperty

public ClientMessageImpl putBooleanProperty(String key,
                                            boolean value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putBooleanProperty in interface ClientMessage

Specified by:

putBooleanProperty in interface Message

Overrides:

putBooleanProperty in class MessageImpl

See Also:

Message.putBooleanProperty(SimpleString, boolean)

putByteProperty

public ClientMessageImpl putByteProperty(String key,
                                         byte value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putByteProperty in interface ClientMessage

Specified by:

putByteProperty in interface Message

Overrides:

putByteProperty in class MessageImpl

See Also:

Message.putByteProperty(SimpleString, byte)

putBytesProperty

public ClientMessageImpl putBytesProperty(String key,
                                          byte[] value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putBytesProperty in interface ClientMessage

Specified by:

putBytesProperty in interface Message

Overrides:

putBytesProperty in class MessageImpl

See Also:

Message.putBytesProperty(SimpleString, byte[])

putShortProperty

public ClientMessageImpl putShortProperty(String key,
                                          short value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putShortProperty in interface ClientMessage

Specified by:

putShortProperty in interface Message

Overrides:

putShortProperty in class MessageImpl

See Also:

Message.putShortProperty(SimpleString, short)

putIntProperty

public ClientMessageImpl putIntProperty(String key,
                                        int value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putIntProperty in interface ClientMessage

Specified by:

putIntProperty in interface Message

Overrides:

putIntProperty in class MessageImpl

See Also:

Message.putIntProperty(SimpleString, int)

putLongProperty

public ClientMessageImpl putLongProperty(String key,
                                         long value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putLongProperty in interface ClientMessage

Specified by:

putLongProperty in interface Message

Overrides:

putLongProperty in class MessageImpl

See Also:

Message.putLongProperty(SimpleString, long)

putFloatProperty

public ClientMessageImpl putFloatProperty(String key,
                                          float value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putFloatProperty in interface ClientMessage

Specified by:

putFloatProperty in interface Message

Overrides:

putFloatProperty in class MessageImpl

See Also:

Message.putFloatProperty(SimpleString, float)

putDoubleProperty

public ClientMessageImpl putDoubleProperty(String key,
                                           double value)

Description copied from interface: ClientMessage

Overridden from Message to enable fluent API

Specified by:

putDoubleProperty in interface ClientMessage

Specified by:

putDoubleProperty in interface Message

Overrides:

putDoubleProperty in class MessageImpl

See Also:

Message.putDoubleProperty(SimpleString, double)

putStringProperty

public ClientMessageImpl putStringProperty(String key,
                                           String value)

Description copied from interface: Message

Puts a String property in this message.

Specified by:

putStringProperty in interface ClientMessage

Specified by:

putStringProperty in interface Message

Overrides:

putStringProperty in class MessageImpl

Parameters:

key - property name

value - property value

writeBodyBufferBytes

public ClientMessageImpl writeBodyBufferBytes(byte[] bytes)

Description copied from interface: Message

Writes the input byte array to the message body ActiveMQBuffer

Specified by:

writeBodyBufferBytes in interface ClientMessage

Specified by:

writeBodyBufferBytes in interface Message

Overrides:

writeBodyBufferBytes in class MessageImpl

writeBodyBufferString

public ClientMessageImpl writeBodyBufferString(String string)

Description copied from interface: Message

Writes the input String to the message body ActiveMQBuffer

Specified by:

writeBodyBufferString in interface ClientMessage

Specified by:

writeBodyBufferString in interface Message

Overrides:

writeBodyBufferString in class MessageImpl