AbstractMessage (Policy Manager API)

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

All Implemented Interfaces:

Message

Direct Known Subclasses:

SimpleMessage
```
public abstract class AbstractMessage
extends java.lang.Object
implements Message
```
Abstract implementation of Message interface that can be easily extended for specific implementations.

Since:

5.0.

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
`void`	`addAttachment(javax.activation.DataHandler content, Headers headers)` Adds an attachment to the message.
`void`	`addPart(java.lang.String name, java.lang.Object part)` Normalized messages can support multiple parts.
`boolean`	`arePartsEmpty()` Returns whether there are any parts or not (empty) in the message.
`boolean`	`canCarryBindingHeaders()` Returns if the message can carry binding headers.
`void`	`copy(Message from)`
`protected void`	`createAttachments()`
`MessageAttachments`	`getAttachments()` Provides direct access to the attachments for the message.
`java.lang.String`	`getBindingURI()` Returns the URI of the message's binding if the message is bound (not normalized).
`javax.xml.transform.Source`	`getContent()` Returns the content of the message.
`java.lang.String`	`getContentPartName()` When using parts in a message one of those parts can be considered the content of the message (see `Message.getContent()`).
`java.lang.String`	`getContentType()` Returns the type of content of the message, i.e., application/xml, application/json.
`java.lang.String`	`getCorrelationID()` Returns a correlation identifier (if any) that can be used to correlate this message with another.
`java.lang.String`	`getID()` Returns the ID of the message (if any).
`java.lang.Object`	`getPart(java.lang.String name)` Returns the value/content of the part with the given name.
`java.util.Set<java.lang.String>`	`getPartNames()` Returns the names of the parts in the message (if any).
`java.util.Map<java.lang.String,java.lang.Object>`	`getParts()` Returns a map of parts keyed by their name.
`java.util.Map`	`getProperties()` Provides direct access to the Map of properties for the message.
`java.lang.Object`	`getProperty(java.lang.String name)` Returns the property with the given name.
`java.util.Set`	`getPropertyNames()` Returns the names of the properties associated with the message.
`javax.security.auth.Subject`	`getSecuritySubject()` Returns the security subject for the message with the consumer subject category (urn:org:federatedgovernance:security:subject-category:consumer).
`Headers`	`getTransportHeaders()` Returns the transport headers associated with the message (if any).
`java.lang.Object`	`removePart(java.lang.String name)`
`void`	`setAttachments(MessageAttachments attachments)` Replaces the attachments of the message in one call for optimization.
`void`	`setBindingURI(java.lang.String uri)`
`void`	`setContent(javax.xml.transform.Source content)` Changes the message content.
`void`	`setContentPartName(java.lang.String name)` When using parts in a message one of those parts can be considered the content of the message (see `Message.getContent()`).
`void`	`setContentType(java.lang.String contentType)` Changes the type of content of the message, i.e., application/xml, application/json.
`void`	`setCorrelationID(java.lang.String id)` Changes the correlation ID of the message.
`void`	`setID(java.lang.String id)` Changes the ID of the message.
`void`	`setProperties(java.util.Map properties)` Replaces the properties of the message in one call for optimization.
`void`	`setProperty(java.lang.String name, java.lang.Object property)` Associates a property with the message.
`void`	`setSecuritySubject(javax.security.auth.Subject subject)` Changes the security subject for the message with the consumer subject category (urn:org:federatedgovernance:security:subject-category:consumer).
`void`	`setTransportHeaders(Headers headers)` Replaces the set of transport headers associated with the message.

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

Methods inherited from interface com.soa.message.Message
canNormalize, copy, isFault, isNormalized, normalize, normalizeCopy, normalizeCopyToXML, normalizeToXML

- Constructor Detail
  - AbstractMessage
```
public AbstractMessage()
```
- Method Detail
  - getContent
```
public javax.xml.transform.Source getContent()
                                      throws GException
```
    Description copied from interface: Message
    
    Returns the content of the message. WARNING: Do not make changes directly to the returned Source object without calling Message.setContent(Source).
    
    Specified by:
    
    getContent in interface Message
    
    Returns:
    
    Source holding the message content.
    
    Throws:
    
    GException - Thrown if unable to retrieve message content. Possibly caused by badly formed content.
  - setContent
```
public void setContent(javax.xml.transform.Source content)
                throws GException
```
    Description copied from interface: Message
    
    Changes the message content. If normalized either use this method for setting content or Message.addPart(String,Object) if multiple parts are needed. Do not use both methods.
    
    Specified by:
    
    setContent in interface Message
    
    Parameters:
    
    content - Source holding the message content.
    
    Throws:
    
    GException - Thrown if unable to change the content. Possibly caused by passing in badly formed content.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    Description copied from interface: Message
    
    Returns the property with the given name.
    
    Specified by:
    
    getProperty in interface Message
    
    Parameters:
    
    name - Name of the property.
    
    Returns:
    
    Object value of the property, null if not found.
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.Object property)
```
    Description copied from interface: Message
    
    Associates a property with the message.
    
    Specified by:
    
    setProperty in interface Message
    
    Parameters:
    
    name - Name of the property.
    
    property - Value of the property.
  - getPropertyNames
```
public java.util.Set getPropertyNames()
```
    Description copied from interface: Message
    
    Returns the names of the properties associated with the message. Changes made to the Set are reflected in the message, so if a name is removed from the Set, the property is removed from the message. Names cannot be added however.
    
    Specified by:
    
    getPropertyNames in interface Message
    
    Returns:
    
    Set of String property names.
  - getProperties
```
public java.util.Map getProperties()
```
    Description copied from interface: Message
    
    Provides direct access to the Map of properties for the message. Do NOT make changes to the returned Map.
    
    Specified by:
    
    getProperties in interface Message
    
    Returns:
    
    Map of properties keyed by Strings.
  - setProperties
```
public void setProperties(java.util.Map properties)
```
    Description copied from interface: Message
    
    Replaces the properties of the message in one call for optimization.
    
    Specified by:
    
    setProperties in interface Message
    
    Parameters:
    
    properties - Map of properties keyed by a String.
  - getID
```
public java.lang.String getID()
```
    Description copied from interface: Message
    
    Returns the ID of the message (if any). An ID is typically used when the message is part of an asynchronous exchange. It may not be available for synchronous exchanges. If present, the ID will be unique between the producer and consumer of the messsage while the exchange it is part of is active.
    
    Specified by:
    
    getID in interface Message
    
    Returns:
    
    String identifier of the message, null if none available.
  - setID
```
public void setID(java.lang.String id)
```
    Description copied from interface: Message
    
    Changes the ID of the message. The ID will be unique between the producer and consumer of the messsage while the exchange it is part of is active.
    
    Specified by:
    
    setID in interface Message
    
    Parameters:
    
    id - String identifier of the message.
  - getCorrelationID
```
public java.lang.String getCorrelationID()
```
    Description copied from interface: Message
    
    Returns a correlation identifier (if any) that can be used to correlate this message with another. The most common example is for correlating an asynchronous response to a request message. This would be done by using the request message's ID as the response message's correlation ID.
    
    Specified by:
    
    getCorrelationID in interface Message
    
    Returns:
    
    String correlation identifier, null if none available.
  - setCorrelationID
```
public void setCorrelationID(java.lang.String id)
```
    Description copied from interface: Message
    
    Changes the correlation ID of the message. The most common use is for asynchronous messaging. The request message ID would be set as the response message's correlation ID.
    
    Specified by:
    
    setCorrelationID in interface Message
    
    Parameters:
    
    id - String correlation identifier.
  - setSecuritySubject
```
public void setSecuritySubject(javax.security.auth.Subject subject)
```
    Description copied from interface: Message
    
    Changes the security subject for the message with the consumer subject category (urn:org:federatedgovernance:security:subject-category:consumer). The security subject identifies the entity sending the message. This is a convenience method as a Map of all subjects associated with the message can be accessed through the MessageProperties.SECURITY_SUBJECTS property.
    
    Specified by:
    
    setSecuritySubject in interface Message
    
    Parameters:
    
    subject - Subject identifying the application sending the message.
  - getSecuritySubject
```
public javax.security.auth.Subject getSecuritySubject()
```
    Description copied from interface: Message
    
    Returns the security subject for the message with the consumer subject category (urn:org:federatedgovernance:security:subject-category:consumer). The security subject identifies the entity sending the message. This is a convenience method as a Map of all subjects associated with the message can be accessed through the MessageProperties.SECURITY_SUBJECTS property.
    
    Specified by:
    
    getSecuritySubject in interface Message
    
    Returns:
    
    Subject identifying the application sending the message.
  - addAttachment
```
public void addAttachment(javax.activation.DataHandler content,
                          Headers headers)
```
    Description copied from interface: Message
    
    Adds an attachment to the message.
    
    Specified by:
    
    addAttachment in interface Message
    
    Parameters:
    
    content - Content of the attachment.
    
    headers - Any headers that are transported along with the attachment content.
  - setAttachments
```
public void setAttachments(MessageAttachments attachments)
```
    Description copied from interface: Message
    
    Replaces the attachments of the message in one call for optimization.
    
    Specified by:
    
    setAttachments in interface Message
    
    Parameters:
    
    attachments - MessageAttachments instance.
  - getAttachments
```
public MessageAttachments getAttachments()
```
    Description copied from interface: Message
    
    Provides direct access to the attachments for the message.
    
    Specified by:
    
    getAttachments in interface Message
    
    Returns:
    
    MessageAttachments, will be null if there are no attachments for this message.
  - getTransportHeaders
```
public Headers getTransportHeaders()
```
    Description copied from interface: Message
    
    Returns the transport headers associated with the message (if any). This is a convenience method as the same headers can be accessed through the MessageProperties.TRANSPORT_HEADERS property.
    
    Specified by:
    
    getTransportHeaders in interface Message
    
    Returns:
    
    Headers holding transport headers for the message, null if none present.
  - setTransportHeaders
```
public void setTransportHeaders(Headers headers)
```
    Description copied from interface: Message
    
    Replaces the set of transport headers associated with the message. This is a convenience method as the same headers can be accessed through the MessageProperties.TRANSPORT_HEADERS property.
    
    Specified by:
    
    setTransportHeaders in interface Message
    
    Parameters:
    
    headers - Headers holding transport headers for the message.
  - canCarryBindingHeaders
```
public boolean canCarryBindingHeaders()
```
    Description copied from interface: Message
    
    Returns if the message can carry binding headers. Some types of messages are sent using protocols that don't support binding headers. Indicating that can save processing time during mediation.
    
    Specified by:
    
    canCarryBindingHeaders in interface Message
    
    Returns:
    
    true if binding headers may be use, false if not.
  - setBindingURI
```
public void setBindingURI(java.lang.String uri)
```
  - getBindingURI
```
public java.lang.String getBindingURI()
```
    Description copied from interface: Message
    
    Returns the URI of the message's binding if the message is bound (not normalized).
    
    Specified by:
    
    getBindingURI in interface Message
    
    Returns:
    
    String URI of the message's binding, null if normalized.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Description copied from interface: Message
    
    Changes the type of content of the message, i.e., application/xml, application/json. This must match what is returned in Message.getContent().
    
    Specified by:
    
    setContentType in interface Message
    
    Parameters:
    
    contentType - Type of message content.
  - getContentType
```
public java.lang.String getContentType()
```
    Description copied from interface: Message
    
    Returns the type of content of the message, i.e., application/xml, application/json.
    
    Specified by:
    
    getContentType in interface Message
    
    Returns:
    
    Type of message content.
  - addPart
```
public void addPart(java.lang.String name,
                    java.lang.Object part)
```
    Description copied from interface: Message
    
    Normalized messages can support multiple parts. A part is synonymous with a message part as defined in the WSDL 1.1 spec, it is a named piece of content. The parts of a normalized message can then be encoded in a protocol specific way by a binding, i.e., query parameters, path parameteters, headers, or RPC encoded XML elements. If the message is not normalized there will be no parts. Use Message.getContent() to get the content of the message. If the message is normalized there may be content accessed using Message.getContent() instead of parts.
    
    Specified by:
    
    addPart in interface Message
    
    Parameters:
    
    name - Name of the part, should correspond to a WSDL definend message part.
    
    part - Value/content of the part. Typically a part should be an XML element that corresponds to what is defined in the WSDL definition. A part could be something other than that but unless the consumer of the message can read the content it will fail.
  - getPart
```
public java.lang.Object getPart(java.lang.String name)
```
    Description copied from interface: Message
    
    Returns the value/content of the part with the given name.
    
    Specified by:
    
    getPart in interface Message
    
    Parameters:
    
    name - Name of the part.
    
    Returns:
    
    Value/content of the part.
  - removePart
```
public java.lang.Object removePart(java.lang.String name)
```
  - getPartNames
```
public java.util.Set<java.lang.String> getPartNames()
```
    Description copied from interface: Message
    
    Returns the names of the parts in the message (if any).
    
    Specified by:
    
    getPartNames in interface Message
    
    Returns:
    
    Set of part names. The set is mutable so changes to the set will be reflected in the message.
  - arePartsEmpty
```
public boolean arePartsEmpty()
```
    Description copied from interface: Message
    
    Returns whether there are any parts or not (empty) in the message. If there are no parts there is likely content returned in Message.getContent().
    
    Specified by:
    
    arePartsEmpty in interface Message
    
    Returns:
    
    true if no parts in message, false if there are.
  - getParts
```
public java.util.Map<java.lang.String,java.lang.Object> getParts()
```
    Description copied from interface: Message
    
    Returns a map of parts keyed by their name.
    
    Specified by:
    
    getParts in interface Message
    
    Returns:
    
    Map of parts keyed by their name. The map is muutable so any changes will be reflected in the message. If there are no parts defined null will be returned.
  - setContentPartName
```
public void setContentPartName(java.lang.String name)
```
    Description copied from interface: Message
    
    When using parts in a message one of those parts can be considered the content of the message (see Message.getContent()). This method can be used to specify the name of the part that should be considered the message content.
    
    Specified by:
    
    setContentPartName in interface Message
    
    Parameters:
    
    name - Name of the part holding the message content.
  - getContentPartName
```
public java.lang.String getContentPartName()
```
    Description copied from interface: Message
    
    When using parts in a message one of those parts can be considered the content of the message (see Message.getContent()). This method will return the name of the part that holds the content.
    
    Specified by:
    
    getContentPartName in interface Message
    
    Returns:
    
    Part name holding the message content.
  - createAttachments
```
protected void createAttachments()
```
  - copy
```
public void copy(Message from)
```

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

Methods inherited from interface com.soa.message.Message

Constructor Detail

AbstractMessage

Method Detail

getContent

setContent

getProperty

setProperty

getPropertyNames

getProperties

setProperties

getID

setID

getCorrelationID

setCorrelationID

setSecuritySubject

getSecuritySubject

addAttachment

setAttachments

getAttachments

getTransportHeaders

setTransportHeaders

canCarryBindingHeaders

setBindingURI

getBindingURI

setContentType

getContentType

addPart

getPart

removePart

getPartNames

arePartsEmpty

getParts

setContentPartName

getContentPartName

createAttachments

copy