Chapter 13. Working with Large Messages

Procedure

• Add the configuration to BROKER_INSTANCE_DIR/etc/broker.xml that references the location chosen to store large messages.

  • If you are using journal persistence, add the large-messages-directory element and provide the file system path to the location used to store large messages.

    <configuration>
      <core>
        ...
        <large-messages-directory>/path/to/large-messages</large-messages-directory> 

    1

    
        ...
      </core>
    </configuration>

    Copy to Clipboard Toggle word wrap

    1

    The default value for the large-messages-directory configuration element is BROKER_INSTANCE_DIR/data/largemessages

  • If you are using JDBC persistence, add the name of the database table used to persist large messages to your database-store.

    <store>
      <database-store>
        ...
        <large-message-table>MY_TABLE</large-message-table> 

    1

    
      </database-store>
    </store>

    Copy to Clipboard Toggle word wrap

    1

    The default value for the large-message-table configuration element is LARGE_MESSAGE_TABLE.

Procedure

• Set the minimum size for large messages.

  • If you are using JNDI to instantiate your connection factory, you can specify the size in a jndi.properties, using the parameter minLargeMessageSize.

    java.naming.factory.initial=org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory
    connectionFactory.myConnectionFactory=tcp://localhost:61616?minLargeMessageSize=250000

    Copy to Clipboard Toggle word wrap

  • If you are not using JNDI, specify the minimum large message size using the method ActiveMQConnectionFactory.setMinLargeMessageSize().

    ConnectionFactory cf =  ActiveMQJMSClient.createConnectionFactory(...)
    cf.setMinLargeMessageSize(250000);

    Copy to Clipboard Toggle word wrap

Procedure

• Set the JMS_AMQ_InputStream property to mark the message as streamed, as in the example below.

  BytesMessage message = session.createBytesMessage();
  FileInputStream fileInputStream = new FileInputStream(fileInput);
  BufferedInputStream bufferedInput = new BufferedInputStream(fileInputStream);
  message.setObjectProperty("JMS_AMQ_InputStream", bufferedInput);
  ...

  Copy to Clipboard Toggle word wrap

Procedure

• Set the JMS_AMQ_SaveStream on the message object.

  BytesMessage messageReceived = (BytesMessage)messageConsumer.receive(120000);
  File outputFile = new File("large_message_received.dat");
  FileOutputStream fileOutputStream = new FileOutputStream(outputFile);
  BufferedOutputStream bufferedOutput = new BufferedOutputStream(fileOutputStream);
  
  // This will block until the entire content is saved on disk
  messageReceived.setObjectProperty("JMS_AMQ_SaveStream", bufferedOutput);

  Copy to Clipboard Toggle word wrap

Procedure

• Set the JMS_AMQ_OutputStream parameter on the message object.

  BytesMessage messageReceived = (BytesMessage)messageConsumer.receive(120000);
  File outputFile = new File("large_message_received.dat");
  FileOutputStream fileOutputStream = new FileOutputStream(outputFile);
  BufferedOutputStream bufferedOutput = new BufferedOutputStream(fileOutputStream);
  
  // This will not block until the entire content is saved on disk
  messageReceived.setObjectProperty("JMS_AMQ_OutputStream", bufferedOutput);

  Copy to Clipboard Toggle word wrap

Procedure

• If you use a Core JMS client and JNDI, use the JNDI context environment to enable message compression, as in the example below.

  java.naming.factory.initial=org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory
  connectionFactory.myConnectionFactory=tcp://localhost:61616?compressLargeMessages=true

  Copy to Clipboard Toggle word wrap

• (Optional) Add the minLargeMessageSize parameter to the connection factory URL to set the minimum size needed before a message is compressed. In the example below, messages are compressed only if they exceed 250 kilobytes in size.

  connectionFactory.myConnectionFactory=tcp://localhost:61616?compressLargeMessages=true&minLargeMessageSize=250kb

  Copy to Clipboard Toggle word wrap