org.picketlink.config.http

Class AbstractHttpSecurityBuilder

java.lang.Object

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

org.picketlink.config.AbstractSecurityConfigurationBuilder<HttpSecurityConfiguration>

org.picketlink.config.http.AbstractHttpSecurityBuilder

All Implemented Interfaces:

HttpSecurityConfigurationChildBuilder, SecurityConfigurationChildBuilder

Direct Known Subclasses:

HttpSecurityBuilder

public abstract class AbstractHttpSecurityBuilder
extends AbstractSecurityConfigurationBuilder<HttpSecurityConfiguration>
implements HttpSecurityConfigurationChildBuilder

A configuration builder with covenience methods to configure http security features.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
AbstractHttpSecurityBuilder(SecurityConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
PathConfigurationBuilder	allPaths() Creates a configuration for a specific path.
protected HttpSecurityConfiguration	create() Creates a new configuration.
PathConfigurationBuilder	forGroup(String groupName) Creates a configuration for a group of paths.
PathConfigurationBuilder	forPath(String path) Creates a configuration for the given path.
PathConfigurationBuilder	forPath(String path, String groupName) Creates a configuration for the given path based on a previously configured path group.
HttpSecurityConfigurationChildBuilder	restrictive() Indicates if the default behavior is to enforce security to all paths regardless they have a respective path configuration or not.

Methods inherited from class org.picketlink.config.AbstractSecurityConfigurationBuilder

build, 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.SecurityConfigurationChildBuilder

build, http, identity, idmConfig

Constructor Detail

AbstractHttpSecurityBuilder

public AbstractHttpSecurityBuilder(SecurityConfigurationBuilder builder)

Method Detail

allPaths

public PathConfigurationBuilder allPaths()

Creates a configuration for a specific path.

Specified by:

allPaths in interface HttpSecurityConfigurationChildBuilder

Returns:

forPath

public PathConfigurationBuilder forPath(String path)

Creates a configuration for the given path.

Specified by:

forPath in interface HttpSecurityConfigurationChildBuilder

Parameters:

path - The path. It should always begin with a slash. Some examples of path are: /rest, /rest/*, /*.jsf.

Returns:

forPath

public PathConfigurationBuilder forPath(String path,
                                        String groupName)

Creates a configuration for the given path based on a previously configured path group.

Specified by:

forPath in interface HttpSecurityConfigurationChildBuilder

Parameters:

path - The path. It should always begin with a slash. Some examples of path are: /rest, /rest/*, /*.jsf.

groupName - The group name. It must be a valid name referencing a path group defined using the forGroup(String).

Returns:

forGroup

public PathConfigurationBuilder forGroup(String groupName)

Creates a configuration for a group of paths.

Specified by:

forGroup in interface HttpSecurityConfigurationChildBuilder

Parameters:

groupName - The name of the path group.

Returns:

restrictive

public HttpSecurityConfigurationChildBuilder restrictive()

Indicates if the default behavior is to enforce security to all paths regardless they have a respective path configuration or not.

If the protection mode is not specified (eg.: restrictive(), default is to be permissive.

Specified by:

restrictive in interface HttpSecurityConfigurationChildBuilder

Returns:

create

protected HttpSecurityConfiguration create()
                                    throws SecurityConfigurationException

Description copied from class: Builder

Creates a new configuration.

Overrides:

create in class AbstractSecurityConfigurationBuilder<HttpSecurityConfiguration>

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration