org.adroitlogic.ultraesb.api.format

Interface MessageFormat

public interface MessageFormat

The public API interface that defines a MessageFormat holding the payload

Author:

asankha

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	asSerializableObject() Get the data as a Serializable Java object
MessageFormat	clonePayload()
void	detach() Detach this payload from the Message.
InputStream	getInputStream() Get an InputStream to the message payload
String	getMessageFormat() Get the name of the message format
boolean	isDetached() Check if this payload is detached from its parent message
boolean	isModified() Does this message hold updated content?
long	length() Gives the length of the format, in other words the size of the payload.
void	releaseResources() Release any resources on this "detached" payload
String	toString() Return a possibly trimmed/size limited String representation of the payload
void	writeTo(OutputStream os) Write the message payload to the given OutputStream

Method Detail

getMessageFormat

String getMessageFormat()

Get the name of the message format

Returns:

name of the message format

isModified

boolean isModified()

Does this message hold updated content?

Returns:

true if this payload is modified, or modifies the original message payload

detach

void detach()

Detach this payload from the Message. Once detached, the recycling or release of any resources held is the responsibility of the user

releaseResources

void releaseResources()

Release any resources on this "detached" payload

isDetached

boolean isDetached()

Check if this payload is detached from its parent message

Returns:

true if detached

toString

String toString()

Return a possibly trimmed/size limited String representation of the payload

Overrides:

toString in class Object

asSerializableObject

Serializable asSerializableObject()
                                  throws FormatConversionException

Get the data as a Serializable Java object

Throws:

FormatConversionException

writeTo

void writeTo(OutputStream os)
             throws IOException

Write the message payload to the given OutputStream

Parameters:

os - the OutputStream to serialize the message into

Throws:

IOException - on an IO error

getInputStream

InputStream getInputStream()
                           throws IOException

Get an InputStream to the message payload

Returns:

InputStream to the payload

Throws:

IOException - on an IO error

length

long length()

Gives the length of the format, in other words the size of the payload. It is not guaranteed that this will return the length of the message format. It depends on the type of the message. This method is intended to retrieve the length of the message format if it is already known. This method will not attempt to serialize the format and find the length, instead it will return -1 in such cases, it is expected that the caller takes care of that calculation

However it is not recommended to serialize the input stream in-order to find the length unless you are certain that it is required, or you are just about to consume the stream, for example in a transport sender or before discarding a message etc..

Returns:

the length of the message format, if it is retrievable without serialization, or -1 if not

clonePayload

MessageFormat clonePayload()