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, CoreLargeServerMessage, LargeServerMessage
```
public final class LargeServerMessageImpl
extends CoreMessage
implements CoreLargeServerMessage
```

Field Summary
- Fields inherited from class org.apache.activemq.artemis.core.message.impl.CoreMessage
  address, BODY_OFFSET, buffer, BUFFER_HEADER_SPACE, durable, endOfBodyPosition, memoryEstimate, messageID, messageIDPosition, priority, properties, timestamp, type, writableBuffer
- 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_ORIG_ROUTING_TYPE, 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	Description
`LargeServerMessageImpl(byte type, long id, StorageManager storageManager, SequentialFile fileCopy)`
`LargeServerMessageImpl(LargeServerMessageImpl copy, TypedProperties properties, SequentialFile fileCopy, long newID)`	Copy constructor
`LargeServerMessageImpl(StorageManager storageManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addBytes(byte[] bytes)`
`void`	`addBytes(ActiveMQBuffer bytes, boolean initialHeader)`
`static Message`	`checkLargeMessage(Message message, StorageManager storageManager)`	This will check if a regular message needs to be converted as large message
`void`	`clearPendingRecordID()`
`Message`	`copy()`
`Message`	`copy(long newID)`
`void`	`decode(ActiveMQBuffer buffer1)`
`void`	`deleteFile()`
`void`	`encode(ActiveMQBuffer buffer1)`
`void`	`ensureFileExists(boolean toOpen)`
`SequentialFile`	`getAppendFile()`	This will return the File suitable for appending the message
`int`	`getBodyBufferSize()`
`long`	`getBodySize()`
`int`	`getEncodeSize()`
`LargeBody`	`getLargeBody()`
`LargeBodyReader`	`getLargeBodyReader()`
`int`	`getMemoryEstimate()`
`long`	`getPendingRecordID()`
`long`	`getPersistentSize()`
`ActiveMQBuffer`	`getReadOnlyBodyBuffer()`
`StorageManager`	`getStorageManager()`
`long`	`getWholeMessageSize()`
`boolean`	`hasPendingRecord()`
`boolean`	`isLargeMessage()`
`boolean`	`isServerMessage()`
`void`	`referenceOriginalMessage(Message original, SimpleString originalQueue)`
`protected void`	`releaseComplete()`
`void`	`releaseResources(boolean sync, boolean sendEvent)`	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)`
`void`	`setStorageManager(StorageManager storageManager)`
`Message`	`toMessage()`
`String`	`toString()`
`void`	`validateFile()`

Methods inherited from class org.apache.activemq.artemis.core.message.impl.CoreMessage
checkEncode, clearInternalProperties, containsProperty, containsProperty, 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, getOwner, getPersister, getPersistSize, getPriority, getProperties, getPropertyNames, getProtocolName, getReplyTo, getRoutingType, getScheduledDeliveryTime, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringBody, getStringProperty, getStringProperty, getTimestamp, getType, getUserID, getValidatedUserID, hasScheduledDeliveryTime, initBuffer, internalSetMessageID, isDurable, messageChanged, moveHeadersAndProperties, 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, receiveBuffer_1X, reloadPersistence, removeAnnotation, removeProperty, removeProperty, searchProperty, sendBuffer, sendBuffer_1X, setAddress, setAddress, setBuffer, setCorrelationID, setDurable, setExpiration, setGroupID, setGroupID, setGroupSequence, setLastValueProperty, setMessageID, setOwner, setPriority, setReplyTo, setRoutingType, setScheduledDeliveryTime, setTimestamp, setType, setUserID, setUserID, setValidatedUserID, toCompositeData, toCore, toCore

Methods inherited from class org.apache.activemq.artemis.api.core.RefCountMessage
debugRefs, debugString, durableDown, durableUp, getDurableCount, getParentRef, getRefCount, getUsage, getUserContext, refDown, refUp, setParentRef, setUserContext, 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.api.core.ICoreMessage
toMap

Methods inherited from interface org.apache.activemq.artemis.core.server.LargeServerMessage
addBytes, getMessageID

Methods inherited from interface org.apache.activemq.artemis.api.core.Message
acceptsConsumer, copy, durableDown, durableUp, getAnnotationString, getBrokerProperty, getConnectionID, getDuplicateIDBytes, getDurableCount, getExtraBytesProperty, getIngressTimestamp, getObjectPropertyForFilter, getRefCount, getUsage, getUserContext, isExpired, putExtraBytesProperty, reencode, refDown, refUp, rejectConsumer, removeExtraBytesProperty, setAnnotation, setBrokerProperty, setConnectionID, setIngressTimestamp, setUserContext, toMap, toPropertyMap, toPropertyMap, usageDown, usageUp

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

- Constructor Detail
  - LargeServerMessageImpl
```
public LargeServerMessageImpl(StorageManager storageManager)
```
  - LargeServerMessageImpl
```
public LargeServerMessageImpl(LargeServerMessageImpl copy,
                              TypedProperties properties,
                              SequentialFile fileCopy,
                              long newID)
```
    Copy constructor
    
    Parameters:
    
    properties -
    
    copy -
    
    fileCopy -
  - LargeServerMessageImpl
```
public LargeServerMessageImpl(byte type,
                              long id,
                              StorageManager storageManager,
                              SequentialFile fileCopy)
```
- Method Detail
  - toMessage
```
public Message toMessage()
```
    Specified by:
    
    toMessage in interface LargeServerMessage
  - 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
  - getBodySize
```
public long getBodySize()
                 throws ActiveMQException
```
    Throws:
    
    ActiveMQException
  - getStorageManager
```
public StorageManager getStorageManager()
```
    Specified by:
    
    getStorageManager in interface LargeServerMessage
  - isServerMessage
```
public boolean isServerMessage()
```
    Specified by:
    
    isServerMessage in interface ICoreMessage
    
    Overrides:
    
    isServerMessage in class CoreMessage
  - getPendingRecordID
```
public long getPendingRecordID()
```
    Specified by:
    
    getPendingRecordID in interface ReplicatedLargeMessage
  - clearPendingRecordID
```
public void clearPendingRecordID()
```
    Specified by:
    
    clearPendingRecordID in interface ReplicatedLargeMessage
  - hasPendingRecord
```
public boolean hasPendingRecord()
```
    Specified by:
    
    hasPendingRecord 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 LargeServerMessage
    
    Specified by:
    
    addBytes in interface ReplicatedLargeMessage
    
    Throws:
    
    Exception
    
    See Also:
    
    LargeServerMessage.addBytes(byte[])
  - addBytes
```
public void addBytes(ActiveMQBuffer bytes,
                     boolean initialHeader)
              throws Exception
```
    Specified by:
    
    addBytes in interface LargeServerMessage
    
    Throws:
    
    Exception
  - getEncodeSize
```
public int getEncodeSize()
```
    Specified by:
    
    getEncodeSize in interface Message
    
    Overrides:
    
    getEncodeSize in class CoreMessage
  - getWholeMessageSize
```
public long getWholeMessageSize()
```
    Specified by:
    
    getWholeMessageSize in interface Message
  - encode
```
public void encode(ActiveMQBuffer buffer1)
```
  - decode
```
public void decode(ActiveMQBuffer buffer1)
```
  - getLargeBodyReader
```
public LargeBodyReader getLargeBodyReader()
```
    Specified by:
    
    getLargeBodyReader in interface ICoreMessage
    
    Specified by:
    
    getLargeBodyReader in interface LargeServerMessage
    
    Overrides:
    
    getLargeBodyReader in class CoreMessage
  - releaseComplete
```
protected void releaseComplete()
```
    Overrides:
    
    releaseComplete in class RefCountMessage
  - getReadOnlyBodyBuffer
```
public ActiveMQBuffer getReadOnlyBodyBuffer()
```
    Specified by:
    
    getReadOnlyBodyBuffer in interface ICoreMessage
    
    Overrides:
    
    getReadOnlyBodyBuffer in class CoreMessage
  - getBodyBufferSize
```
public int getBodyBufferSize()
```
    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 LargeServerMessage
    
    Specified by:
    
    deleteFile in interface ReplicatedLargeMessage
    
    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,
                             boolean sendEvent)
```
    Description copied from interface: LargeServerMessage
    
    Close the files if opened
    
    Specified by:
    
    releaseResources in interface LargeServerMessage
    
    Specified by:
    
    releaseResources in interface ReplicatedLargeMessage
    
    See Also:
    
    LargeServerMessage.releaseResources(boolean,boolean)
  - referenceOriginalMessage
```
public void referenceOriginalMessage(Message original,
                                     SimpleString originalQueue)
```
    Specified by:
    
    referenceOriginalMessage in interface Message
  - setStorageManager
```
public void setStorageManager(StorageManager storageManager)
```
    Specified by:
    
    setStorageManager in interface LargeServerMessage
  - copy
```
public Message copy()
```
    Specified by:
    
    copy in interface Message
    
    Overrides:
    
    copy in class CoreMessage
  - getLargeBody
```
public LargeBody getLargeBody()
```
    Specified by:
    
    getLargeBody in interface LargeServerMessage
  - copy
```
public Message copy(long newID)
```
    Specified by:
    
    copy in interface Message
    
    Overrides:
    
    copy in class CoreMessage
  - getAppendFile
```
public SequentialFile getAppendFile()
                             throws ActiveMQException
```
    Description copied from interface: LargeServerMessage
    
    This will return the File suitable for appending the message
    
    Specified by:
    
    getAppendFile in interface LargeServerMessage
    
    Returns:
    
    Throws:
    
    ActiveMQException
  - getPersistentSize
```
public long getPersistentSize()
                       throws ActiveMQException
```
    Specified by:
    
    getPersistentSize in interface Message
    
    Overrides:
    
    getPersistentSize in class CoreMessage
    
    Throws:
    
    ActiveMQException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class CoreMessage
  - validateFile
```
public void validateFile()
                  throws ActiveMQException
```
    Specified by:
    
    validateFile in interface LargeServerMessage
    
    Throws:
    
    ActiveMQException
  - ensureFileExists
```
public void ensureFileExists(boolean toOpen)
                      throws ActiveMQException
```
    Throws:
    
    ActiveMQException

Class LargeServerMessageImpl

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

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

Constructor Detail

LargeServerMessageImpl

LargeServerMessageImpl

LargeServerMessageImpl

Method Detail

toMessage

checkLargeMessage

getBodySize

getStorageManager

isServerMessage

getPendingRecordID

clearPendingRecordID

hasPendingRecord

setPendingRecordID

setPaged

addBytes

addBytes

getEncodeSize

getWholeMessageSize

encode

decode

getLargeBodyReader

releaseComplete

getReadOnlyBodyBuffer

getBodyBufferSize

isLargeMessage

deleteFile

getMemoryEstimate

releaseResources

referenceOriginalMessage

setStorageManager

copy

getLargeBody

copy

getAppendFile

getPersistentSize

toString

validateFile

ensureFileExists