AbstractMessage (Policy Manager API)

java.lang.Object
- com.soa.agent.AbstractMessage

All Implemented Interfaces:

Message

Direct Known Subclasses:

SourceMessage, StreamMessage
```
public abstract class AbstractMessage
extends java.lang.Object
implements Message
```

Constructor Summary

Constructors
Constructor and Description

AbstractMessage()

Constructors
Constructor and Description
`AbstractMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageHeader`	`getMessageHeader(javax.xml.namespace.QName qname)` Get a specifig message header
`MessageHeader`	`getMessageHeader(java.lang.String qname)`
`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
`protected void`	`setMessageHeader(java.lang.String qname, org.w3c.dom.DocumentFragment content)`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractMessage
```
public AbstractMessage()
```
- Method Detail
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    Description copied from interface: Message
    
    Returns a property with the given name.
    
    Specified by:
    
    getProperty in interface Message
    
    Parameters:
    
    name - Name of the property being accessed.
    
    Returns:
    
    The property or null if not present.
  - getPropertyNames
```
public java.util.Set<java.lang.String> getPropertyNames()
```
    Description copied from interface: Message
    
    Returns the names of all the properties of the context.
    
    Specified by:
    
    getPropertyNames in interface Message
    
    Returns:
    
    Set of property names.
  - getSubjectCategories
```
public java.util.Set<java.lang.String> getSubjectCategories()
```
    Description copied from interface: Message
    
    Returns a Set of known subject category URI's as Strings.
    
    Specified by:
    
    getSubjectCategories in interface Message
    
    Returns:
    
    Set of String URI's.
  - getSubjects
```
public java.util.Map<java.lang.String,javax.security.auth.Subject> getSubjects()
```
    Description copied from interface: Message
    
    Returns the Map of subjects to be used for the invocation.
    
    Specified by:
    
    getSubjects in interface Message
    
    Returns:
    
    Map of Subjects keyed by String subject categories.
  - getTransportProperty
```
public java.lang.Object getTransportProperty(java.lang.String name)
```
    Description copied from interface: Message
    
    Returns a transport property with the given name.
    
    Specified by:
    
    getTransportProperty in interface Message
    
    Parameters:
    
    name - Name of the transport property being accessed.
    
    Returns:
    
    The property or null if not present.
  - getTransportPropertyNames
```
public java.util.Set<java.lang.String> getTransportPropertyNames()
```
    Description copied from interface: Message
    
    Returns the names of all the transport properties of the message.
    
    Specified by:
    
    getTransportPropertyNames in interface Message
    
    Returns:
    
    Set of property names.
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.Object o)
```
    Description copied from interface: Message
    
    Changes the property with the given name.
    
    Specified by:
    
    setProperty in interface Message
    
    Parameters:
    
    name - Name of the property being changed.
    
    o - Property value.
  - setSubjects
```
public void setSubjects(java.util.Map<java.lang.String,javax.security.auth.Subject> subjects)
```
    Description copied from interface: Message
    
    Changes the Map of subjects to be used for the invocation.
    
    Specified by:
    
    setSubjects in interface Message
    
    Parameters:
    
    subjects - Map of Subjects keyed by String subject categories.
  - setTransportProperty
```
public void setTransportProperty(java.lang.String name,
                                 java.lang.Object o)
```
    Description copied from interface: Message
    
    Changes the transport property with the given name.
    
    Specified by:
    
    setTransportProperty in interface Message
    
    Parameters:
    
    name - Name of the transport property being changed.
    
    o - Property value.
  - setMessageHeader
```
public void setMessageHeader(MessageHeader header)
```
    Description copied from interface: Message
    
    Set a single message header into the message
    
    Specified by:
    
    setMessageHeader in interface Message
    
    Parameters:
    
    header - the MessageHeader bean defining the new header
  - setMessageHeader
```
public void setMessageHeader(javax.xml.namespace.QName qname,
                             org.w3c.dom.DocumentFragment content)
```
    Description copied from interface: Message
    
    Add a single header to the message from parts
    
    Specified by:
    
    setMessageHeader in interface Message
    
    Parameters:
    
    qname - the QName of the new header
    
    content - the XML definition of the new header as a DocumentFragment
  - setMessageHeader
```
protected void setMessageHeader(java.lang.String qname,
                                org.w3c.dom.DocumentFragment content)
```
  - setMessageHeaders
```
public void setMessageHeaders(java.util.List<MessageHeader> headers)
```
    Description copied from interface: Message
    
    Replace all message headers with a new set.
    
    Specified by:
    
    setMessageHeaders in interface Message
    
    Parameters:
    
    headers - a List of MessageHEader beans that will replace any existing headers
  - getMessageHeader
```
public MessageHeader getMessageHeader(javax.xml.namespace.QName qname)
```
    Description copied from interface: Message
    
    Get a specifig message header
    
    Specified by:
    
    getMessageHeader in interface Message
    
    Parameters:
    
    qname - the QName of the desired header
    
    Returns:
    
    MessageHEader bean or null if header not present
  - getMessageHeader
```
public MessageHeader getMessageHeader(java.lang.String qname)
```
  - getMessageHeaders
```
public java.util.List<MessageHeader> getMessageHeaders()
```
    Description copied from interface: Message
    
    Get all of the defined message headers in the message
    
    Specified by:
    
    getMessageHeaders in interface Message
    
    Returns:
    
    List of MessageHeader beans
  - getMessageHeaderQNames
```
public java.util.List<javax.xml.namespace.QName> getMessageHeaderQNames()
```
    Description copied from interface: Message
    
    Returns a list of all the message headers in the message
    
    Specified by:
    
    getMessageHeaderQNames in interface Message
    
    Returns:
    
    List of header QNames

This software is the confidential and proprietary information of Perforce, Inc. and is subject to copyright protection under laws of the United States of America and other countries. The use of this software should be in accordance with the license agreement terms you entered into with Perforce, Inc.

Class AbstractMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractMessage

Method Detail

getProperty

getPropertyNames

getSubjectCategories

getSubjects

getTransportProperty

getTransportPropertyNames

setProperty

setSubjects

setTransportProperty

setMessageHeader

setMessageHeader

setMessageHeader

setMessageHeaders

getMessageHeader

getMessageHeader

getMessageHeaders

getMessageHeaderQNames