org.picketlink.config.http

Class AuthorizationConfigurationBuilder

java.lang.Object

org.picketlink.idm.config.Builder<T>

org.picketlink.config.AbstractSecurityConfigurationBuilder<T>

org.picketlink.config.http.AbstracHttpSecurityConfigurationChildBuilder

org.picketlink.config.http.AbstractPathConfigurationChildBuilder

org.picketlink.config.http.AuthorizationConfigurationBuilder

All Implemented Interfaces:

HttpSecurityConfigurationChildBuilder, PathConfigurationChildBuilder, SecurityConfigurationChildBuilder

public class AuthorizationConfigurationBuilder
extends AbstractPathConfigurationChildBuilder

Provides a set of options to configure authorization for a specific path.

Author:

Pedro Igor

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationConfigurationBuilder	authorizer(Class<? extends PathAuthorizer>... pathAuthorizer) Specifies a custom PathAuthorizer for the given path.
AuthorizationConfigurationBuilder	expression(String... expression) Specified an EL Expression that will be used to enforce authorization when sending requests to a specific path.
AuthorizationConfigurationBuilder	group(String... groupNames) Specifies one or more groups that must be enforced when sending requests to a specific path.
AuthorizationConfigurationBuilder	realm(String... realmNames) Specifies one or more realms that must be enforced when sending requests to a specific path.
AuthorizationConfigurationBuilder	role(String... roleNames) Specifies one or more roles that must be enforced when sending requests to a specific path.

Methods inherited from class org.picketlink.config.http.AbstractPathConfigurationChildBuilder

authenticateWith, authorizeWith, getBuilder, redirectTo, unprotected

Methods inherited from class org.picketlink.config.http.AbstracHttpSecurityConfigurationChildBuilder

allPaths, forGroup, forPath, forPath, restrictive

Methods inherited from class org.picketlink.config.AbstractSecurityConfigurationBuilder

build, create, http, identity, idmConfig, readFrom, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.config.http.HttpSecurityConfigurationChildBuilder

allPaths, forGroup, forPath, forPath, restrictive

Methods inherited from interface org.picketlink.config.SecurityConfigurationChildBuilder

build, http, identity, idmConfig

Method Detail

role

public AuthorizationConfigurationBuilder role(String... roleNames)

Specifies one or more roles that must be enforced when sending requests to a specific path.

Only users with all the specified roles are allowed to access.

Parameters:

roleNames -

Returns:

group

public AuthorizationConfigurationBuilder group(String... groupNames)

Specifies one or more groups that must be enforced when sending requests to a specific path.

Only users members of all the specified groups are allowed to access.

Parameters:

groupNames -

Returns:

realm

public AuthorizationConfigurationBuilder realm(String... realmNames)

Specifies one or more realms that must be enforced when sending requests to a specific path.

Only users that belong to any of the given realms are allowed to access.

Parameters:

realmNames -

Returns:

expression

public AuthorizationConfigurationBuilder expression(String... expression)

Specified an EL Expression that will be used to enforce authorization when sending requests to a specific path.

Parameters:

expression - An EL Expression. Expressions must always evaluate to a boolean. When defining expressions some important components are available for use such as the Identity instance. For instance, #{identity.isLoggedIn()}.

Returns:

authorizer

public AuthorizationConfigurationBuilder authorizer(Class<? extends PathAuthorizer>... pathAuthorizer)

Specifies a custom PathAuthorizer for the given path.

Parameters:

pathAuthorizer -

Returns: