AbstractExchange (Policy Manager API)

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

All Implemented Interfaces:

Exchange

Direct Known Subclasses:

SimpleExchange, SOAPExchange
```
public abstract class AbstractExchange
extends java.lang.Object
implements Exchange
```
Abstract implementation of the Exchange interface that can be easily extended for specific implementations.

Since:

5.0

Field Summary
- Fields inherited from interface com.soa.message.Exchange
  ACTIVE, DONE, ERROR, IN_ONLY, IN_OPTIONAL_OUT, IN_OUT, OUT_ONLY

Constructor Summary

Constructors
Constructor and Description

AbstractExchange()

Constructors
Constructor and Description
`AbstractExchange()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPart(java.lang.String name, java.lang.Object part)`
`boolean`	`arePartsEmpty()`
`void`	`clearMessage(ParameterType pType)` Removes a message from the exchange.
`protected abstract Message`	`createMessage()`
`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).
`void`	`getPart(java.lang.String name)`
`java.util.Set<java.lang.String>`	`getPartNames()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getParts()`
`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`	`setExchangeID(java.lang.String id)` Initializes the ID of the exchange.
`void`	`setFaultEndpoint(ExternalEndpoint endpoint)` Changes the external endpoint to send a fault if an asynchronous exchange.
`protected void`	`setFaultMessage(Message msg)`
`protected void`	`setInMessage(Message msg)`
`void`	`setInterfaceName(javax.xml.namespace.QName ifName)` Changes the name of the interface being called.
`void`	`setMessage(Message msg, ParameterType pType)` Default implementation throws `UnsupportedOperationException`.
`protected void`	`setMessageImpl(Message msg, ParameterType pType)`
`void`	`setOperationName(java.lang.String operationName)` Changes the name of the operation in the context.
`protected void`	`setOutMessage(Message msg)`
`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.

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

- Constructor Detail
  - AbstractExchange
```
public AbstractExchange()
```
- Method Detail
  - getExchangeID
```
public java.lang.String getExchangeID()
```
    Description copied from interface: Exchange
    
    Returns a unique identifier for the exchange between the two parties.
    
    Specified by:
    
    getExchangeID in interface Exchange
    
    Returns:
    
    Unique identifier of the exchange.
  - setExchangeID
```
public void setExchangeID(java.lang.String id)
```
    Initializes the ID of the exchange.
    
    Parameters:
    
    id - String ID of the exchange.
  - getServiceName
```
public javax.xml.namespace.QName getServiceName()
```
    Description copied from interface: Exchange
    
    Returns the name of the service being invoked.
    
    Specified by:
    
    getServiceName in interface Exchange
    
    Returns:
    
    QName of the service.
  - setServiceName
```
public void setServiceName(javax.xml.namespace.QName serviceName)
```
    Description copied from interface: Exchange
    
    Changes the name of the service in the context.
    
    Specified by:
    
    setServiceName in interface Exchange
    
    Parameters:
    
    serviceName - Name of the service.
  - getBinding
```
public java.lang.String getBinding()
```
    Description copied from interface: Exchange
    
    Returns a URI identifying the type of binding used in the exchange. This is typically the namespace of the WSDL binding extension.
    
    Specified by:
    
    getBinding in interface Exchange
    
    Returns:
    
    String URI of the binding type. May be null.
  - setBinding
```
public void setBinding(java.lang.String binding)
```
    Description copied from interface: Exchange
    
    Changes the URI identifying the type of binding used in the exchange. This is typically the namespace of the WSDL binding extension.
    
    Specified by:
    
    setBinding in interface Exchange
    
    Parameters:
    
    binding - String URI of the binding type. May be null.
  - getEndpointName
```
public java.lang.String getEndpointName()
```
    Description copied from interface: Exchange
    
    Returns the name of the endpoint being called.
    
    Specified by:
    
    getEndpointName in interface Exchange
    
    Returns:
    
    Name of the endpoint.
  - getEndpoint
```
public Endpoint getEndpoint()
```
    Description copied from interface: Exchange
    
    Returns the Endpoint called in the exchange if known.
    
    Specified by:
    
    getEndpoint in interface Exchange
    
    Returns:
    
    Endpoint object holding all the endpoint information, null if not known.
  - setEndpointName
```
public void setEndpointName(java.lang.String epName)
```
    Description copied from interface: Exchange
    
    Changes the name of the endpoint in the exchange.
    
    Specified by:
    
    setEndpointName in interface Exchange
    
    Parameters:
    
    epName - Name of the endpoint.
  - setEndpoint
```
public void setEndpoint(Endpoint endpoint)
```
    Description copied from interface: Exchange
    
    Changes the Endpoint being called.
    
    Specified by:
    
    setEndpoint in interface Exchange
    
    Parameters:
    
    endpoint - Endpoint holding the endpoint information.
  - getInterfaceName
```
public javax.xml.namespace.QName getInterfaceName()
```
    Description copied from interface: Exchange
    
    Returns the name of the interface being called.
    
    Specified by:
    
    getInterfaceName in interface Exchange
    
    Returns:
    
    Name of the interface.
  - setInterfaceName
```
public void setInterfaceName(javax.xml.namespace.QName ifName)
```
    Description copied from interface: Exchange
    
    Changes the name of the interface being called.
    
    Specified by:
    
    setInterfaceName in interface Exchange
    
    Parameters:
    
    ifName - Name of the interface.
  - getOperationName
```
public java.lang.String getOperationName()
```
    Description copied from interface: Exchange
    
    Returns the name of the operation being invoked.
    
    Specified by:
    
    getOperationName in interface Exchange
    
    Returns:
    
    Name of the operation.
  - setOperationName
```
public void setOperationName(java.lang.String operationName)
```
    Description copied from interface: Exchange
    
    Changes the name of the operation in the context.
    
    Specified by:
    
    setOperationName in interface Exchange
    
    Parameters:
    
    operationName - Name of the operation.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    Description copied from interface: Exchange
    
    Returns the property with the given name.
    
    Specified by:
    
    getProperty in interface Exchange
    
    Parameters:
    
    name - Name of the property.
    
    Returns:
    
    Object holding the value of the requested property, null if none found.
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.Object property)
```
    Description copied from interface: Exchange
    
    Adds or replaces a property.
    
    Specified by:
    
    setProperty in interface Exchange
    
    Parameters:
    
    name - Name of the property.
    
    property - Value of the property.
  - getPropertyNames
```
public java.util.Set getPropertyNames()
```
    Description copied from interface: Exchange
    
    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.
    
    Specified by:
    
    getPropertyNames in interface Exchange
    
    Returns:
    
    Set of String property names.
  - getProperties
```
public java.util.Map getProperties()
```
    Description copied from interface: Exchange
    
    Provides direct access to the Map of properties for the exchange.
    
    Specified by:
    
    getProperties in interface Exchange
    
    Returns:
    
    Map of properties keyed by Strings.
  - setProperties
```
public void setProperties(java.util.Map properties)
```
    Description copied from interface: Exchange
    
    Replaces the properties of the exchange in one call for optimization.
    
    Specified by:
    
    setProperties in interface Exchange
    
    Parameters:
    
    properties - Map of properties keyed by a String.
  - setError
```
public void setError(java.lang.Exception error)
```
    Description copied from interface: Exchange
    
    Records an error encountered while processing the exchange.
    
    Specified by:
    
    setError in interface Exchange
    
    Parameters:
    
    error - Error holding the error information.
  - getError
```
public java.lang.Exception getError()
```
    Description copied from interface: Exchange
    
    Returns the error associated with the exchange (if any).
    
    Specified by:
    
    getError in interface Exchange
    
    Returns:
    
    Error holding the error details, null if none occured.
  - getStatus
```
public int getStatus()
```
    Description copied from interface: Exchange
    
    Returns the status of the exchange (ACTIVE, DONE, ERROR).
    
    Specified by:
    
    getStatus in interface Exchange
    
    Returns:
    
    Status of the exchange (ACTIVE, DONE, ERROR).
  - setStatus
```
public void setStatus(int status)
```
    Description copied from interface: Exchange
    
    Changes the status of the exchange.
    
    Specified by:
    
    setStatus in interface Exchange
    
    Parameters:
    
    status - Status of the exchange (ACTIVE, DONE, ERROR).
  - getInMessage
```
public Message getInMessage()
```
    Description copied from interface: Exchange
    
    Returns the in message that is part of the exchange (if any).
    
    Specified by:
    
    getInMessage in interface Exchange
    
    Returns:
    
    Message holding information about the message, null if none associated with the exchange.
  - setInMessage
```
protected void setInMessage(Message msg)
```
  - getOutMessage
```
public Message getOutMessage()
```
    Description copied from interface: Exchange
    
    Returns the out message that is part of the exchange (if any).
    
    Specified by:
    
    getOutMessage in interface Exchange
    
    Returns:
    
    Message holding information about the message, null if none associated with the exchange.
  - setOutMessage
```
protected void setOutMessage(Message msg)
```
  - getFaultMessage
```
public Message getFaultMessage()
```
    Description copied from interface: Exchange
    
    Returns the fault message that is part of the exchange (if any).
    
    Specified by:
    
    getFaultMessage in interface Exchange
    
    Returns:
    
    Message holding information about the message, null if none associated with the exchange.
  - setFaultMessage
```
protected void setFaultMessage(Message msg)
```
  - createMessage
```
public Message createMessage(ParameterType pType)
                      throws GException
```
    Description copied from interface: Exchange
    
    Associates a message with the exchange.
    
    Specified by:
    
    createMessage in interface Exchange
    
    Parameters:
    
    pType - ParameterType identifying whether the message is an IN, OUT, or FAULT.
    
    Returns:
    
    Message representing the message.
    
    Throws:
    
    GException
  - clearMessage
```
public void clearMessage(ParameterType pType)
                  throws GException
```
    Description copied from interface: Exchange
    
    Removes a message from the exchange.
    
    Specified by:
    
    clearMessage in interface Exchange
    
    Parameters:
    
    pType - ParameterType identifying the message to remove, IN, OUT, or FAULT.
    
    Throws:
    
    GException - Thrown if an error prevents the removal.
  - setMessage
```
public void setMessage(Message msg,
                       ParameterType pType)
                throws GException
```
    Default implementation throws UnsupportedOperationException.
    
    Specified by:
    
    setMessage in interface Exchange
    
    Parameters:
    
    msg - Message to be added to the Exchange.
    
    pType - ParameterType identifying whether the message is an IN, OUT, or FAULT.
    
    Throws:
    
    GException
  - addPart
```
public void addPart(java.lang.String name,
                    java.lang.Object part)
```
  - getPart
```
public void getPart(java.lang.String name)
```
  - getPartNames
```
public java.util.Set<java.lang.String> getPartNames()
```
  - arePartsEmpty
```
public boolean arePartsEmpty()
```
  - getParts
```
public java.util.Map<java.lang.String,java.lang.Object> getParts()
```
  - setMessageImpl
```
protected void setMessageImpl(Message msg,
                              ParameterType pType)
                       throws GException
```
    Throws:
    
    GException
  - getPattern
```
public java.net.URI getPattern()
```
    Description copied from interface: Exchange
    
    Returns the message exchange pattern to be used.
    
    Specified by:
    
    getPattern in interface Exchange
    
    Returns:
    
    Message exchange pattern to be used, i.e., IN_OUT, IN_ONLY.
  - setPattern
```
public void setPattern(java.net.URI pattern)
```
    Description copied from interface: Exchange
    
    Changes the message exchange pattern to be used.
    
    Specified by:
    
    setPattern in interface Exchange
    
    Parameters:
    
    pattern - Message exchange pattern to be used, i.e., IN_OUT, IN_ONLY.
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: Exchange
    
    Returns whether the exchange should be completed asynchronously or not.
    
    Specified by:
    
    isAsync in interface Exchange
    
    Returns:
    
    True if asynchronous, false if synchronous.
  - setAsync
```
public void setAsync(boolean isAsync)
```
    Description copied from interface: Exchange
    
    Changes whether the exchange should be completed asynchronously or not.
    
    Specified by:
    
    setAsync in interface Exchange
    
    Parameters:
    
    isAsync - True if asynchronous, false if synchronous.
  - getResponseEndpoint
```
public ExternalEndpoint getResponseEndpoint()
```
    Description copied from interface: Exchange
    
    External endpoint to send the response to if an asynchronous exchange.
    
    Specified by:
    
    getResponseEndpoint in interface Exchange
    
    Returns:
    
    ExternalEndpoint holding endpoint information, null if none available.
  - setResponseEndpoint
```
public void setResponseEndpoint(ExternalEndpoint endpoint)
```
    Description copied from interface: Exchange
    
    Changes the external endpoint to send the response if an asynchronous exchange.
    
    Specified by:
    
    setResponseEndpoint in interface Exchange
    
    Parameters:
    
    endpoint - ExternalEndpoint to send asynchronous responses.
  - getFaultEndpoint
```
public ExternalEndpoint getFaultEndpoint()
```
    Description copied from interface: Exchange
    
    External endpoint to send a fault to if an asynchronous exchange.
    
    Specified by:
    
    getFaultEndpoint in interface Exchange
    
    Returns:
    
    ExternalEndpoint holding endpoint information, null if none available.
  - setFaultEndpoint
```
public void setFaultEndpoint(ExternalEndpoint endpoint)
```
    Description copied from interface: Exchange
    
    Changes the external endpoint to send a fault if an asynchronous exchange.
    
    Specified by:
    
    setFaultEndpoint in interface Exchange
    
    Parameters:
    
    endpoint - ExternalEndpoint to send asynchronous responses.
  - getAuditLogger
```
public ContextLogger getAuditLogger()
```
    Description copied from interface: Exchange
    
    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.
    
    Specified by:
    
    getAuditLogger in interface Exchange
    
    Returns:
    
    Logger.
  - setAuditLogger
```
public void setAuditLogger(ContextLogger logger)
```
    Description copied from interface: Exchange
    
    Associates an audit logger with the exchange.
    
    Specified by:
    
    setAuditLogger in interface Exchange
    
    Parameters:
    
    logger - Logger.
  - createMessage
```
protected abstract Message createMessage()
                                  throws GException
```
    Throws:
    
    GException

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 AbstractExchange

Field Summary

Fields inherited from interface com.soa.message.Exchange

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractExchange

Method Detail

getExchangeID

setExchangeID

getServiceName

setServiceName

getBinding

setBinding

getEndpointName

getEndpoint

setEndpointName

setEndpoint

getInterfaceName

setInterfaceName

getOperationName

setOperationName

getProperty

setProperty

getPropertyNames

getProperties

setProperties

setError

getError

getStatus

setStatus

getInMessage

setInMessage

getOutMessage

setOutMessage

getFaultMessage

setFaultMessage

createMessage

clearMessage

setMessage

addPart

getPart

getPartNames

arePartsEmpty

getParts

setMessageImpl

getPattern

setPattern

isAsync

setAsync

getResponseEndpoint

setResponseEndpoint

getFaultEndpoint

setFaultEndpoint

getAuditLogger

setAuditLogger

createMessage