com.oracle.bpel.client
Class NormalizedMessage

java.lang.Object
com.oracle.bpel.client.NormalizedMessage

All Implemented Interfaces:

java.io.Serializable

public class NormalizedMessage

extends java.lang.Object

implements java.io.Serializable

NormalizedMessage is a simple message bag used as communication between a client and the Orabpel delivery service.

The payload of the message can exist in two formats:

1. a java.util.Map of name/value pairs,
2. a java.lang.String value (this is usually the straight XML of the SOAP body.

Since:

2.0

See Also:

Serialized Form

Field Summary

static java.lang.String	AUDIT_LEVEL
static java.lang.String	COMPLETION_PERSIST_POLICY
static java.lang.String	CONVERSATION_ID
static java.lang.String	CREATOR
static java.lang.String	DEBUG
static java.lang.String	EXPIRATION_DATE
static java.lang.String	INDEX1
static java.lang.String	INDEX2
static java.lang.String	INDEX3
static java.lang.String	METADATA
static java.lang.String	PARENT_ID
static java.lang.String	PRIORITY
static java.lang.String	REPLY_TO_ADDRESS
static java.lang.String	REPLY_TO_PORT_TYPE
static java.lang.String	REPLY_TO_SERVICE
static java.lang.String	ROOT_ID
static java.lang.String	TITLE

Constructor Summary

NormalizedMessage()

Method Summary

void	addPart(java.lang.String partName, org.w3c.dom.Element element) Adds the org.w3c.dom.Element object to the payload for this message.
void	addPart(java.lang.String partName, java.lang.String xml) Adds the specified String to the payload for this message.
boolean	containsProperty(java.lang.String name) Returns true if the message properties contains a property with name specified by name.
java.lang.Object	getAttachments()
QName	getMessageType() Returns the message type for the message payload as defined in the WSDL interface.
java.util.Map	getPayload() Returns the java.util.Map payload for this message.
java.lang.String	getPayloadString() Returns the java.lang.String payload for this message.
java.util.Map	getProperties() Returns the message properties.
java.lang.Object	getProperty(java.lang.String name) Returns the message property with name name.
void	setAttachments(java.lang.Object attachments)
void	setMessageType(QName type) Sets the message type for the message.
void	setPayload(java.util.Map payload) Sets the java.util.Map payload for this message.
void	setPayload(NormalizedMessage nm) Copies the payload of the specified normalized message to this instance.
void	setPayload(java.lang.String payloadStr) Sets the java.lang.String payload for this message.
void	setProperties(java.util.Map properties) Copies all of the properties from the specified map into the properties for this message.
void	setProperty(java.lang.String name, java.lang.Object value) Associates the specified value with the specified key in this message's properties.
java.lang.String	toString() Returns the payload of this message as a String.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONVERSATION_ID

public static final java.lang.String CONVERSATION_ID

See Also:

Configuration.CONVERSATION_ID, Constant Field Values

CREATOR

public static final java.lang.String CREATOR

See Also:

Configuration.CREATOR, Constant Field Values

METADATA

public static final java.lang.String METADATA

See Also:

Configuration.METADATA, Constant Field Values

EXPIRATION_DATE

public static final java.lang.String EXPIRATION_DATE

See Also:

Configuration.EXPIRATION_DATE, Constant Field Values

PRIORITY

public static final java.lang.String PRIORITY

See Also:

Configuration.PRIORITY, Constant Field Values

DEBUG

public static final java.lang.String DEBUG

See Also:

Configuration.DEBUG, Constant Field Values

TITLE

public static final java.lang.String TITLE

See Also:

Configuration.TITLE, Constant Field Values

REPLY_TO_ADDRESS

public static final java.lang.String REPLY_TO_ADDRESS

See Also:

Configuration.REPLY_TO_ADDRESS, Constant Field Values

REPLY_TO_SERVICE

public static final java.lang.String REPLY_TO_SERVICE

See Also:

Configuration.REPLY_TO_SERVICE, Constant Field Values

REPLY_TO_PORT_TYPE

public static final java.lang.String REPLY_TO_PORT_TYPE

See Also:

Configuration.REPLY_TO_PORT_TYPE, Constant Field Values

ROOT_ID

public static final java.lang.String ROOT_ID

See Also:

Configuration.ROOT_ID, Constant Field Values

PARENT_ID

public static final java.lang.String PARENT_ID

See Also:

Configuration.PARENT_ID, Constant Field Values

COMPLETION_PERSIST_POLICY

public static final java.lang.String COMPLETION_PERSIST_POLICY

See Also:

Configuration.COMPLETION_PERSIST_POLICY, Constant Field Values

AUDIT_LEVEL

public static final java.lang.String AUDIT_LEVEL

See Also:

Configuration.AUDIT_LEVEL, Constant Field Values

INDEX1

public static final java.lang.String INDEX1

See Also:

Configuration#INSTANCE_INDEX1, Constant Field Values

INDEX2

public static final java.lang.String INDEX2

See Also:

Constant Field Values

INDEX3

public static final java.lang.String INDEX3

See Also:

Constant Field Values

Constructor Detail

NormalizedMessage

public NormalizedMessage()

Method Detail

getProperties

public java.util.Map getProperties()

Returns the message properties.

setProperties

public void setProperties(java.util.Map properties)

Copies all of the properties from the specified map into the properties for this message.

containsProperty

public boolean containsProperty(java.lang.String name)

Returns true if the message properties contains a property with name specified by name.

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns the message property with name name. If no such property has been set with this message, null is returned.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Associates the specified value with the specified key in this message's properties.

addPart

public void addPart(java.lang.String partName,
                    org.w3c.dom.Element element)

Adds the org.w3c.dom.Element object to the payload for this message.

addPart

public void addPart(java.lang.String partName,
                    java.lang.String xml)

Adds the specified String to the payload for this message.

getPayload

public java.util.Map getPayload()

Returns the java.util.Map payload for this message.

getPayloadString

public java.lang.String getPayloadString()

Returns the java.lang.String payload for this message.

setPayload

public void setPayload(java.lang.String payloadStr)

Sets the java.lang.String payload for this message.

setPayload

public void setPayload(java.util.Map payload)

Sets the java.util.Map payload for this message.

setPayload

public void setPayload(NormalizedMessage nm)

Copies the payload of the specified normalized message to this instance. This is a shallow copy.

Parameters:

nm - the normalized message to copy the payload from

toString

public java.lang.String toString()

Returns the payload of this message as a String.

setMessageType

public void setMessageType(QName type)

Sets the message type for the message.

getMessageType

public QName getMessageType()

Returns the message type for the message payload as defined in the WSDL interface.

setAttachments

public void setAttachments(java.lang.Object attachments)

getAttachments

public java.lang.Object getAttachments()