org.apache.activemq.artemis.core.persistence.impl.journal

Class LargeServerMessageImpl

java.lang.Object

org.apache.activemq.artemis.api.core.RefCountMessage

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

org.apache.activemq.artemis.core.persistence.impl.journal.LargeServerMessageImpl

All Implemented Interfaces:

ICoreMessage, Message, ReplicatedLargeMessage, LargeServerMessage

public final class LargeServerMessageImpl
extends CoreMessage
implements LargeServerMessage

Field Summary

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

address, BODY_OFFSET, buffer, BUFFER_HEADER_SPACE, durable, endOfBodyPosition, messageID, messageIDPosition, priority, properties, timestamp, type, writableBuffer

Fields inherited from interface org.apache.activemq.artemis.core.server.LargeServerMessage

NO_PENDING_ID

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

BYTES_TYPE, DEFAULT_TYPE, EMBEDDED_TYPE, HDR_ACTUAL_EXPIRY_TIME, HDR_BRIDGE_DUPLICATE_ID, HDR_CONTENT_TYPE, HDR_DUPLICATE_DETECTION_ID, HDR_GROUP_ID, HDR_GROUP_SEQUENCE, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIGINAL_ADDRESS, HDR_ORIGINAL_QUEUE, HDR_PREFIX, HDR_ROUTE_TO_ACK_IDS, HDR_ROUTE_TO_IDS, HDR_ROUTING_TYPE, HDR_SCALEDOWN_TO_IDS, HDR_SCHEDULED_DELIVERY_TIME, HDR_VALIDATED_USER, MAP_TYPE, memoryOffset, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
LargeServerMessageImpl(JournalStorageManager storageManager)

Method Summary

Modifier and Type	Method and Description
void	addBytes(ActiveMQBuffer bytes)
void	addBytes(byte[] bytes)
static Message	checkLargeMessage(Message message, StorageManager storageManager) This will check if a regular message needs to be converted as large message
protected void	closeFile()
Message	copy() It will generate a new instance of the message encode, being a deep copy, new properties, new everything
Message	copy(long newID) It will generate a new instance of the message encode, being a deep copy, new properties, new everything
protected SequentialFile	createFile()
void	decode(ActiveMQBuffer buffer1)
void	decrementDelayDeletionCount()
int	decrementRefCount()
void	deleteFile()
void	encode(ActiveMQBuffer buffer1)
int	getBodyBufferSize() Returns the length in bytes of the body buffer.
LargeBodyEncoder	getBodyEncoder()
int	getEncodeSize() Returns the size of the encoded message.
SequentialFile	getFile()
int	getMemoryEstimate()
long	getPendingRecordID()
long	getPersistentSize() This is the size of the message when persisted on disk which is used for metrics tracking Note that even if the message itself is not persisted on disk (ie non-durable) this value is still used for metrics tracking If a normal message it will be the encoded message size If a large message it will be encoded message size + large message body size
ActiveMQBuffer	getReadOnlyBodyBuffer() Returns a new Buffer slicing the current Body.
void	incrementDelayDeletionCount()
boolean	isLargeMessage()
boolean	isServerMessage() We are really interested if this is a LargeServerMessage.
protected void	openFile()
void	referenceOriginalMessage(Message original, String originalQueue)
void	releaseResources(boolean sync) Close the files if opened
void	setPaged() We have to copy the large message content in case of DLQ and paged messages For that we need to pre-mark the LargeMessage with a flag when it is paged
void	setPendingRecordID(long pendingRecordID)
String	toString()
void	validateFile()

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

checkEncode, clearInternalProperties, containsProperty, containsProperty, copyHeadersAndProperties, decodeHeadersAndProperties, encode, encodeHeadersAndProperties, getAddress, getAddressSimpleString, getAnnotation, getBodyBuffer, getBodyInputStream, getBooleanProperty, getBooleanProperty, getBuffer, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getCorrelationID, getDataBuffer, getDoubleProperty, getDoubleProperty, getDuplicateProperty, getEndOfBodyPosition, getExpiration, getFloatProperty, getFloatProperty, getGroupID, getGroupSequence, getHeadersAndPropertiesEncodeSize, getIntProperty, getIntProperty, getLastValueProperty, getLongProperty, getLongProperty, getMessageID, getObjectProperty, getObjectProperty, getPersister, getPersistSize, getPriority, getProperties, getPropertyNames, getReplyTo, getRoutingType, getScheduledDeliveryTime, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getType, getUserID, getValidatedUserID, initBuffer, isDurable, messageChanged, persist, putBooleanProperty, putBooleanProperty, putByteProperty, putByteProperty, putBytesProperty, putBytesProperty, putCharProperty, putCharProperty, putDoubleProperty, putDoubleProperty, putFloatProperty, putFloatProperty, putIntProperty, putIntProperty, putLongProperty, putLongProperty, putObjectProperty, putObjectProperty, putShortProperty, putShortProperty, putStringProperty, putStringProperty, putStringProperty, receiveBuffer_1X, receiveBuffer, reloadPersistence, removeAnnotation, removeProperty, removeProperty, sendBuffer_1X, sendBuffer, setAddress, setAddress, setBuffer, setCorrelationID, setDurable, setExpiration, setGroupID, setGroupID, setGroupSequence, setLastValueProperty, setMessageID, setPriority, setReplyTo, setRoutingType, setScheduledDeliveryTime, setTimestamp, setType, setUserID, setUserID, setValidatedUserID, toCore, toCore

Methods inherited from class org.apache.activemq.artemis.api.core.RefCountMessage

decrementDurableRefCount, getContext, getRefCount, incrementDurableRefCount, incrementRefCount, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

setDurable, setMessageID

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

copyHeadersAndProperties, getBodyBuffer, getBodyInputStream, getDataBuffer, getEndOfBodyPosition, getHeadersAndPropertiesEncodeSize, getType, receiveBuffer_1X, sendBuffer_1X, setType, toMap

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

acceptsConsumer, clearInternalProperties, containsProperty, containsProperty, decrementDurableRefCount, getAddress, getAddressSimpleString, getAnnotation, getAnnotationString, getBooleanProperty, getBooleanProperty, getBuffer, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getConnectionID, getContext, getCorrelationID, getDoubleProperty, getDoubleProperty, getDuplicateIDBytes, getDuplicateProperty, getExpiration, getExtraBytesProperty, getFloatProperty, getFloatProperty, getGroupID, getGroupSequence, getIntProperty, getIntProperty, getLastValueProperty, getLongProperty, getLongProperty, getMessageID, getObjectProperty, getObjectProperty, getPersister, getPersistSize, getPriority, getPropertyNames, getRefCount, getReplyTo, getRoutingType, getScheduledDeliveryTime, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getUserID, getValidatedUserID, incrementDurableRefCount, incrementRefCount, isDurable, isExpired, messageChanged, persist, putBooleanProperty, putBooleanProperty, putByteProperty, putByteProperty, putBytesProperty, putBytesProperty, putCharProperty, putCharProperty, putDoubleProperty, putDoubleProperty, putExtraBytesProperty, putFloatProperty, putFloatProperty, putIntProperty, putIntProperty, putLongProperty, putLongProperty, putObjectProperty, putObjectProperty, putShortProperty, putShortProperty, putStringProperty, putStringProperty, putStringProperty, receiveBuffer, reencode, rejectConsumer, releaseBuffer, reloadPersistence, removeAnnotation, removeExtraBytesProperty, removeProperty, removeProperty, sendBuffer, setAddress, setAddress, setAnnotation, setBuffer, setConnectionID, setContext, setCorrelationID, setDurable, setExpiration, setGroupID, setGroupID, setGroupSequence, setLastValueProperty, setMessageID, setPriority, setReplyTo, setRoutingType, setScheduledDeliveryTime, setTimestamp, setUserID, setValidatedUserID, toCore, toCore, toPropertyMap

Constructor Detail

LargeServerMessageImpl

public LargeServerMessageImpl(JournalStorageManager storageManager)

Method Detail

checkLargeMessage

public static Message checkLargeMessage(Message message,
                                        StorageManager storageManager)
                                 throws Exception

This will check if a regular message needs to be converted as large message

Throws:

Exception

isServerMessage

public boolean isServerMessage()

Description copied from interface: ICoreMessage

We are really interested if this is a LargeServerMessage.

Specified by:

isServerMessage in interface ICoreMessage

Overrides:

isServerMessage in class CoreMessage

Returns:

getPendingRecordID

public long getPendingRecordID()

Specified by:

getPendingRecordID in interface ReplicatedLargeMessage

setPendingRecordID

public void setPendingRecordID(long pendingRecordID)

Specified by:

setPendingRecordID in interface ReplicatedLargeMessage

Parameters:

pendingRecordID -

setPaged

public void setPaged()

Description copied from interface: LargeServerMessage

We have to copy the large message content in case of DLQ and paged messages For that we need to pre-mark the LargeMessage with a flag when it is paged

Specified by:

setPaged in interface LargeServerMessage

addBytes

public void addBytes(byte[] bytes)
              throws Exception

Specified by:

addBytes in interface ReplicatedLargeMessage

Specified by:

addBytes in interface LargeServerMessage

Throws:

Exception

See Also:

LargeServerMessage.addBytes(byte[])

addBytes

public void addBytes(ActiveMQBuffer bytes)
              throws Exception

Specified by:

addBytes in interface LargeServerMessage

Throws:

Exception

getEncodeSize

public int getEncodeSize()

Description copied from interface: Message

Returns the size of the encoded message.

Specified by:

getEncodeSize in interface Message

Overrides:

getEncodeSize in class CoreMessage

encode

public void encode(ActiveMQBuffer buffer1)

decode

public void decode(ActiveMQBuffer buffer1)

incrementDelayDeletionCount

public void incrementDelayDeletionCount()

Specified by:

incrementDelayDeletionCount in interface LargeServerMessage

decrementDelayDeletionCount

public void decrementDelayDeletionCount()
                                 throws Exception

Specified by:

decrementDelayDeletionCount in interface LargeServerMessage

Throws:

Exception

getBodyEncoder

public LargeBodyEncoder getBodyEncoder()
                                throws ActiveMQException

Specified by:

getBodyEncoder in interface ICoreMessage

Overrides:

getBodyEncoder in class CoreMessage

Throws:

ActiveMQException

decrementRefCount

public int decrementRefCount()
                      throws Exception

Specified by:

decrementRefCount in interface Message

Overrides:

decrementRefCount in class RefCountMessage

Throws:

Exception

getReadOnlyBodyBuffer

public ActiveMQBuffer getReadOnlyBodyBuffer()

Description copied from interface: ICoreMessage

Returns a new Buffer slicing the current Body.

Specified by:

getReadOnlyBodyBuffer in interface ICoreMessage

Overrides:

getReadOnlyBodyBuffer in class CoreMessage

getBodyBufferSize

public int getBodyBufferSize()

Description copied from interface: ICoreMessage

Returns the length in bytes of the body buffer.

Specified by:

getBodyBufferSize in interface ICoreMessage

Overrides:

getBodyBufferSize in class CoreMessage

isLargeMessage

public boolean isLargeMessage()

Specified by:

isLargeMessage in interface Message

Overrides:

isLargeMessage in class CoreMessage

deleteFile

public void deleteFile()
                throws Exception

Specified by:

deleteFile in interface ReplicatedLargeMessage

Specified by:

deleteFile in interface LargeServerMessage

Throws:

Exception

See Also:

LargeServerMessage.deleteFile()

getMemoryEstimate

public int getMemoryEstimate()

Specified by:

getMemoryEstimate in interface Message

Overrides:

getMemoryEstimate in class CoreMessage

releaseResources

public void releaseResources(boolean sync)

Description copied from interface: LargeServerMessage

Close the files if opened

Specified by:

releaseResources in interface ReplicatedLargeMessage

Specified by:

releaseResources in interface LargeServerMessage

See Also:

LargeServerMessage.releaseResources(boolean)

referenceOriginalMessage

public void referenceOriginalMessage(Message original,
                                     String originalQueue)

Specified by:

referenceOriginalMessage in interface Message

copy

public Message copy()

Description copied from interface: Message

It will generate a new instance of the message encode, being a deep copy, new properties, new everything

Specified by:

copy in interface Message

Overrides:

copy in class CoreMessage

copy

public Message copy(long newID)

Description copied from interface: Message

It will generate a new instance of the message encode, being a deep copy, new properties, new everything

Specified by:

copy in interface Message

Overrides:

copy in class CoreMessage

getFile

public SequentialFile getFile()
                       throws ActiveMQException

Specified by:

getFile in interface LargeServerMessage

Returns:

Throws:

ActiveMQException

getPersistentSize

public long getPersistentSize()
                       throws ActiveMQException

Description copied from interface: Message

This is the size of the message when persisted on disk which is used for metrics tracking Note that even if the message itself is not persisted on disk (ie non-durable) this value is still used for metrics tracking If a normal message it will be the encoded message size If a large message it will be encoded message size + large message body size

Specified by:

getPersistentSize in interface Message

Overrides:

getPersistentSize in class CoreMessage

Returns:

Throws:

ActiveMQException

toString

public String toString()

Overrides:

toString in class CoreMessage

validateFile

public void validateFile()
                  throws ActiveMQException

Throws:

ActiveMQException

createFile

protected SequentialFile createFile()

openFile

protected void openFile()
                 throws Exception

Throws:

Exception

closeFile

protected void closeFile()
                  throws Exception

Throws:

Exception