Exchange (Policy Manager API)

All Known Implementing Classes:

AbstractExchange, SimpleExchange, SOAPExchange
```
public interface Exchange
```
Properties about the current message exchange. The context consists of the operation the message is invoking and optional properties that can be read and altered by message handlers. In contrast to Message properties which are only available while processing one message, the properties of the ExchangeContext are present for the duration of the exchange, which includes the processing of an input message and a corresponding output or fault message (if any).

Since:

5.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIVE` Status code indicating the exchange is still active.
`static int`	`DONE` Status code indicating the exchange is completed.
`static int`	`ERROR` Status code indicating the exchange has encountered an error.
`static java.net.URI`	`IN_ONLY` URI pattern for an in-only exchange.
`static java.net.URI`	`IN_OPTIONAL_OUT` URI pattern for an in-out exchange.
`static java.net.URI`	`IN_OUT` URI pattern for an in-out exchange.
`static java.net.URI`	`OUT_ONLY` URI pattern for an in-out exchange.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearMessage(ParameterType pType)` Removes a message from the exchange.
`Message`	`createMessage(ParameterType pType)` Associates a message with the exchange.
`ContextLogger`	`getAuditLogger()` Provides audit logging capabilities.
`java.lang.String`	`getBinding()` Returns a URI identifying the type of binding used in the exchange.
`Endpoint`	`getEndpoint()` Returns the Endpoint called in the exchange if known.
`java.lang.String`	`getEndpointName()` Returns the name of the endpoint being called.
`java.lang.Exception`	`getError()` Returns the error associated with the exchange (if any).
`java.lang.String`	`getExchangeID()` Returns a unique identifier for the exchange between the two parties.
`ExternalEndpoint`	`getFaultEndpoint()` External endpoint to send a fault to if an asynchronous exchange.
`Message`	`getFaultMessage()` Returns the fault message that is part of the exchange (if any).
`Message`	`getInMessage()` Returns the in message that is part of the exchange (if any).
`javax.xml.namespace.QName`	`getInterfaceName()` Returns the name of the interface being called.
`java.lang.String`	`getOperationName()` Returns the name of the operation being invoked.
`Message`	`getOutMessage()` Returns the out message that is part of the exchange (if any).
`java.net.URI`	`getPattern()` Returns the message exchange pattern to be used.
`java.util.Map`	`getProperties()` Provides direct access to the Map of properties for the exchange.
`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 context.
`ExternalEndpoint`	`getResponseEndpoint()` External endpoint to send the response to if an asynchronous exchange.
`javax.xml.namespace.QName`	`getServiceName()` Returns the name of the service being invoked.
`int`	`getStatus()` Returns the status of the exchange (ACTIVE, DONE, ERROR).
`boolean`	`isAsync()` Returns whether the exchange should be completed asynchronously or not.
`void`	`setAsync(boolean isAsync)` Changes whether the exchange should be completed asynchronously or not.
`void`	`setAuditLogger(ContextLogger logger)` Associates an audit logger with the exchange.
`void`	`setBinding(java.lang.String binding)` Changes the URI identifying the type of binding used in the exchange.
`void`	`setEndpoint(Endpoint endpoint)` Changes the Endpoint being called.
`void`	`setEndpointName(java.lang.String epName)` Changes the name of the endpoint in the exchange.
`void`	`setError(java.lang.Exception error)` Records an error encountered while processing the exchange.
`void`	`setFaultEndpoint(ExternalEndpoint endpoint)` Changes the external endpoint to send a fault if an asynchronous exchange.
`void`	`setInterfaceName(javax.xml.namespace.QName ifName)` Changes the name of the interface being called.
`void`	`setMessage(Message msg, ParameterType pType)` Places a message in the exchange as the given parameter type, IN, OUT, or FAULT.
`void`	`setOperationName(java.lang.String operationName)` Changes the name of the operation in the context.
`void`	`setPattern(java.net.URI pattern)` Changes the message exchange pattern to be used.
`void`	`setProperties(java.util.Map properties)` Replaces the properties of the exchange in one call for optimization.
`void`	`setProperty(java.lang.String name, java.lang.Object property)` Adds or replaces a property.
`void`	`setResponseEndpoint(ExternalEndpoint endpoint)` Changes the external endpoint to send the response if an asynchronous exchange.
`void`	`setServiceName(javax.xml.namespace.QName serviceName)` Changes the name of the service in the context.
`void`	`setStatus(int status)` Changes the status of the exchange.

- Field Detail
  - ACTIVE
```
static final int ACTIVE
```
    Status code indicating the exchange is still active.
    
    See Also:
    
    Constant Field Values
  - DONE
```
static final int DONE
```
    Status code indicating the exchange is completed.
    
    See Also:
    
    Constant Field Values
  - ERROR
```
static final int ERROR
```
    Status code indicating the exchange has encountered an error.
    
    See Also:
    
    Constant Field Values
  - IN_ONLY
```
static final java.net.URI IN_ONLY
```
    URI pattern for an in-only exchange.
  - IN_OUT
```
static final java.net.URI IN_OUT
```
    URI pattern for an in-out exchange.
  - OUT_ONLY
```
static final java.net.URI OUT_ONLY
```
    URI pattern for an in-out exchange.
  - IN_OPTIONAL_OUT
```
static final java.net.URI IN_OPTIONAL_OUT
```
    URI pattern for an in-out exchange.
- Method Detail
  - getExchangeID
```
java.lang.String getExchangeID()
```
    Returns a unique identifier for the exchange between the two parties.
    
    Returns:
    
    Unique identifier of the exchange.
  - getProperty
```
java.lang.Object getProperty(java.lang.String name)
```
    Returns the property with the given name.
    
    Parameters:
    
    name - Name of the property.
    
    Returns:
    
    Object holding the value of the requested property, null if none found.
  - setProperty
```
void setProperty(java.lang.String name,
                 java.lang.Object property)
```
    Adds or replaces a property.
    
    Parameters:
    
    name - Name of the property.
    
    property - Value of the property.
  - getPropertyNames
```
java.util.Set getPropertyNames()
```
    Returns the names of the properties associated with the context. Changes made to the Set are reflected in the context, so if a name is removed from the Set, the property is removed from the context. Names cannot be added however.
    
    Returns:
    
    Set of String property names.
  - getProperties
```
java.util.Map getProperties()
```
    Provides direct access to the Map of properties for the exchange.
    
    Returns:
    
    Map of properties keyed by Strings.
  - setProperties
```
void setProperties(java.util.Map properties)
```
    Replaces the properties of the exchange in one call for optimization.
    
    Parameters:
    
    properties - Map of properties keyed by a String.
  - getServiceName
```
javax.xml.namespace.QName getServiceName()
```
    Returns the name of the service being invoked.
    
    Returns:
    
    QName of the service.
  - setServiceName
```
void setServiceName(javax.xml.namespace.QName serviceName)
```
    Changes the name of the service in the context.
    
    Parameters:
    
    serviceName - Name of the service.
  - getEndpointName
```
java.lang.String getEndpointName()
```
    Returns the name of the endpoint being called.
    
    Returns:
    
    Name of the endpoint.
  - getEndpoint
```
Endpoint getEndpoint()
```
    Returns the Endpoint called in the exchange if known.
    
    Returns:
    
    Endpoint object holding all the endpoint information, null if not known.
  - setEndpointName
```
void setEndpointName(java.lang.String epName)
```
    Changes the name of the endpoint in the exchange.
    
    Parameters:
    
    epName - Name of the endpoint.
  - setEndpoint
```
void setEndpoint(Endpoint endpoint)
```
    Changes the Endpoint being called.
    
    Parameters:
    
    endpoint - Endpoint holding the endpoint information.
  - getBinding
```
java.lang.String getBinding()
```
    Returns a URI identifying the type of binding used in the exchange. This is typically the namespace of the WSDL binding extension.
    
    Returns:
    
    String URI of the binding type. May be null.
  - setBinding
```
void setBinding(java.lang.String binding)
```
    Changes the URI identifying the type of binding used in the exchange. This is typically the namespace of the WSDL binding extension.
    
    Parameters:
    
    binding - String URI of the binding type. May be null.
  - getInterfaceName
```
javax.xml.namespace.QName getInterfaceName()
```
    Returns the name of the interface being called.
    
    Returns:
    
    Name of the interface.
  - setInterfaceName
```
void setInterfaceName(javax.xml.namespace.QName ifName)
```
    Changes the name of the interface being called.
    
    Parameters:
    
    ifName - Name of the interface.
  - getOperationName
```
java.lang.String getOperationName()
```
    Returns the name of the operation being invoked.
    
    Returns:
    
    Name of the operation.
  - setOperationName
```
void setOperationName(java.lang.String operationName)
```
    Changes the name of the operation in the context.
    
    Parameters:
    
    operationName - Name of the operation.
  - getStatus
```
int getStatus()
```
    Returns the status of the exchange (ACTIVE, DONE, ERROR).
    
    Returns:
    
    Status of the exchange (ACTIVE, DONE, ERROR).
  - setStatus
```
void setStatus(int status)
```
    Changes the status of the exchange.
    
    Parameters:
    
    status - Status of the exchange (ACTIVE, DONE, ERROR).
  - setError
```
void setError(java.lang.Exception error)
```
    Records an error encountered while processing the exchange.
    
    Parameters:
    
    error - Error holding the error information.
  - getError
```
java.lang.Exception getError()
```
    Returns the error associated with the exchange (if any).
    
    Returns:
    
    Error holding the error details, null if none occured.
  - getInMessage
```
Message getInMessage()
```
    Returns the in message that is part of the exchange (if any).
    
    Returns:
    
    Message holding information about the message, null if none associated with the exchange.
  - getOutMessage
```
Message getOutMessage()
```
    Returns the out message that is part of the exchange (if any).
    
    Returns:
    
    Message holding information about the message, null if none associated with the exchange.
  - getFaultMessage
```
Message getFaultMessage()
```
    Returns the fault message that is part of the exchange (if any).
    
    Returns:
    
    Message holding information about the message, null if none associated with the exchange.
  - createMessage
```
Message createMessage(ParameterType pType)
               throws GException
```
    Associates a message with the exchange.
    
    Parameters:
    
    pType - ParameterType identifying whether the message is an IN, OUT, or FAULT.
    
    Returns:
    
    Message representing the message.
    
    Throws:
    
    GException
  - clearMessage
```
void clearMessage(ParameterType pType)
           throws GException
```
    Removes a message from the exchange.
    
    Parameters:
    
    pType - ParameterType identifying the message to remove, IN, OUT, or FAULT.
    
    Throws:
    
    GException - Thrown if an error prevents the removal.
  - setMessage
```
void setMessage(Message msg,
                ParameterType pType)
         throws GException
```
    Places a message in the exchange as the given parameter type, IN, OUT, or FAULT. Some Exchange implementations can only support matching Message implementations, or instances created from the Exchange itself. For that reason this is an optional method. Not all implementations will support this method. If they do not an UnsupportedOperationException will be thrown.
    
    Parameters:
    
    msg - Message to be added to the Exchange.
    
    pType - ParameterType identifying whether the message is an IN, OUT, or FAULT.
    
    Throws:
    
    GException
  - getPattern
```
java.net.URI getPattern()
```
    Returns the message exchange pattern to be used.
    
    Returns:
    
    Message exchange pattern to be used, i.e., IN_OUT, IN_ONLY.
  - setPattern
```
void setPattern(java.net.URI pattern)
```
    Changes the message exchange pattern to be used.
    
    Parameters:
    
    pattern - Message exchange pattern to be used, i.e., IN_OUT, IN_ONLY.
  - isAsync
```
boolean isAsync()
```
    Returns whether the exchange should be completed asynchronously or not.
    
    Returns:
    
    True if asynchronous, false if synchronous.
  - setAsync
```
void setAsync(boolean isAsync)
```
    Changes whether the exchange should be completed asynchronously or not.
    
    Parameters:
    
    isAsync - True if asynchronous, false if synchronous.
  - getResponseEndpoint
```
ExternalEndpoint getResponseEndpoint()
```
    External endpoint to send the response to if an asynchronous exchange.
    
    Returns:
    
    ExternalEndpoint holding endpoint information, null if none available.
  - setResponseEndpoint
```
void setResponseEndpoint(ExternalEndpoint endpoint)
```
    Changes the external endpoint to send the response if an asynchronous exchange.
    
    Parameters:
    
    endpoint - ExternalEndpoint to send asynchronous responses.
  - getFaultEndpoint
```
ExternalEndpoint getFaultEndpoint()
```
    External endpoint to send a fault to if an asynchronous exchange.
    
    Returns:
    
    ExternalEndpoint holding endpoint information, null if none available.
  - setFaultEndpoint
```
void setFaultEndpoint(ExternalEndpoint endpoint)
```
    Changes the external endpoint to send a fault if an asynchronous exchange.
    
    Parameters:
    
    endpoint - ExternalEndpoint to send asynchronous responses.
  - getAuditLogger
```
ContextLogger getAuditLogger()
```
    Provides audit logging capabilities. This is different than the system logging capabilities provided by com.soa.log.ContextLogger. The audit log statements are governed by and viewed in the management application. Each log statement has a different level of importance or purpose, debug, warning, or error in that order. These statements will only be seen in the log if the handler is invoked with a level equal to or greater than that statement.
    
    Returns:
    
    Logger.
  - setAuditLogger
```
void setAuditLogger(ContextLogger logger)
```
    Associates an audit logger with the exchange.
    
    Parameters:
    
    logger - Logger.

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 Exchange

Field Summary

Method Summary

Field Detail

ACTIVE

DONE

ERROR

IN_ONLY

IN_OUT

OUT_ONLY

IN_OPTIONAL_OUT

Method Detail

getExchangeID

getProperty

setProperty

getPropertyNames

getProperties

setProperties

getServiceName

setServiceName

getEndpointName

getEndpoint

setEndpointName

setEndpoint

getBinding

setBinding

getInterfaceName

setInterfaceName

getOperationName

setOperationName

getStatus

setStatus

setError

getError

getInMessage

getOutMessage

getFaultMessage

createMessage

clearMessage

setMessage

getPattern

setPattern

isAsync

setAsync

getResponseEndpoint

setResponseEndpoint

getFaultEndpoint

setFaultEndpoint

getAuditLogger

setAuditLogger