org.apache.activemq.artemis.protocol.amqp.broker

Class AMQPLargeMessage

java.lang.Object

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

org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage

org.apache.activemq.artemis.protocol.amqp.broker.AMQPLargeMessage

All Implemented Interfaces:

Message, org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage, LargeServerMessage

public class AMQPLargeMessage
extends AMQPMessage
implements LargeServerMessage

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage

AMQPMessage.MessageDataScanningStatus

Field Summary

Fields inherited from class org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage

address, ADDRESS_PROPERTY, applicationProperties, applicationPropertiesPosition, connectionID, coreMessageObjectPools, DEFAULT_MESSAGE_FORMAT, DEFAULT_MESSAGE_PRIORITY, deliveryAnnotations, deliveryAnnotationsForSendBuffer, deliveryAnnotationsPosition, encodedDeliveryAnnotationsSize, encodedHeaderSize, expiration, expirationReload, extraProperties, header, headerPosition, logger, MAX_MESSAGE_PRIORITY, memoryEstimate, messageAnnotations, messageAnnotationsPosition, messageDataScanned, messageFormat, messageID, modified, properties, propertiesPosition, rejectedConsumers, remainingBodyPosition, scheduledTime, VALUE_NOT_PRESENT

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_INGRESS_TIMESTAMP, 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, INTERNAL_PROPERTY_NAMES_PREDICATE, LARGE_EMBEDDED_TYPE, MAP_TYPE, memoryOffset, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
AMQPLargeMessage(long id, long messageFormat, TypedProperties extraProperties, CoreMessageObjectPools coreMessageObjectPools, StorageManager storageManager)
AMQPLargeMessage(long id, long messageFormat, TypedProperties extraProperties, CoreMessageObjectPools coreMessageObjectPools, StorageManager storageManager, org.apache.activemq.artemis.core.persistence.impl.journal.LargeBody largeBody)

Method Summary

Modifier and Type	Method and Description
void	addBytes(ActiveMQBuffer bytes, boolean initialHeader)
void	addBytes(byte[] bytes)
void	addBytes(org.apache.qpid.proton.codec.ReadableBuffer data)
void	checkReference(MessageReference reference) This method check the reference for specifics on protocolData.
void	clearPendingRecordID()
void	closeLargeMessage()
Message	copy()
Message	copy(long newID)
Message	copy(long newID, boolean isDLQOrExpiry)
void	deleteFile()
protected void	encodeMessage()
protected void	ensureDataIsValid()
SequentialFile	getAppendFile()
org.apache.qpid.proton.codec.ReadableBuffer	getData()
int	getEncodeSize()
org.apache.activemq.artemis.core.persistence.impl.journal.LargeBody	getLargeBody()
org.apache.activemq.artemis.core.message.LargeBodyReader	getLargeBodyReader()
int	getMemoryEstimate()
long	getPendingRecordID()
long	getPersistentSize()
Persister<Message>	getPersister()
int	getPersistSize()
int	getPositionAfterDeliveryAnnotations() during large message deliver, we need this calculation to place a new delivery annotation
io.netty.buffer.ByteBuf	getSavedEncodeBuffer()
org.apache.qpid.proton.codec.ReadableBuffer	getSendBuffer(int deliveryCount, MessageReference reference) Gets a ByteBuf from the Message that contains the encoded bytes to be sent on the wire.
StorageManager	getStorageManager()
long	getWholeMessageSize()
boolean	hasPendingRecord()
io.netty.buffer.ByteBuf	inspectTemporaryBuffer() This is used on test assertions to make sure the buffers are released corrected
boolean	isDurable()
boolean	isLargeMessage()
boolean	isReencoded()
void	messageChanged()
protected io.netty.buffer.ByteBuf	newHeaderWithoutExpiry(AtomicInteger placeOutput)
void	openLargeMessage()
void	parseHeader(org.apache.qpid.proton.codec.ReadableBuffer buffer)
protected void	parseLargeMessage(ActiveMQBuffer data, boolean initialHeader)
protected void	parseLargeMessage(byte[] data, boolean initialHeader)
protected void	parseLargeMessage(org.apache.qpid.proton.codec.ReadableBuffer data)
void	persist(ActiveMQBuffer targetRecord)
protected void	readSavedEncoding(io.netty.buffer.ByteBuf buf)
void	reencode()
void	referenceOriginalMessage(Message original, String originalQueue)
protected void	releaseComplete()
void	releaseEncodedBuffer()
void	releaseEncodedBufferAfterWrite() getSavedEncodeBuffer() will retain two counters from the buffer, one meant for the call, and one that must be released only after encoding.
void	releaseResources(boolean sync, boolean sendEvent)
void	reloadPersistence(ActiveMQBuffer record, CoreMessageObjectPools pools)
void	setFileDurable(boolean value)
void	setPaged()
void	setPendingRecordID(long pendingRecordID)
void	setReencoded(boolean reencoded)
void	setStorageManager(StorageManager storageManager)
ICoreMessage	toCore(CoreMessageObjectPools coreMessageObjectPools)
Message	toMessage()
void	validateFile()

Methods inherited from class org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage

acceptsConsumer, cachedAddressSimpleString, clearInternalProperties, containsProperty, containsProperty, createDeliveryCopy, createExtraProperties, ensureMessageDataScanned, ensureScanning, getAddress, getAddressSimpleString, getAMQPUserID, getAnnotation, getApplicationProperties, getApplicationPropertiesMap, getBody, getBooleanProperty, getBooleanProperty, getBrokerProperty, getBuffer, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getConnectionID, getCorrelationID, getDataScanningStatus, getDecodedApplicationProperties, getDecodedMessageAnnotations, getDeliveryAnnotations, getDeliveryAnnotationsForSendBufferSize, getDoubleProperty, getDoubleProperty, getDuplicateProperty, getEstimateSavedEncode, getExpiration, getExtraBytesProperty, getExtraProperties, getFloatProperty, getFloatProperty, getFooter, getGroupID, getGroupSequence, getHeader, getIngressTimestamp, getIntProperty, getIntProperty, getLastValueProperty, getLongProperty, getLongProperty, getMessageAnnotation, getMessageAnnotation, getMessageAnnotations, getMessageAnnotationsMap, getMessageFormat, getMessageID, getObjectProperty, getObjectProperty, getObjectPropertyForFilter, getOwner, getPriority, getProperties, getPropertyKeysPool, getPropertyNames, getPropertyValuesPool, getProtonMessage, getReplyTo, getRoutingType, getScheduledDeliveryTime, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getUserID, hasScheduledDeliveryTime, internalPersistSize, lazyDecodeApplicationProperties, lazyDecodeApplicationProperties, lazyScanAfterReloadPersistence, 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, rejectConsumer, reloadExpiration, removeAnnotation, removeExtraBytesProperty, removeMessageAnnotation, removeProperty, removeProperty, resetMessageData, scanForMessageSection, scanForMessageSection, scanMessageData, scanMessageData, sendBuffer, setAddress, setAddress, setAnnotation, setBrokerProperty, setBuffer, setConnectionID, setCorrelationID, setDeliveryAnnotationsForSendBuffer, setDurable, setExpiration, setExtraProperties, setIngressTimestamp, setLastValueProperty, setMessageAnnotation, setMessageAnnotation, setMessageAnnotations, setMessageID, setOwner, setPriority, setReplyTo, setRoutingType, setScheduledDeliveryTime, setTimestamp, setUserID, toCore, toDebugString, toPropertyMap, toString, unmarshalledApplicationPropertiesMemoryEstimateFromData, writeDeliveryAnnotationsForSendBuffer

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

debugRefs, debugString, durableDown, durableUp, getDurableCount, getParentRef, getRefCount, getUsage, refDown, refUp, setParentRef, usageDown, usageUp

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.server.LargeServerMessage

addBytes, getMessageID

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

setDurable, setMessageID

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

durableDown, durableUp, getAnnotationString, getBodyBuffer, getBodyInputStream, getDuplicateIDBytes, getDurableCount, getRefCount, getStringBody, getType, getUsage, getValidatedUserID, isExpired, refDown, refUp, releaseBuffer, setGroupID, setGroupID, setGroupSequence, setType, setValidatedUserID, toMap, toMap, toPropertyMap, usageDown, usageUp

Constructor Detail

AMQPLargeMessage

public AMQPLargeMessage(long id,
                        long messageFormat,
                        TypedProperties extraProperties,
                        CoreMessageObjectPools coreMessageObjectPools,
                        StorageManager storageManager)

AMQPLargeMessage

public AMQPLargeMessage(long id,
                        long messageFormat,
                        TypedProperties extraProperties,
                        CoreMessageObjectPools coreMessageObjectPools,
                        StorageManager storageManager,
                        org.apache.activemq.artemis.core.persistence.impl.journal.LargeBody largeBody)

Method Detail

toCore

public ICoreMessage toCore(CoreMessageObjectPools coreMessageObjectPools)

Specified by:

toCore in interface Message

Overrides:

toCore in class AMQPMessage

openLargeMessage

public void openLargeMessage()
                      throws Exception

Throws:

Exception

closeLargeMessage

public void closeLargeMessage()
                       throws Exception

Throws:

Exception

releaseEncodedBuffer

public void releaseEncodedBuffer()

releaseEncodedBufferAfterWrite

public void releaseEncodedBufferAfterWrite()

getSavedEncodeBuffer() will retain two counters from the buffer, one meant for the call, and one that must be released only after encoding. This method is meant to be called when the buffer is actually encoded on the journal, meaning both refs are gone. and the actual buffer can be released.

checkReference

public void checkReference(MessageReference reference)

This method check the reference for specifics on protocolData. It was written to check the deliveryAnnotationsForSendBuffer and eventually move it to the protocolData.

getPositionAfterDeliveryAnnotations

public int getPositionAfterDeliveryAnnotations()

during large message deliver, we need this calculation to place a new delivery annotation

inspectTemporaryBuffer

public io.netty.buffer.ByteBuf inspectTemporaryBuffer()

This is used on test assertions to make sure the buffers are released corrected

getSavedEncodeBuffer

public io.netty.buffer.ByteBuf getSavedEncodeBuffer()

readSavedEncoding

protected void readSavedEncoding(io.netty.buffer.ByteBuf buf)

validateFile

public void validateFile()
                  throws ActiveMQException

Specified by:

validateFile in interface LargeServerMessage

Throws:

ActiveMQException

setFileDurable

public void setFileDurable(boolean value)

getStorageManager

public StorageManager getStorageManager()

Specified by:

getStorageManager in interface LargeServerMessage

setStorageManager

public void setStorageManager(StorageManager storageManager)

Specified by:

setStorageManager in interface LargeServerMessage

isDurable

public final boolean isDurable()

Specified by:

isDurable in interface Message

Overrides:

isDurable in class AMQPMessage

getData

public org.apache.qpid.proton.codec.ReadableBuffer getData()

Specified by:

getData in class AMQPMessage

parseHeader

public void parseHeader(org.apache.qpid.proton.codec.ReadableBuffer buffer)

addBytes

public void addBytes(org.apache.qpid.proton.codec.ReadableBuffer data)
              throws Exception

Throws:

Exception

parseLargeMessage

protected void parseLargeMessage(ActiveMQBuffer data,
                                 boolean initialHeader)

parseLargeMessage

protected void parseLargeMessage(byte[] data,
                                 boolean initialHeader)

parseLargeMessage

protected void parseLargeMessage(org.apache.qpid.proton.codec.ReadableBuffer data)

getSendBuffer

public org.apache.qpid.proton.codec.ReadableBuffer getSendBuffer(int deliveryCount,
                                                                 MessageReference reference)

Description copied from class: AMQPMessage

Gets a ByteBuf from the Message that contains the encoded bytes to be sent on the wire.

When possible this method will present the bytes to the caller without copying them into a new buffer copy. If copying is needed a new Netty buffer is created and returned. The caller should ensure that the reference count on the returned buffer is always decremented to avoid a leak in the case of a copied buffer being returned.

Overrides:

getSendBuffer in class AMQPMessage

Parameters:

deliveryCount - The new delivery count for this message.

Returns:

a Netty ByteBuf containing the encoded bytes of this Message instance.

toMessage

public Message toMessage()

Specified by:

toMessage in interface LargeServerMessage

addBytes

public void addBytes(byte[] bytes)
              throws Exception

Specified by:

addBytes in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

Specified by:

addBytes in interface LargeServerMessage

Throws:

Exception

addBytes

public void addBytes(ActiveMQBuffer bytes,
                     boolean initialHeader)
              throws Exception

Specified by:

addBytes in interface LargeServerMessage

Throws:

Exception

setPaged

public void setPaged()

Specified by:

setPaged in interface LargeServerMessage

releaseResources

public void releaseResources(boolean sync,
                             boolean sendEvent)

Specified by:

releaseResources in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

Specified by:

releaseResources in interface LargeServerMessage

deleteFile

public void deleteFile()
                throws Exception

Specified by:

deleteFile in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

Specified by:

deleteFile in interface LargeServerMessage

Throws:

Exception

getAppendFile

public SequentialFile getAppendFile()
                             throws ActiveMQException

Specified by:

getAppendFile in interface LargeServerMessage

Throws:

ActiveMQException

isLargeMessage

public boolean isLargeMessage()

Specified by:

isLargeMessage in interface Message

getLargeBodyReader

public org.apache.activemq.artemis.core.message.LargeBodyReader getLargeBodyReader()

Specified by:

getLargeBodyReader in interface LargeServerMessage

getLargeBody

public org.apache.activemq.artemis.core.persistence.impl.journal.LargeBody getLargeBody()

Specified by:

getLargeBody in interface LargeServerMessage

clearPendingRecordID

public void clearPendingRecordID()

Specified by:

clearPendingRecordID in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

hasPendingRecord

public boolean hasPendingRecord()

Specified by:

hasPendingRecord in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

setPendingRecordID

public void setPendingRecordID(long pendingRecordID)

Specified by:

setPendingRecordID in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

getPendingRecordID

public long getPendingRecordID()

Specified by:

getPendingRecordID in interface org.apache.activemq.artemis.core.replication.ReplicatedLargeMessage

releaseComplete

protected void releaseComplete()

Overrides:

releaseComplete in class RefCountMessage

copy

public Message copy()

Specified by:

copy in interface Message

Specified by:

copy in class AMQPMessage

copy

public Message copy(long newID)

Specified by:

copy in interface Message

copy

public Message copy(long newID,
                    boolean isDLQOrExpiry)

Specified by:

copy in interface Message

newHeaderWithoutExpiry

protected io.netty.buffer.ByteBuf newHeaderWithoutExpiry(AtomicInteger placeOutput)

messageChanged

public void messageChanged()

Specified by:

messageChanged in interface Message

Overrides:

messageChanged in class AMQPMessage

getEncodeSize

public int getEncodeSize()

Specified by:

getEncodeSize in interface Message

Specified by:

getEncodeSize in class AMQPMessage

getWholeMessageSize

public long getWholeMessageSize()

Specified by:

getWholeMessageSize in interface Message

getMemoryEstimate

public int getMemoryEstimate()

Specified by:

getMemoryEstimate in interface Message

Specified by:

getMemoryEstimate in class AMQPMessage

persist

public void persist(ActiveMQBuffer targetRecord)

Specified by:

persist in interface Message

Specified by:

persist in class AMQPMessage

getPersistSize

public int getPersistSize()

Specified by:

getPersistSize in interface Message

Specified by:

getPersistSize in class AMQPMessage

reloadPersistence

public void reloadPersistence(ActiveMQBuffer record,
                              CoreMessageObjectPools pools)

Specified by:

reloadPersistence in interface Message

Specified by:

reloadPersistence in class AMQPMessage

getPersistentSize

public long getPersistentSize()
                       throws ActiveMQException

Specified by:

getPersistentSize in interface Message

Specified by:

getPersistentSize in class AMQPMessage

Throws:

ActiveMQException

getPersister

public Persister<Message> getPersister()

Specified by:

getPersister in interface Message

Specified by:

getPersister in class AMQPMessage

reencode

public void reencode()

Specified by:

reencode in interface Message

Specified by:

reencode in class AMQPMessage

setReencoded

public void setReencoded(boolean reencoded)

isReencoded

public boolean isReencoded()

ensureDataIsValid

protected void ensureDataIsValid()

Specified by:

ensureDataIsValid in class AMQPMessage

encodeMessage

protected void encodeMessage()

Specified by:

encodeMessage in class AMQPMessage

referenceOriginalMessage

public void referenceOriginalMessage(Message original,
                                     String originalQueue)

Specified by:

referenceOriginalMessage in interface Message