Package org.apache.activemq.artemis.core.paging.impl

Class PagedMessageImpl

java.lang.Object

org.apache.activemq.artemis.core.paging.impl.PagedMessageImpl

All Implemented Interfaces:

EncodingSupport, PagedMessage

public class PagedMessageImpl
extends Object
implements PagedMessage

This class represents a paged message

Constructor Summary

Constructors

Constructor	Description
PagedMessageImpl(int storedSize, StorageManager storageManager)
PagedMessageImpl(Message message, long[] queueIDs)
PagedMessageImpl(Message message, long[] queueIDs, long transactionID)

Method Summary

Modifier and Type	Method	Description
void	decode(ActiveMQBuffer buffer)
void	encode(ActiveMQBuffer buffer)
int	getEncodeSize()
Message	getMessage()
int	getMessageNumber()
long	getPageNumber()
long	getPersistentSize()	This is the size of the message when persisted on disk and is 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
long[]	getQueueIDs()	The queues that were routed during paging
int	getStoredSize()	This returns how much the PagedMessage used, or it's going to use from storage.
long	getTransactionID()
void	initMessage(StorageManager storage)
static boolean	isLargeMessage(ActiveMQBuffer buffer)	This method won't move the ActiveMQBuffer.readerIndex() of buffer.
PagePosition	newPositionObject()
PagedMessageImpl	setMessageNumber(int messageNr)
PagedMessageImpl	setPageNumber(long pageNr)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PagedMessageImpl

public PagedMessageImpl(Message message,
                        long[] queueIDs,
                        long transactionID)

PagedMessageImpl

public PagedMessageImpl(Message message,
                        long[] queueIDs)

PagedMessageImpl

public PagedMessageImpl(int storedSize,
                        StorageManager storageManager)

Method Detail

getPageNumber

public long getPageNumber()

Specified by:

getPageNumber in interface PagedMessage

setPageNumber

public PagedMessageImpl setPageNumber(long pageNr)

Specified by:

setPageNumber in interface PagedMessage

getMessageNumber

public int getMessageNumber()

Specified by:

getMessageNumber in interface PagedMessage

setMessageNumber

public PagedMessageImpl setMessageNumber(int messageNr)

Specified by:

setMessageNumber in interface PagedMessage

getStoredSize

public int getStoredSize()

Description copied from interface: PagedMessage

This returns how much the PagedMessage used, or it's going to use from storage. We can't calculate the encodeSize as some persisters don't guarantee to re-store the data at the same amount of bytes it used. In some cases it may need to add headers in AMQP or extra data that may affect the outcome of getEncodeSize()

Specified by:

getStoredSize in interface PagedMessage

getMessage

public Message getMessage()

Specified by:

getMessage in interface PagedMessage

newPositionObject

public PagePosition newPositionObject()

Specified by:

newPositionObject in interface PagedMessage

initMessage

public void initMessage(StorageManager storage)

Specified by:

initMessage in interface PagedMessage

getTransactionID

public long getTransactionID()

Specified by:

getTransactionID in interface PagedMessage

getQueueIDs

public long[] getQueueIDs()

Description copied from interface: PagedMessage

The queues that were routed during paging

Specified by:

getQueueIDs in interface PagedMessage

isLargeMessage

public static boolean isLargeMessage(ActiveMQBuffer buffer)

This method won't move the ActiveMQBuffer.readerIndex() of buffer.

decode

public void decode(ActiveMQBuffer buffer)

Specified by:

decode in interface EncodingSupport

encode

public void encode(ActiveMQBuffer buffer)

Specified by:

encode in interface EncodingSupport

getEncodeSize

public int getEncodeSize()

Specified by:

getEncodeSize in interface EncodingSupport

toString

public String toString()

Overrides:

toString in class Object

getPersistentSize

public long getPersistentSize()
                       throws ActiveMQException

Description copied from interface: PagedMessage

This is the size of the message when persisted on disk and is 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 PagedMessage

Returns:

Throws:

ActiveMQException