io.apiman.gateway.engine.policy

Interface IDataPolicy

All Superinterfaces:

IPolicy

public interface IDataPolicy
extends IPolicy

Policies that wish to be applied to the data handling phase of apiman must implement this interface. Normal policies (which implement IPolicy) are only given a crack at the ServiceRequest and ServiceResponse. If this interface is implemented, then the policy also gets a crack at the request body stream and response body stream. This is useful for things like URL rewriting policies.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest>	getRequestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request, IPolicyContext context) This method should return a stream that will be used when piping the request data from the client to the back-end service.
IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse>	getResponseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response, IPolicyContext context) This method should return a stream that will be used when piping the response data from the back-end service to the client.

Methods inherited from interface io.apiman.gateway.engine.policy.IPolicy

apply, apply, parseConfiguration

Method Detail

getRequestDataHandler

IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest> getRequestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request,
                                                                                    IPolicyContext context)

This method should return a stream that will be used when piping the request data from the client to the back-end service.

Parameters:

request - the request

context - the context

Returns:

Request handler to stream request data through the policy.

getResponseDataHandler

IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse> getResponseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response,
                                                                                      IPolicyContext context)

This method should return a stream that will be used when piping the response data from the back-end service to the client.

Parameters:

response - the response

context - the context

Returns:

Response handler to stream request data through the policy.