Interceptor (OpenText Process Suite Platform 10.8 Java SDK API)

All Known Implementing Classes:

Customizer
```
public interface Interceptor
```
An object that implements this interface can be used as interceptor for UDDI request and response. The interceptor is configured in the method implementation. For example:
<implementation type="Invoke"> <serviceuri>http://d-sxcsrv.nl.mycomp.com:1080/sap/bc/soap/rfc</serviceuri> <soapaction>http://www.sap.com/Z_PORTAL_GET_CUSTOMER_ADDRES</soapaction> <authenticationType>Anonymous</authenticationType> <interceptor> <class>com.cordys.project.mycomp.uddi.MyInterceptor</class> <myparam>3</myparam> </interceptor> </implementation>
The flow when the Interceptor is created/invoked is:
When a request comes in, an Interceptor object is created
On the newly created Interceptor, method initialize(methodImplementation) is called. This allows the Interceptor object to initialize itself, based on methodImplementation
First,onRequest(request) is called
Just before sending the request to external service, onHttpRequest(httpObject, userInfo) is called
Just after receiving the response from external service,onHttpResponse(httpObject,userInfo) is called
Then, one of the following is called:
in case of success: onResponse(response)
in case of SOAP fault: onSOAPFault(soapFault)

The interceptor manipulates the XML (it does not need to copy/clone) the XML.

If an exception is thrown inside the interceptor code, the UDDI connector will throw an InterceptorException.

Author:: hbank, jvmohan, ygopal

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`initialize(int methodImplementation)` To initialize the Interceptor with the given method implementation.
`void`	`onHttpRequest(IHTTPObject httpObject, UserInfo userInfo)` Hook to manipulate the HTTP request headers or query string going to the external web service host
`void`	`onHttpResponse(IHTTPObject httpObject, UserInfo userInfo)` Hook to manipulate the HTTP response headers coming from the external web service host
`void`	`onRequest(int request)` Hook to manipulate the request that goes to the external web service.
`void`	`onResponse(int response)` Hook to manipulate the response that comes from the external web service.
`void`	`onSOAPFault(int soapFault)` Hook to manipulate the soap fault that comes from the external web service.

- Method Detail
  - initialize
```
void initialize(int methodImplementation)
```
    To initialize the Interceptor with the given method implementation.
    
    Parameters:
    
    methodImplementation - the method implementation (as XML)
  - onRequest
```
void onRequest(int request)
```
    Hook to manipulate the request that goes to the external web service.
    
    Parameters:
    
    request - the request (as XML) to manipulate (in/out parameter).
  - onResponse
```
void onResponse(int response)
```
    Hook to manipulate the response that comes from the external web service.
    
    Parameters:
    
    response - the response (as XML) to manipulate (in/out parameter)
  - onSOAPFault
```
void onSOAPFault(int soapFault)
```
    Hook to manipulate the soap fault that comes from the external web service.
    
    Parameters:
    
    soapFault - the soapFault (as XML) to manipulate (in/out parameter).
  - onHttpRequest
```
void onHttpRequest(IHTTPObject httpObject,
                   UserInfo userInfo)
            throws InterceptorException
```
    Hook to manipulate the HTTP request headers or query string going to the external web service host
    
    Parameters:
    
    httpObject - an instance of the HTTPObject that represents the HTTP request
    
    userInfo - userinfo object for the user who sent the SOAP request
    
    Throws:
    
    InterceptorException - if something goes wrong
  - onHttpResponse
```
void onHttpResponse(IHTTPObject httpObject,
                    UserInfo userInfo)
             throws InterceptorException
```
    Hook to manipulate the HTTP response headers coming from the external web service host
    
    Parameters:
    
    httpObject - an instance of the HTTPObject that represents the HTTP response
    
    userInfo - userinfo object for the user who sent the SOAP request
    
    Throws:
    
    InterceptorException - if something goes wrong

Interface Interceptor

Method Summary

Method Detail

initialize

onRequest

onResponse

onSOAPFault

onHttpRequest

onHttpResponse