Adding javadocs to Message properties

This commit is contained in:
Clebert Suconic 2015-09-28 16:05:38 -04:00
parent eae2a2ea40
commit 55d175eedf
1 changed files with 33 additions and 0 deletions

View File

@ -51,26 +51,59 @@ import org.apache.activemq.artemis.utils.UUID;
*/ */
public interface Message { public interface Message {
/**
* the actual time the message was expired.
* * * */
SimpleString HDR_ACTUAL_EXPIRY_TIME = new SimpleString("_AMQ_ACTUAL_EXPIRY"); SimpleString HDR_ACTUAL_EXPIRY_TIME = new SimpleString("_AMQ_ACTUAL_EXPIRY");
/**
* The original address of a message when a message is transfered through DLQ or expiry
*/
SimpleString HDR_ORIGINAL_ADDRESS = new SimpleString("_AMQ_ORIG_ADDRESS"); SimpleString HDR_ORIGINAL_ADDRESS = new SimpleString("_AMQ_ORIG_ADDRESS");
/**
* The original address of a message when a message is transfered through DLQ or expiry
*/
SimpleString HDR_ORIGINAL_QUEUE = new SimpleString("_AMQ_ORIG_QUEUE"); SimpleString HDR_ORIGINAL_QUEUE = new SimpleString("_AMQ_ORIG_QUEUE");
/**
* The original message ID before th emessage was transferred.
*/
SimpleString HDR_ORIG_MESSAGE_ID = new SimpleString("_AMQ_ORIG_MESSAGE_ID"); SimpleString HDR_ORIG_MESSAGE_ID = new SimpleString("_AMQ_ORIG_MESSAGE_ID");
/**
* For the Message Grouping feature.
*/
SimpleString HDR_GROUP_ID = new SimpleString("_AMQ_GROUP_ID"); SimpleString HDR_GROUP_ID = new SimpleString("_AMQ_GROUP_ID");
/**
* to determine if the Large Message was compressed.
*/
SimpleString HDR_LARGE_COMPRESSED = new SimpleString("_AMQ_LARGE_COMPRESSED"); SimpleString HDR_LARGE_COMPRESSED = new SimpleString("_AMQ_LARGE_COMPRESSED");
/**
* The body size of a large message before it was compressed.
*/
SimpleString HDR_LARGE_BODY_SIZE = new SimpleString("_AMQ_LARGE_SIZE"); SimpleString HDR_LARGE_BODY_SIZE = new SimpleString("_AMQ_LARGE_SIZE");
/**
* To be used with Scheduled Delivery.
*/
SimpleString HDR_SCHEDULED_DELIVERY_TIME = new SimpleString("_AMQ_SCHED_DELIVERY"); SimpleString HDR_SCHEDULED_DELIVERY_TIME = new SimpleString("_AMQ_SCHED_DELIVERY");
/**
* To be used with duplicate detection.
*/
SimpleString HDR_DUPLICATE_DETECTION_ID = new SimpleString("_AMQ_DUPL_ID"); SimpleString HDR_DUPLICATE_DETECTION_ID = new SimpleString("_AMQ_DUPL_ID");
/**
* To be used with Last value queues.
*/
SimpleString HDR_LAST_VALUE_NAME = new SimpleString("_AMQ_LVQ_NAME"); SimpleString HDR_LAST_VALUE_NAME = new SimpleString("_AMQ_LVQ_NAME");
/**
* To define the mime-type of body messages. Mainly for stomp but it could be informed on any message for user purposes.
*/
SimpleString HDR_CONTENT_TYPE = new SimpleString("_AMQ_CONTENT_TYPE"); SimpleString HDR_CONTENT_TYPE = new SimpleString("_AMQ_CONTENT_TYPE");
byte DEFAULT_TYPE = 0; byte DEFAULT_TYPE = 0;