com.soa.agent

Interface Message

All Known Implementing Classes:

AbstractMessage, SourceMessage, StreamMessage

public interface Message

Interface representing a message that is part of MessageContext.

Method Summary

Modifier and Type	Method and Description
MessageHeader	getMessageHeader(javax.xml.namespace.QName qname) Get a specifig message header
java.util.List<javax.xml.namespace.QName>	getMessageHeaderQNames() Returns a list of all the message headers in the message
java.util.List<MessageHeader>	getMessageHeaders() Get all of the defined message headers in the message
java.lang.Object	getProperty(java.lang.String name) Returns a property with the given name.
java.util.Set<java.lang.String>	getPropertyNames() Returns the names of all the properties of the context.
java.util.Set<java.lang.String>	getSubjectCategories() Returns a Set of known subject category URI's as Strings.
java.util.Map<java.lang.String,javax.security.auth.Subject>	getSubjects() Returns the Map of subjects to be used for the invocation.
java.lang.Object	getTransportProperty(java.lang.String name) Returns a transport property with the given name.
java.util.Set<java.lang.String>	getTransportPropertyNames() Returns the names of all the transport properties of the message.
void	setMessageHeader(MessageHeader header) Set a single message header into the message
void	setMessageHeader(javax.xml.namespace.QName qname, org.w3c.dom.DocumentFragment content) Add a single header to the message from parts
void	setMessageHeaders(java.util.List<MessageHeader> headers) Replace all message headers with a new set.
void	setProperty(java.lang.String name, java.lang.Object o) Changes the property with the given name.
void	setSubjects(java.util.Map<java.lang.String,javax.security.auth.Subject> subjects) Changes the Map of subjects to be used for the invocation.
void	setTransportProperty(java.lang.String name, java.lang.Object o) Changes the transport property with the given name.

Method Detail

getSubjectCategories

java.util.Set<java.lang.String> getSubjectCategories()

Returns a Set of known subject category URI's as Strings.

Returns:

Set of String URI's.

getSubjects

java.util.Map<java.lang.String,javax.security.auth.Subject> getSubjects()

Returns the Map of subjects to be used for the invocation.

Returns:

Map of Subjects keyed by String subject categories.

setSubjects

void setSubjects(java.util.Map<java.lang.String,javax.security.auth.Subject> subjects)

Changes the Map of subjects to be used for the invocation.

Parameters:

subjects - Map of Subjects keyed by String subject categories.

getPropertyNames

java.util.Set<java.lang.String> getPropertyNames()

Returns the names of all the properties of the context.

Returns:

Set of property names.

getProperty

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

Returns a property with the given name.

Parameters:

name - Name of the property being accessed.

Returns:

The property or null if not present.

setProperty

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

Changes the property with the given name.

Parameters:

name - Name of the property being changed.

o - Property value.

getTransportProperty

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

Returns a transport property with the given name.

Parameters:

name - Name of the transport property being accessed.

Returns:

The property or null if not present.

setTransportProperty

void setTransportProperty(java.lang.String name,
                          java.lang.Object o)

Changes the transport property with the given name.

Parameters:

name - Name of the transport property being changed.

o - Property value.

getTransportPropertyNames

java.util.Set<java.lang.String> getTransportPropertyNames()

Returns the names of all the transport properties of the message.

Returns:

Set of property names.

getMessageHeaderQNames

java.util.List<javax.xml.namespace.QName> getMessageHeaderQNames()

Returns a list of all the message headers in the message

Returns:

List of header QNames

getMessageHeaders

java.util.List<MessageHeader> getMessageHeaders()

Get all of the defined message headers in the message

Returns:

List of MessageHeader beans

getMessageHeader

MessageHeader getMessageHeader(javax.xml.namespace.QName qname)

Get a specifig message header

Parameters:

qname - the QName of the desired header

Returns:

MessageHEader bean or null if header not present

setMessageHeader

void setMessageHeader(MessageHeader header)

Set a single message header into the message

Parameters:

header - the MessageHeader bean defining the new header

setMessageHeader

void setMessageHeader(javax.xml.namespace.QName qname,
                      org.w3c.dom.DocumentFragment content)

Add a single header to the message from parts

Parameters:

qname - the QName of the new header

content - the XML definition of the new header as a DocumentFragment

setMessageHeaders

void setMessageHeaders(java.util.List<MessageHeader> headers)

Replace all message headers with a new set.

Parameters:

headers - a List of MessageHEader beans that will replace any existing headers