io.micronaut.jms.model

Class JMSHeaders

java.lang.Object

io.micronaut.jms.model.JMSHeaders

public final class JMSHeaders
extends java.lang.Object

Utility class for access to the supported JMS Headers, and methods to extract those values from a given Message.

Since:

1.0.0

Author:

Elliott Pope

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JMS_CORRELATION_ID Name of the Correlation ID header.
static java.lang.String	JMS_DELIVERY_MODE Name of the Delivery Mode header.
static java.lang.String	JMS_DELIVERY_TIME Name of the Delivery Time header.
static java.lang.String	JMS_DESTINATION Name of the Destination header.
static java.lang.String	JMS_EXPIRATION Name of the Expiration header.
static java.lang.String	JMS_MESSAGE_ID Name of the ID header.
static java.lang.String	JMS_PRIORITY Name of the Priority header.
static java.lang.String	JMS_REDELIVERED Name of the Redelivered header.
static java.lang.String	JMS_REPLY_TO Name of the Reply To header.
static java.lang.String	JMS_TIMESTAMP Name of the Timestamp header.
static java.lang.String	JMS_TYPE Name of the Type header.

Method Summary

Modifier and Type	Method and Description
static <T> T	getHeader(java.lang.String headerName, javax.jms.Message message, java.lang.Class<T> clazz) Attempts to retrieve the value of the header given by headerName from the given message.
static boolean	isJMSHeader(java.lang.String headerName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JMS_CORRELATION_ID

public static final java.lang.String JMS_CORRELATION_ID

Name of the Correlation ID header. Specifies an ID so the Message can be linked to other messages.

See Also:

Message.getJMSCorrelationID(), Constant Field Values

JMS_DELIVERY_MODE

public static final java.lang.String JMS_DELIVERY_MODE

Name of the Delivery Mode header.

See Also:

Message.getJMSDeliveryMode(), Constant Field Values

JMS_DELIVERY_TIME

public static final java.lang.String JMS_DELIVERY_TIME

Name of the Delivery Time header. Note: Only available when using a JMS 2.0 provider.

See Also:

Message.getJMSDeliveryTime(), Constant Field Values

JMS_DESTINATION

public static final java.lang.String JMS_DESTINATION

Name of the Destination header. Specifies the destination of a Message or where it was received from.

See Also:

Message.getJMSDestination(), Constant Field Values

JMS_EXPIRATION

public static final java.lang.String JMS_EXPIRATION

Name of the Expiration header.

See Also:

Message.getJMSExpiration(), Constant Field Values

JMS_MESSAGE_ID

public static final java.lang.String JMS_MESSAGE_ID

Name of the ID header. Specifies a unique ID for a Message.

See Also:

Message.getJMSMessageID(), Constant Field Values

JMS_PRIORITY

public static final java.lang.String JMS_PRIORITY

Name of the Priority header.

See Also:

Message.getJMSPriority(), Constant Field Values

JMS_REDELIVERED

public static final java.lang.String JMS_REDELIVERED

Name of the Redelivered header.

See Also:

Message.getJMSRedelivered(), Constant Field Values

JMS_REPLY_TO

public static final java.lang.String JMS_REPLY_TO

Name of the Reply To header.

See Also:

Message.getJMSReplyTo(), Constant Field Values

JMS_TIMESTAMP

public static final java.lang.String JMS_TIMESTAMP

Name of the Timestamp header.

See Also:

Message.getJMSTimestamp(), Constant Field Values

JMS_TYPE

public static final java.lang.String JMS_TYPE

Name of the Type header.

See Also:

Message.getJMSType(), Constant Field Values

Method Detail

isJMSHeader

public static boolean isJMSHeader(java.lang.String headerName)

Parameters:

headerName - the name of the header to test.

Returns:

true if the given headerName is a supported JMS Header name

getHeader

@Nullable
public static <T> T getHeader(java.lang.String headerName,
                                        javax.jms.Message message,
                                        java.lang.Class<T> clazz)

Attempts to retrieve the value of the header given by headerName from the given message. Returns null if no value is present, or an exception occurs when extracting the header.

Type Parameters:

T - the expected class of the header value.

Parameters:

headerName - the name of the header to be extracted.

message - the Message to extract the header from.

clazz - the expected class of the header value.

Returns:

the value of the header on the given message specified by headerName as an object of type clazz.