io.apiman.gateway.engine.policies

Class BasicAuthenticationPolicy

java.lang.Object

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

io.apiman.gateway.engine.policies.BasicAuthenticationPolicy

All Implemented Interfaces:

io.apiman.gateway.engine.policy.IPolicy

public class BasicAuthenticationPolicy
extends AbstractMappedPolicy<BasicAuthenticationConfig>

An implementation of an apiman policy that supports multiple styles of authentication. Specifically this policy is responsible for authenticating the inbound request prior to proxying the request to the back end service. If the authentication fails then the back end system is never invoked.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doApply(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context, BasicAuthenticationConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)
protected Class<BasicAuthenticationConfig>	getConfigurationClass()
protected void	sendAuthFailure(io.apiman.gateway.engine.policy.IPolicyContext context, io.apiman.gateway.engine.policy.IPolicyChain<?> chain, BasicAuthenticationConfig config, int reason) Sends the 'unauthenticated' response as a policy failure.

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

Constructor Detail

BasicAuthenticationPolicy

public BasicAuthenticationPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<BasicAuthenticationConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<BasicAuthenticationConfig>

Returns:

the class to use for JSON configuration deserialization

See Also:

io.apiman.gateway.engine.policy.AbstractPolicy#getConfigurationClass()

doApply

protected void doApply(io.apiman.gateway.engine.beans.ServiceRequest request,
           io.apiman.gateway.engine.policy.IPolicyContext context,
           BasicAuthenticationConfig config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)

Overrides:

doApply in class AbstractMappedPolicy<BasicAuthenticationConfig>

See Also:

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

sendAuthFailure

protected void sendAuthFailure(io.apiman.gateway.engine.policy.IPolicyContext context,
                   io.apiman.gateway.engine.policy.IPolicyChain<?> chain,
                   BasicAuthenticationConfig config,
                   int reason)

Sends the 'unauthenticated' response as a policy failure.

Parameters:

context -

chain -

config -

reason -