io.apiman.gateway.engine.policy

Interface IPolicy

All Known Subinterfaces:

IDataPolicy

public interface IPolicy

All policy implementations must implement this interface.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(io.apiman.gateway.engine.beans.ServiceRequest request, IPolicyContext context, Object config, IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain) Applies a policy upon a ServiceRequest based on information included in the request itself in addition to its context and configuration.
void	apply(io.apiman.gateway.engine.beans.ServiceResponse response, IPolicyContext context, Object config, IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain) Applies a policy upon a ServiceResponse based on information included in the response itself in addition to its context and configuration.
Object	parseConfiguration(String jsonConfiguration) Parses the JSON configuration into a policy specific configuration object type.

Method Detail

parseConfiguration

Object parseConfiguration(String jsonConfiguration)
                          throws io.apiman.gateway.engine.beans.exceptions.ConfigurationParseException

Parses the JSON configuration into a policy specific configuration object type. The policy implementation can parse the config in any way it chooses, resulting in any type of object it desires.

Parameters:

jsonConfiguration -

Throws:

io.apiman.gateway.engine.beans.exceptions.ConfigurationParseException

apply

void apply(io.apiman.gateway.engine.beans.ServiceRequest request,
         IPolicyContext context,
         Object config,
         IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)

Applies a policy upon a ServiceRequest based on information included in the request itself in addition to its context and configuration.

Parameters:

request - an inbound request to apply to the policy to

context - contextual information

config - the policy's configuration information

chain - the policy chain being invoked

apply

void apply(io.apiman.gateway.engine.beans.ServiceResponse response,
         IPolicyContext context,
         Object config,
         IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain)

Applies a policy upon a ServiceResponse based on information included in the response itself in addition to its context and configuration.

Parameters:

response - an outbound response to apply the policy to

context - contextual information

config - the policy's configuration information

chain - chain the policy chain being invoked