io.apiman.gateway.engine.policies

Class AuthorizationPolicy

java.lang.Object

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

io.apiman.gateway.engine.policies.AuthorizationPolicy

All Implemented Interfaces:

io.apiman.gateway.engine.policy.IPolicy

public class AuthorizationPolicy
extends AbstractMappedPolicy<AuthorizationConfig>

Adds authorization capabilities to apiman. This policy allows users to specify what roles the authenticated user must have in order to be allowed to call the service. This policy works in conjunction with a compatible Authentication policy, such as the Basic authentication policy. The assumption is that such a policy will extract the roles from the source of identity (either during authentication or as a followup step). These roles will be stored in the policy context for use by this Authorization policy. The roles are represented as a simple set of strings.

Author:

eric.wittmann@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATED_USER_ROLES

Constructor Summary

Constructors

Constructor and Description
AuthorizationPolicy() 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, AuthorizationConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)
protected Class<AuthorizationConfig>	getConfigurationClass()

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

Field Detail

AUTHENTICATED_USER_ROLES

public static final String AUTHENTICATED_USER_ROLES

See Also:

Constant Field Values

Constructor Detail

AuthorizationPolicy

public AuthorizationPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<AuthorizationConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<AuthorizationConfig>

Returns:

the class to use for JSON configuration deserialization

See Also:

AbstractMappedPolicy.getConfigurationClass()

doApply

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

Overrides:

doApply in class AbstractMappedPolicy<AuthorizationConfig>

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)