MessageProperties (Policy Manager API)

All Known Subinterfaces:

PolicyMessageProperties
```
public interface MessageProperties
```
Pre-defined Message properties.

Since:

5.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BINDING_FAULT` The message property value for property FAULT_NAME that indicates that the fault has no name because it is not an application fault but a binding fault.
`static java.lang.String`	`BINDING_FAULT_ID` Deprecated. Fault identifier can be found using `FAULT_CODE`.
`static java.lang.String`	`BINDING_FAULT_MSG` Deprecated. Fault message can be found using `FAULT_STRING`.
`static java.lang.String`	`BINDING_HEADERS` The property that holds the protocol headers if the message is normalized.
`static java.lang.String`	`CONTENT_TYPE` The Message has no standard way to hold a mime content type.
`static java.lang.String`	`FAULT_CODE` The message property that holds the QName of the fault code of a fault.
`static java.lang.String`	`FAULT_NAME` The message property that holds the WSDL name of the fault in a message (String)
`static java.lang.String`	`FAULT_STRING` The message property that holds the string of a fault.
`static java.lang.String`	`FINAL_EXCEPTION` Signal the MultiChoiceHandler to skip other choices
`static java.lang.String`	`HEADERS_SIZE` A Message property that can be used to report the size of the Message headers.
`static java.lang.String`	`MESSAGE_SIZE` A Message property that can be used to report the size of the Message content.
`static java.lang.String`	`PRE_CONFIGURED` Boolean property that, when true, indicates that the message has been pre-configured with binding information (headers and properties).
`static java.lang.String`	`PROTOCOL_TYPE` The Message property that holds the protocol binding type.
`static java.lang.String`	`SECURITY_SUBJECTS` The Message property that holds a Map of all JAAS security subjects associated with the message keyed by subject category (String).
`static java.lang.String`	`TRANSPORT_HEADERS` The Message property that holds the transport headers.
`static java.lang.String`	`TRANSPORT_PARAMETERS` The Message property that holds the incoming transport (form and query) parameters.
`static java.lang.String`	`TRANSPORT_QUERY` The Message property that holds the transport query string, if any.
`static java.lang.String`	`TRANSPORT_QUERY_MAP` The Message property that holds the transport query as a Map, if any.
`static java.lang.String`	`TRANSPORT_STREAM` The Message property that holds the transport stream as an InputStream, if available.

- Field Detail
  - BINDING_FAULT_ID
```
static final java.lang.String BINDING_FAULT_ID
```
    Deprecated. Fault identifier can be found using FAULT_CODE.
    
    Binding specific fault identifier (if any).
    
    See Also:
    
    Constant Field Values
  - BINDING_FAULT_MSG
```
static final java.lang.String BINDING_FAULT_MSG
```
    Deprecated. Fault message can be found using FAULT_STRING.
    
    Binding specific fault message (if any).
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
static final java.lang.String CONTENT_TYPE
```
    The Message has no standard way to hold a mime content type. This property is used to hold the value as a String (with any parameters concatenated if necessary). If this needs to be parsed or manipulated, the HeaderParser class can be used.
    
    See Also:
    
    Constant Field Values
  - TRANSPORT_HEADERS
```
static final java.lang.String TRANSPORT_HEADERS
```
    The Message property that holds the transport headers. The value of the property is an instance of Headers.
    
    See Also:
    
    Constant Field Values
  - TRANSPORT_PARAMETERS
```
static final java.lang.String TRANSPORT_PARAMETERS
```
    The Message property that holds the incoming transport (form and query) parameters. The value of the property is a Map with Strings for keys and a String[] values since parameters may be multi-valued. Note that the value for a parameter may be null. This Map is read-only. Values are not escaped.
    
    See Also:
    
    Constant Field Values
  - BINDING_HEADERS
```
static final java.lang.String BINDING_HEADERS
```
    The property that holds the protocol headers if the message is normalized. The value of the property is a Map but the Map values are protocol-dependant. In the case of SOAP the values are the DocumentFragment containing the SOAP header.
    
    See Also:
    
    Constant Field Values
  - TRANSPORT_QUERY
```
static final java.lang.String TRANSPORT_QUERY
```
    The Message property that holds the transport query string, if any. The value is an ENCODED string which has all special characters escaped as per RFC 2396.
    
    See Also:
    
    Constant Field Values
  - TRANSPORT_QUERY_MAP
```
static final java.lang.String TRANSPORT_QUERY_MAP
```
    The Message property that holds the transport query as a Map, if any. This is only used on the outgoing (client) side. The transport will automatically convert the values in this map to a query string, encode it as appropriate, and append it to the value of TRANSPORT_QUERY, if any.
    
    See Also:
    
    Constant Field Values
  - TRANSPORT_STREAM
```
static final java.lang.String TRANSPORT_STREAM
```
    The Message property that holds the transport stream as an InputStream, if available.
    
    See Also:
    
    Constant Field Values
  - SECURITY_SUBJECTS
```
static final java.lang.String SECURITY_SUBJECTS
```
    The Message property that holds a Map of all JAAS security subjects associated with the message keyed by subject category (String).
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_TYPE
```
static final java.lang.String PROTOCOL_TYPE
```
    The Message property that holds the protocol binding type. The value will be one of the URIs defined in the WSDL 2.0 spec.
    
    See Also:
    
    com.soa.jbi.wsdl.WSDLConstants, Constant Field Values
  - PRE_CONFIGURED
```
static final java.lang.String PRE_CONFIGURED
```
    Boolean property that, when true, indicates that the message has been pre-configured with binding information (headers and properties).
    
    See Also:
    
    Constant Field Values
  - FAULT_NAME
```
static final java.lang.String FAULT_NAME
```
    The message property that holds the WSDL name of the fault in a message (String)
    
    See Also:
    
    Constant Field Values
  - BINDING_FAULT
```
static final java.lang.String BINDING_FAULT
```
    The message property value for property FAULT_NAME that indicates that the fault has no name because it is not an application fault but a binding fault.
    
    See Also:
    
    Constant Field Values
  - FAULT_CODE
```
static final java.lang.String FAULT_CODE
```
    The message property that holds the QName of the fault code of a fault. (QName)
    
    See Also:
    
    Constant Field Values
  - FAULT_STRING
```
static final java.lang.String FAULT_STRING
```
    The message property that holds the string of a fault. (String)
    
    See Also:
    
    Constant Field Values
  - MESSAGE_SIZE
```
static final java.lang.String MESSAGE_SIZE
```
    A Message property that can be used to report the size of the Message content. The size may not have been calculated previously and the property would be null. It is recommended that if a client does calculate the size of the Message, the client set this property so that other clients may benefit from the calculation and save the overhead of recalculation. The value of the property is a Long.
    
    See Also:
    
    Constant Field Values
  - HEADERS_SIZE
```
static final java.lang.String HEADERS_SIZE
```
    A Message property that can be used to report the size of the Message headers. The value of the property is a Long.
    
    See Also:
    
    Constant Field Values
  - FINAL_EXCEPTION
```
static final java.lang.String FINAL_EXCEPTION
```
    Signal the MultiChoiceHandler to skip other choices
    
    See Also:
    
    Constant Field Values

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.

Interface MessageProperties

Field Summary

Field Detail

BINDING_FAULT_ID

BINDING_FAULT_MSG

CONTENT_TYPE

TRANSPORT_HEADERS

TRANSPORT_PARAMETERS

BINDING_HEADERS

TRANSPORT_QUERY

TRANSPORT_QUERY_MAP

TRANSPORT_STREAM

SECURITY_SUBJECTS

PROTOCOL_TYPE

PRE_CONFIGURED

FAULT_NAME

BINDING_FAULT

FAULT_CODE

FAULT_STRING

MESSAGE_SIZE

HEADERS_SIZE

FINAL_EXCEPTION