com.communote.plugins.mq.service.provider

Class TransferMessage

java.lang.Object

com.communote.plugins.mq.service.provider.TransferMessage

public class TransferMessage
extends Object

Uniform representation of the message notion, to be used independently on any MQ implementation.

Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferMessage.TMContentType Supported Transfer Message content types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_CONTENT_TYPE The Constant HEADER_CONTENT_TYPE.
static String	HEADER_CORRELATION_ID The Constant HEADER_CORRELATION_ID.
static String	HEADER_MESSAGE_TYPE The Constant HEADER_MESSAGE_TYPE.
static String	HEADER_MESSAGE_VERSION The Constant HEADER_MESSAGE_VERSION.
static String	HEADER_PRE_AUTHENTICATED_CLIENT_ID Header constant corresponding to HEADER_PRE_AUTHENTICATED_USER_IDENTIFICATION.
static String	HEADER_PRE_AUTHENTICATED_USER_IDENTIFICATION Header constant holding a user identification of a pre authenticated user.
static String	HEADER_REPLY_QUEUE The Constant HEADER_REPLY_QUEUE_ID.
static String	HEADER_TRUST_USER Boolean property on a JMS message, indicating that the user can be trusted and no password authentication within communote must be done.

Constructor Summary

Constructors

Constructor and Description
TransferMessage()

Method Summary

Modifier and Type	Method and Description
String	getContent() returns message content.
TransferMessage.TMContentType	getContentType() returns message's content type.
Object	getHeader(String key) Gets the header.
void	putHeader(String key, Object value) Put header.
void	setContent(String content) Sets the content.
void	setContentType(TransferMessage.TMContentType contentType) Sets the content type.

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_CONTENT_TYPE

public static final String HEADER_CONTENT_TYPE

The Constant HEADER_CONTENT_TYPE.

See Also:

Constant Field Values

HEADER_MESSAGE_TYPE

public static final String HEADER_MESSAGE_TYPE

The Constant HEADER_MESSAGE_TYPE.

See Also:

Constant Field Values

HEADER_MESSAGE_VERSION

public static final String HEADER_MESSAGE_VERSION

The Constant HEADER_MESSAGE_VERSION.

See Also:

Constant Field Values

HEADER_CORRELATION_ID

public static final String HEADER_CORRELATION_ID

The Constant HEADER_CORRELATION_ID.

See Also:

Constant Field Values

HEADER_REPLY_QUEUE

public static final String HEADER_REPLY_QUEUE

The Constant HEADER_REPLY_QUEUE_ID.

See Also:

Constant Field Values

HEADER_TRUST_USER

public static final String HEADER_TRUST_USER

Boolean property on a JMS message, indicating that the user can be trusted and no password authentication within communote must be done. This is the case if the connection is using an embedded non network connection (e.g. vm protocol in activemq)

See Also:

Constant Field Values

HEADER_PRE_AUTHENTICATED_USER_IDENTIFICATION

public static final String HEADER_PRE_AUTHENTICATED_USER_IDENTIFICATION

Header constant holding a user identification of a pre authenticated user. pre authentication means that the user has been authenticated through the message broker.

See Also:

Constant Field Values

HEADER_PRE_AUTHENTICATED_CLIENT_ID

public static final String HEADER_PRE_AUTHENTICATED_CLIENT_ID

Header constant corresponding to HEADER_PRE_AUTHENTICATED_USER_IDENTIFICATION. The value holds the client id the identification is valid for.

See Also:

Constant Field Values

Constructor Detail

TransferMessage

public TransferMessage()

Method Detail

getContent

public String getContent()

returns message content.

Returns:

message content

getContentType

public TransferMessage.TMContentType getContentType()

returns message's content type.

Returns:

message content

getHeader

public Object getHeader(String key)

Gets the header.

Parameters:

key - header key

Returns:

returns specified header or null if not found

putHeader

public void putHeader(String key,
                      Object value)

Put header.

Parameters:

key - the key

value - the value

setContent

public void setContent(String content)

Sets the content.

Parameters:

content - the new content

setContentType

public void setContentType(TransferMessage.TMContentType contentType)

Sets the content type.

Parameters:

contentType - the new content type