SoaAgent (Policy Manager API)

```
public interface SoaAgent
```
Simple interface to an SOA Software agent. The client calls the agent for each message it wants the agent to process. The agent may allocate resources that are cached for subsequent calls using the same MessageContext. Therefore the client must be careful to call close() to release those resources when processing the context is completed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close(MessageContext context)` Gives the agent the opportunity to release any resources allocated during processing of a message context.
`ExchangeStatus`	`handleFaultMessage(MessageContext context)` Processes the FAULT message of an operation.
`ExchangeStatus`	`handleInMessage(MessageContext context)` Processes the IN message of an operation.
`ExchangeStatus`	`handleOutMessage(MessageContext context)` Processes the OUT message of an operation.
`ExchangeStatus`	`handleResponseMessage(MessageContext context)` Processes the message returned by the service implementation for an operation.
`MessageContext`	`open()` Returns a new MessageContext to be used for subsequent calls to the agent.

- Method Detail
  - open
```
MessageContext open()
```
    Returns a new MessageContext to be used for subsequent calls to the agent. Upon completion of the calls, close() must be called.
    
    Returns:
    
    new MessageContext.
  - handleInMessage
```
ExchangeStatus handleInMessage(MessageContext context)
                        throws AgentException
```
    Processes the IN message of an operation.
    
    Parameters:
    
    context - MessageContext holding the message to be processed and any additional properties that are relevant. At completion, the message may be altered for delivery to the service implementation. The message may also be changed for immediate delivery back to the consumer without forwarding to the service implementation. The message may be replaced with a normal OUT message or a FAULT message. The returned ExchangeStatus will indicate to the client what the agent has done and recommends to do next.
    
    Returns:
    
    ExchangeStatus indicating what should be done next by the client. See ExchangeStatus for more details. All enumerated values are possible.
    
    Throws:
    
    AgentException - Thrown if the agent encountered an internal error and could not complete processing.
  - handleOutMessage
```
ExchangeStatus handleOutMessage(MessageContext context)
                         throws AgentException
```
    Processes the OUT message of an operation. Assumes the message is the message defined as the OUT message in the WSDL definition of the invoked service and not a fault. If it is not known whether the message is a fault or the WSDL defined OUT message, use the handleResponseMessage(MessageContext).
    
    Parameters:
    
    context - MessageContext holding the message to be processed and any additional properties that are relevant. At completion, the message may be altered for delivery to the client. The message may be replaced with a FAULT message. The returned ExchangeStatus will indicate to the client what the agent has done and recommends to do next.
    
    Returns:
    
    ExchangeStatus indicating what should be done next by the client. See ExchangeStatus for more details. All enumerated values except CONTINUE are possible.
    
    Throws:
    
    AgentException - Thrown if the agent encountered an internal error and could not complete processing.
  - handleResponseMessage
```
ExchangeStatus handleResponseMessage(MessageContext context)
                              throws AgentException
```
    Processes the message returned by the service implementation for an operation. Use this message as opposed to handleOutMessage(MessageContext) when it is not known whether the returned message is a fault or the OUT message defined in WSDL.
    
    Parameters:
    
    context - MessageContext holding the message to be processed and any additional properties that are relevant. At completion, the message may be altered for delivery to the client. The message may be replaced with a FAULT message. The returned ExchangeStatus will indicate to the client what the agent has done and recommends to do next.
    
    Returns:
    
    ExchangeStatus indicating what should be done next by the client. See ExchangeStatus for more details. All enumerated values except CONTINUE are possible.
    
    Throws:
    
    AgentException - Thrown if the agent encountered an internal error and could not complete processing.
  - handleFaultMessage
```
ExchangeStatus handleFaultMessage(MessageContext context)
                           throws AgentException
```
    Processes the FAULT message of an operation.
    
    Parameters:
    
    context - MessageContext holding the message to be processed and any additional properties that are relevant. At completion, the message may be altered for delivery to the client. The returned ExchangeStatus will recommend to the client what to do next.
    
    Returns:
    
    ExchangeStatus indicating what should be done next by the client. See ExchangeStatus for more details. All enumerated values except CONTINUE are possible.
    
    Throws:
    
    AgentException - Thrown if the agent encountered an internal error and could not complete processing.
  - close
```
void close(MessageContext context)
```
    Gives the agent the opportunity to release any resources allocated during processing of a message context.
    
    Parameters:
    
    context - MessageContext whose resources are to be released.

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 SoaAgent

Method Summary

Method Detail

open

handleInMessage

handleOutMessage

handleResponseMessage

handleFaultMessage

close