asia.stampy.common.message

Class AbstractBodyMessage<HDR extends AbstractBodyMessageHeader>

java.lang.Object

asia.stampy.common.message.AbstractMessage<HDR>

asia.stampy.common.message.AbstractBodyMessage<HDR>

Type Parameters:

HDR - the generic type

All Implemented Interfaces:

StampyMessage<HDR>, java.io.Serializable

Direct Known Subclasses:

ErrorMessage, MessageMessage, SendMessage

@StampyLibrary(libraryName="stampy-core")
public abstract class AbstractBodyMessage<HDR extends AbstractBodyMessageHeader>
extends AbstractMessage<HDR>

Abstract class representing STOMP messages with a body. Binary bodies are catered for, provided they are Java objects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAVA_BASE64_MIME_TYPE The Constant JAVA_BASE64_MIME_TYPE.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBodyMessage(StompMessageType messageType) Instantiates a new abstract body message.

Method Summary

Methods

Modifier and Type	Method and Description
<O> O	getBody() Gets the body.
java.lang.String	getBodyEncoding() Gets the body encoding.
java.lang.String	getObjectArrayAsBase64(java.lang.Object o) Gets the object array as base64.
protected java.lang.String	getObjectArrayAsString(java.lang.Object body) Should the getBodyEncoding() return a value other than JAVA_BASE64_MIME_TYPE, this method will be invoked.
boolean	isText() Checks if is text.
protected java.lang.String	postHeader() This method is used to create the body of the message, if applicable.
<O> void	setBody(O body) Sets the body.
void	setBodyEncoding(java.lang.String bodyEncoding) Sets the body encoding.
void	setMimeType(java.lang.String mimeType) Sets the mime type.
void	setMimeType(java.lang.String mimeType, java.lang.String encoding) Sets the mime type.

Methods inherited from class asia.stampy.common.message.AbstractMessage

createNewHeader, equals, getHeader, getMessageType, hashCode, toStompMessage, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JAVA_BASE64_MIME_TYPE

public static final java.lang.String JAVA_BASE64_MIME_TYPE

The Constant JAVA_BASE64_MIME_TYPE.

See Also:

Constant Field Values

Constructor Detail

AbstractBodyMessage

protected AbstractBodyMessage(StompMessageType messageType)

Instantiates a new abstract body message.

Parameters:

messageType - the message type

Method Detail

getBody

public <O> O getBody()

Gets the body.

Type Parameters:

O - the generic type

Returns:

the body

setBody

public <O> void setBody(O body)

Sets the body.

Type Parameters:

O - the generic type

Parameters:

body - the new body

setMimeType

public void setMimeType(java.lang.String mimeType)

Sets the mime type.

Parameters:

mimeType - the new mime type

setMimeType

public void setMimeType(java.lang.String mimeType,
               java.lang.String encoding)

Sets the mime type.

Parameters:

mimeType - the mime type

encoding - the encoding

isText

public boolean isText()

Checks if is text.

Returns:

true, if is text

postHeader

protected java.lang.String postHeader()

Description copied from class: AbstractMessage

This method is used to create the body of the message, if applicable. The default implementation returns null.

Overrides:

postHeader in class AbstractMessage<HDR extends AbstractBodyMessageHeader>

Returns:

the string

getObjectArrayAsString

protected java.lang.String getObjectArrayAsString(java.lang.Object body)

Should the getBodyEncoding() return a value other than JAVA_BASE64_MIME_TYPE, this method will be invoked. The default implementation throws a NotImplementedException. Override as necessary.

Parameters:

body - the body

Returns:

the object array as string

getObjectArrayAsBase64

public java.lang.String getObjectArrayAsBase64(java.lang.Object o)
                                        throws java.io.IOException

Gets the object array as base64.

Parameters:

o - the o

Returns:

the object array as base64

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getBodyEncoding

public java.lang.String getBodyEncoding()

Gets the body encoding. Defaults to JAVA_BASE64_MIME_TYPE.

Returns:

the body encoding

setBodyEncoding

public void setBodyEncoding(java.lang.String bodyEncoding)

Sets the body encoding.

Parameters:

bodyEncoding - the new body encoding