com.softwareag.is.interceptor

Interface HttpInterceptorOutboundIFC

public interface HttpInterceptorOutboundIFC

This class defines a set of contracts that any outbound HttpInterceptor must implement.

Integration Server provides a framework for creating and registering outbound HTTP interceptors. An outbound HTTP interceptor is invoked when Integration Server is an HTTP client. It intercepts all outbound HTTP requests and inbound HTTP responses with the exception of: OAuth messages; services that use their own HTTP URL connections; and intermediate requests and responses in NTLM, DIGEST and REDIRECTS.

An outbound HTTP interceptor is comprised of:

• A preProcess method that Integration Server invokes just before sending the request to the provider. The preProcess method has access to the raw HTTP request data, including the headers, and a clone of the request body. If required, the preProcess method can prevent Integration Server from sending the request by throwing an HttpInterceptorException.
• A postProcess method that processes the cloned response in parallel to Integration Server response processing.

Keep the following information in mind when creating an outbound HTTP interceptor:

• You can register only one outbound HTTP interceptor per Integration Server
• The class that contains the HTTP interceptor must implement the com.softwareag.is.interceptor.HTTPInterceptorOutboundIFC interface and provide implementations of both methods in the class -- preProcess and postProcess.
• Using an outbound HTTP interceptor delays processing of a requests. Any logic the preProcess method executes to determine whether or not to continue with request processing needs to be done synchronously. However, if the preProcess method includes logic that can be done asynchronously by spawning off another thread, regular processing can proceed as quickly as possible.
• Using an outbound HTTP interceptor delays sending of the response.
• An outbound HTTP interceptor cannot modify the content of the HTTP request or response. For an HTTP request, Integration Server passes the HTTP interceptor a byte array representation of the output stream. When the HTTP interceptor completes execution, as long as the interceptor does not throw an HTTPInterceptorException to reject the HTTP request, normal Integration Server processing continues with the original output stream.

Following are the general steps to take when creating an outbound HTTP interceptor.

1. Create a Java Class that implements the HTTPInterceptorOutboundIFC interface. Build the implementation into a class file that goes into a jar file.
2. Place the jar file in one of these locations to ensure that the class appears on the Integration Server classpath.
   • Software AG_directory\IntegrationServer\instances\instanceName\lib\jars\custom
   • Software AG_directory\IntegrationServer\lib\jars\custom
   • Software AG_directory\IntegrationServer\instances\instanceName\packages\packageName\code\jars\static
3. Set the following server configuration properties in Integration Server.
   • watt.server.http.interceptor.outbound.enabled
   • watt.server.http.interceptor.outbound.impl
   For more information about these properties, refer to the webMethods Integration Server Administrator's Guide.
4. Restart Integration Server.

Method Summary

Modifier and Type	Method and Description
void	postProcess(int responseCode, java.lang.String responseMessage, java.util.Map<java.lang.String,java.lang.String> headers, byte[] bytes, java.lang.String correlationID) Receives HTTP response data before any processing has been done.
void	preProcess(java.lang.String requestURL, java.lang.String requestType, java.lang.String httpVersion, java.util.Map<java.lang.String,java.lang.String> headers, byte[] streamBytes, java.lang.String correlationID) Sends HTTP request data after all processing has been done on Integration Server.

Method Detail

preProcess

void preProcess(java.lang.String requestURL,
                java.lang.String requestType,
                java.lang.String httpVersion,
                java.util.Map<java.lang.String,java.lang.String> headers,
                byte[] streamBytes,
                java.lang.String correlationID)
         throws HttpInterceptorException

Sends HTTP request data after all processing has been done on Integration Server. Throws HttpInterceptorException if processing should be interrupted.

Parameters:

requestURL - The URL to connect to for this HTTP request including the query if present.

requestType - The HTTP method used. Possible values are GET, PUT, POST, PATCH, and DELETE.

httpVersion - The HTTP version of the request.

headers - A map of the fields in the request transport header, where key names represent header field names and values represent the header field values.

streamBytes - The body of the HTTP request represented as a byte array.

correlationID - An id assigned to this request that can be used to correlate this request to a specific response when it comes back through the Interceptor.

Throws:

HttpInterceptorException - - Thrown by preProcess method to interrupt Integraiton Server processing of this request.

postProcess

void postProcess(int responseCode,
                 java.lang.String responseMessage,
                 java.util.Map<java.lang.String,java.lang.String> headers,
                 byte[] bytes,
                 java.lang.String correlationID)
          throws java.io.IOException

Receives HTTP response data before any processing has been done.

Parameters:

responseCode - HTTP status code of the response.

responseMessage - HTTP status message of the response.

headers - A map of the fields in the response transport header, where key names represent header field names and values represent the header field values.

bytes - The body of the HTTP Response represented as a byte array.

correlationID - An id assigned to the original preprocess request that can be used to correlate this postProcess response back to a specific request that came through the interceptor.

Throws:

java.io.IOException