com.soa.message

Class SimpleMessage

java.lang.Object

com.soa.message.AbstractMessage

com.soa.message.SimpleMessage

All Implemented Interfaces:

Message

public class SimpleMessage
extends AbstractMessage

Simple implementation of the Message interface. No protocol specific implementation provided. The message reports its normalized as the normalization functions do not do anything.

Constructor Summary

Constructors

Constructor and Description
SimpleMessage()

Method Summary

Modifier and Type	Method and Description
boolean	canNormalize() Returns whether the message can be normalized or not.
Message	copy() Create a copy of the message.
boolean	isFault() Returns whether or not the message is a fault message.
boolean	isNormalized() Returns whether the message is normalized or not.
Message	normalize() Normalizes the message.
Message	normalizeCopy() Normalizes the message leaving the original bound object unchanged.
Message	normalizeCopyToXML() Normalizes the message to an XML format leaving the original bound object unchanged.
Message	normalizeToXML() Normalizes the message to an XML format.
void	setIsFault(boolean isFault)
void	setIsNormalized(boolean isNormalized)

Methods inherited from class com.soa.message.AbstractMessage

addAttachment, addPart, arePartsEmpty, canCarryBindingHeaders, copy, createAttachments, getAttachments, getBindingURI, getContent, getContentPartName, getContentType, getCorrelationID, getID, getPart, getPartNames, getParts, getProperties, getProperty, getPropertyNames, getSecuritySubject, getTransportHeaders, removePart, setAttachments, setBindingURI, setContent, setContentPartName, setContentType, setCorrelationID, setID, setProperties, setProperty, setSecuritySubject, setTransportHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMessage

public SimpleMessage()

Method Detail

isFault

public boolean isFault()

Description copied from interface: Message

Returns whether or not the message is a fault message.

Returns:

True if a fault, false if not.

setIsFault

public void setIsFault(boolean isFault)

setIsNormalized

public void setIsNormalized(boolean isNormalized)

isNormalized

public boolean isNormalized()

Description copied from interface: Message

Returns whether the message is normalized or not.

Returns:

True if normalized, false if not.

normalizeToXML

public Message normalizeToXML()
                       throws GException

Description copied from interface: Message

Normalizes the message to an XML format. All defined message parts are taken from their bound encodings and placed in the message's parts map. The part identified as the content part (see Message.getContentPartName()) will be translated into an XML representation. A new normalized version of the message is returned. Due to the possibility of this original object using InputStreams to hold its content, after normalization this object's InputStreams will most likely be exhausted making this object unusable. To continue to use this object after normalization in its original bound format, use Message.normalizeCopyToXML() instead.

Returns:

Normalized Message.

Throws:

GException - Thrown if unable to normalize.

normalizeCopyToXML

public Message normalizeCopyToXML()
                           throws GException

Description copied from interface: Message

Normalizes the message to an XML format leaving the original bound object unchanged. All defined message parts are taken from their bound encodings and placed in the message's parts map. The part identified as the content part (see Message.getContentPartName()) will be translated into an XML representation. A new normalized version of the message is returned. In order to leave the original object in tact it must be copied which may be expensive from a performance perspective.

Returns:

Normalized Message.

Throws:

GException - Thrown if unable to normalize.

canNormalize

public boolean canNormalize()

Description copied from interface: Message

Returns whether the message can be normalized or not. Some types of messages may not support normalization.

Returns:

True if can be normalized, false if not.

normalize

public Message normalize()
                  throws GException

Description copied from interface: Message

Normalizes the message. All defined message parts are taken from their bound encodings and placed in the message's parts map. A new normalized version of the message is returned. Due to the possibility of this original object using InputStreams to hold its content, after normalization this object's InputStreams will most likely be exhausted making this object unusable. To continue to use this object after normalization in its original bound format, use Message.normalizeCopyToXML() instead.

Returns:

Normalized Message.

Throws:

GException - Thrown if unable to normalize.

normalizeCopy

public Message normalizeCopy()
                      throws GException

Description copied from interface: Message

Normalizes the message leaving the original bound object unchanged. All defined message parts are taken from their bound encodings and placed in the message's parts map. A new normalized version of the message is returned. In order to leave the original object intact it must be copied which may be expensive from a performance perspective.

Returns:

Normalized Message.

Throws:

GException - Thrown if unable to normalize.

copy

public Message copy()
             throws GException

Description copied from interface: Message

Create a copy of the message. Message normalization state and content are left intact. The returned message will have a copy of the message internal state, including any message properties.

Returns:

A copy of this Message.

Throws:

GException - Thrown if unable to copy.