oracle.soa.api.message

Interface Message

All Superinterfaces:

java.io.Serializable

public interface Message
extends java.io.Serializable

Abstract message representation, the default implementation is an XML based message, that can be created via XMLMessageFactory.getInstance().createMessage

  // create a std dom parser
  DOMParser parser = new DOMParser();
  parser.parse(new InputSource(new StringReader(xml)));
 
  Element element = parser.getDocument().getDocumentElement();
  Map <String, Element> payload = new HashMap<String, Element>();
  payload.put(<payload part name>, element);
  Message<Element> xmlMessage = 
       XMLMessageFactory.getInstance().createMessage(payload);
 

Method Summary

Modifier and Type	Method and Description
void	addAttachment(Attachment attachment) Adds a message attachment
void	addHeader(org.w3c.dom.Element header) Adds a protocol header to the message
java.util.List	getAttachments() Gets the message attachments
java.util.List	getHeaders() Gets the protocol headers
Payload	getPayload() Gets the message payload
java.util.Map	getProperties() Gets the message properties
java.lang.Object	getProperty(java.lang.String name) Gets the specified message property value
void	setHeaders(java.util.List headers) Replaces the current set of protocol headers with the specified set
void	setPayload(Payload payload) Specifies the payload associated with the message
void	setProperties(java.util.Map properties) Replaces all existing properties on the message with the specified set
void	setProperty(java.lang.String name, java.lang.Object value) Sets a specific property on the message

Method Detail

addAttachment

void addAttachment(Attachment attachment)

Adds a message attachment

Parameters:

attachment - an attachment

addHeader

void addHeader(org.w3c.dom.Element header)

Adds a protocol header to the message

Parameters:

header - the header

getAttachments

java.util.List getAttachments()

Gets the message attachments

Returns:

The message attachments

getHeaders

java.util.List getHeaders()

Gets the protocol headers

Returns:

The protocol headers

getPayload

Payload getPayload()

Gets the message payload

Returns:

The message payload

getProperties

java.util.Map getProperties()

Gets the message properties

Returns:

The message properties

getProperty

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

Gets the specified message property value

Parameters:

name - the property name

Returns:

The value of the specified property

setHeaders

void setHeaders(java.util.List headers)

Replaces the current set of protocol headers with the specified set

Parameters:

headers - the replacement headers

setPayload

void setPayload(Payload payload)

Specifies the payload associated with the message

Parameters:

payload - the payload of the message.

setProperties

void setProperties(java.util.Map properties)

Replaces all existing properties on the message with the specified set

Parameters:

properties - the replacement properties

setProperty

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

Sets a specific property on the message

Parameters:

name - the name of the property

value - the value of the named property