io.apiman.gateway.engine.policies

Class URLRewritingPolicy

java.lang.Object

io.apiman.gateway.engine.policies.AbstractMappedPolicy<C>

io.apiman.gateway.engine.policies.AbstractMappedDataPolicy<URLRewritingConfig>

io.apiman.gateway.engine.policies.URLRewritingPolicy

All Implemented Interfaces:

io.apiman.gateway.engine.policy.IDataPolicy, io.apiman.gateway.engine.policy.IPolicy

public class URLRewritingPolicy
extends AbstractMappedDataPolicy<URLRewritingConfig>

A policy that implements URL rewriting in the body and headers of the response from a back-end service.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
URLRewritingPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doApply(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context, URLRewritingConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain) Apply the policy to the response.
protected Class<URLRewritingConfig>	getConfigurationClass()
protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest>	requestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context, URLRewritingConfig policyConfiguration) Subclasses must implement this.
protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse>	responseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context, URLRewritingConfig policyConfiguration) Subclasses must implement this.

Methods inherited from class io.apiman.gateway.engine.policies.AbstractMappedDataPolicy

getRequestDataHandler, getResponseDataHandler

Methods inherited from class io.apiman.gateway.engine.policies.AbstractMappedPolicy

apply, apply, doApply, parseConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

apply, apply, parseConfiguration

Constructor Detail

URLRewritingPolicy

public URLRewritingPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<URLRewritingConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<URLRewritingConfig>

Returns:

the class to use for JSON configuration deserialization

See Also:

AbstractMappedPolicy.getConfigurationClass()

doApply

protected void doApply(io.apiman.gateway.engine.beans.ServiceResponse response,
           io.apiman.gateway.engine.policy.IPolicyContext context,
           URLRewritingConfig config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain)

Description copied from class: AbstractMappedPolicy

Apply the policy to the response.

Overrides:

doApply in class AbstractMappedPolicy<URLRewritingConfig>

See Also:

AbstractMappedPolicy.doApply(io.apiman.gateway.engine.beans.ServiceResponse, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object, io.apiman.gateway.engine.policy.IPolicyChain)

requestDataHandler

protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest> requestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request,
                                                                                                             io.apiman.gateway.engine.policy.IPolicyContext context,
                                                                                                             URLRewritingConfig policyConfiguration)

Description copied from class: AbstractMappedDataPolicy

Subclasses must implement this.

Specified by:

requestDataHandler in class AbstractMappedDataPolicy<URLRewritingConfig>

See Also:

AbstractMappedDataPolicy.requestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object)

responseDataHandler

protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse> responseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response,
                                                                                                               io.apiman.gateway.engine.policy.IPolicyContext context,
                                                                                                               URLRewritingConfig policyConfiguration)

Description copied from class: AbstractMappedDataPolicy

Subclasses must implement this.

Specified by:

responseDataHandler in class AbstractMappedDataPolicy<URLRewritingConfig>

See Also:

AbstractMappedDataPolicy.responseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object)