forklift.message

Enum Header

java.lang.Object

java.lang.Enum<Header>

forklift.message.Header

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Header>

public enum Header
extends java.lang.Enum<Header>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CorrelationId The standard message id JMS: JMSCorrelationID Stomp: "correlation-id" Amqp: "properties.correlation-id" Type: String
DeliveryCount The message delivery count.
DeliveryMode The message delivery mode.
Expiration The message expiration JMS: JMSExpiration Stomp: "expires" Amqp: "header.ttl" Type: Long Note: Time in milliseconds - 0 means never expire
GroupId The message group id JMS: JMSXGroupID Stomp: "JMSXGroupID" Amqp: "application-properties.JMSXGroupID" Type: String
GroupSeq Specifies the sequence number in a Message Group JMS: JMSXGroupSeq Stomp: "JMSXGroupSeq" Amqp: "application-properties.JMSXGroupSeq" Type: Integer
PreviousDestination The previous message's destination.
Priority The message priority JMS: JMSPriority Stomp: "priority" Amqp: "header.priority" Type: Integer Note: 0 is lowest, 9 is highest
Producer The message producer's name JMS: JMSPProducer Stomp: "producer" Amqp: "application-properties.producer" Type: String
ReplyTo Destination the consumer should send replies.
Result The result of processing a message, added to messages sent to specialized consumers for auditing.
ResultDetail The detail about a result of processing a message, added to messages sent to specialized consumers for auditing.
RetryCount The number of times a message has tried to process JMS: JMSPRetryCount Stomp: "retry-count" Amqp: "application-properties.retry-count" Type: Integer
Timestamp The message creation time JMS: JMSTimestamp Stomp: "timestamp" Amqp: "properties.creation-time" Type: Long
Type The message type JMS: JMSType Stomp: "type" Amqp: "message-annotations.x-opt-jms-type" Type: String

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAmqpMessage()
java.lang.reflect.Type	getHeaderType()
java.lang.String	getJmsMessage()
java.lang.String	getStompMessage()
static Header	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Header[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CorrelationId

public static final Header CorrelationId

The standard message id

• JMS: JMSCorrelationID
• Stomp: "correlation-id"
• Amqp: "properties.correlation-id"
• Type: String

DeliveryCount

public static final Header DeliveryCount

The message delivery count. If a message is not properly acknowledged by a consumer, it may be re-delivered. This property keeps a total of the number of times the broker attempts to deliver a message to a consumer.

• JMS: JMSXDeliveryCount
• Stomp: "JMSXDeliveryCount"
• Amqp: "header.durable"
• Type: Integer

DeliveryMode

public static final Header DeliveryMode

The message delivery mode. Guarantees broker storage when persistent.

• JMS: JMSDeliveryMode
• Stomp: "persistent"
• Amqp: "header.durable"
• Type: Integer - 1: non-persistent, 2: persistent;

Expiration

public static final Header Expiration

The message expiration

• JMS: JMSExpiration
• Stomp: "expires"
• Amqp: "header.ttl"
• Type: Long
• Note: Time in milliseconds - 0 means never expire

GroupId

public static final Header GroupId

The message group id

• JMS: JMSXGroupID
• Stomp: "JMSXGroupID"
• Amqp: "application-properties.JMSXGroupID"
• Type: String

GroupSeq

public static final Header GroupSeq

Specifies the sequence number in a Message Group

• JMS: JMSXGroupSeq
• Stomp: "JMSXGroupSeq"
• Amqp: "application-properties.JMSXGroupSeq"
• Type: Integer

PreviousDestination

public static final Header PreviousDestination

The previous message's destination. Used to record which queue a message was initially bound when being audited.

• JMS: JMSPPreviousDestination
• Stomp: "previous-destination"
• Amqp: "application-properties.previous-destination"
• Type: String

Priority

public static final Header Priority

The message priority

• JMS: JMSPriority
• Stomp: "priority"
• Amqp: "header.priority"
• Type: Integer
• Note: 0 is lowest, 9 is highest

Producer

public static final Header Producer

The message producer's name

• JMS: JMSPProducer
• Stomp: "producer"
• Amqp: "application-properties.producer"
• Type: String

ReplyTo

public static final Header ReplyTo

Destination the consumer should send replies. Should be a URI. If the implementation of the JMS provider does not support type String, use property.

• JMS: JMSReplyTo or JMSPReplyTo
• Stomp: "reply-to"
• Amqp: "properties.reply-to"
• Type: String

Result

public static final Header Result

The result of processing a message, added to messages sent to specialized consumers for auditing.

• JMS: JMSPResult
• Stomp: "result"
• Amqp: "application-properties.result"
• Type: String

ResultDetail

public static final Header ResultDetail

The detail about a result of processing a message, added to messages sent to specialized consumers for auditing.

• JMS: JMSPResultDetail
• Stomp: "result-detail"
• Amqp: "application-properties.result-detail"
• Type: String

RetryCount

public static final Header RetryCount

The number of times a message has tried to process

• JMS: JMSPRetryCount
• Stomp: "retry-count"
• Amqp: "application-properties.retry-count"
• Type: Integer

Timestamp

public static final Header Timestamp

The message creation time

• JMS: JMSTimestamp
• Stomp: "timestamp"
• Amqp: "properties.creation-time"
• Type: Long

Type

public static final Header Type

The message type

• JMS: JMSType
• Stomp: "type"
• Amqp: "message-annotations.x-opt-jms-type"
• Type: String

Method Detail

values

public static Header[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Header c : Header.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Header valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getJmsMessage

public java.lang.String getJmsMessage()

getStompMessage

public java.lang.String getStompMessage()

getAmqpMessage

public java.lang.String getAmqpMessage()

getHeaderType

public java.lang.reflect.Type getHeaderType()