org.picketlink.config.http

Class PathConfigurationBuilder

java.lang.Object

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

org.picketlink.config.AbstractSecurityConfigurationBuilder<T>

org.picketlink.config.http.AbstracHttpSecurityConfigurationChildBuilder

org.picketlink.config.http.PathConfigurationBuilder

All Implemented Interfaces:

HttpSecurityConfigurationChildBuilder, PathConfigurationChildBuilder, SecurityConfigurationChildBuilder

public class PathConfigurationBuilder
extends AbstracHttpSecurityConfigurationChildBuilder
implements PathConfigurationChildBuilder

A configuration builder with covenience methods to configure protected paths.

Author:

Pedro Igor

Method Summary

Modifier and Type	Method and Description
AuthenticationConfigurationBuilder	authenticateWith() Provides a set of options to configure authentication for a specific path.
AuthorizationConfigurationBuilder	authorizeWith() Provides a set of options to configure authorization for a specific path.
CORSConfigurationBuilder	cors() Provides a set of options to configure CORS for a specific path.
protected PathConfiguration	create() Creates a new configuration.
LogoutConfigurationBuilder	logout() Identifies a specific path as being responsible to provide logout functionality.
OutboundRedirectConfigurationBuilder	redirectTo(String redirectUrl) Specifies a url that will be used to redirect the user after a specific path is processed.
PathConfigurationBuilder	unprotected() Mark a specific path as not protected.
InboundHeaderConfigurationBuilder	withHeaders() Provides a set of options regarding the request headers for a specific request.
PathConfigurationBuilder	withMethod(HttpMethod... methods) Configures the HttpMethod that are supported by a specific path.

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

allPaths, forGroup, forPath, forPath, restrictive

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.http.HttpSecurityConfigurationChildBuilder

allPaths, forGroup, forPath, forPath, restrictive

Methods inherited from interface org.picketlink.config.SecurityConfigurationChildBuilder

build, http, identity, idmConfig

Method Detail

authenticateWith

public AuthenticationConfigurationBuilder authenticateWith()

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

Specified by:

authenticateWith in interface PathConfigurationChildBuilder

Returns:

authorizeWith

public AuthorizationConfigurationBuilder authorizeWith()

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

Specified by:

authorizeWith in interface PathConfigurationChildBuilder

Returns:

cors

public CORSConfigurationBuilder cors()

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

Specified by:

cors in interface PathConfigurationChildBuilder

Returns:

logout

public LogoutConfigurationBuilder logout()

Identifies a specific path as being responsible to provide logout functionality.

Returns:

withHeaders

public InboundHeaderConfigurationBuilder withHeaders()

Provides a set of options regarding the request headers for a specific request.

In this case, headers are used to identify requests from each other and also enforce different security policies depending on their presence.

Returns:

withMethod

public PathConfigurationBuilder withMethod(HttpMethod... methods)

Configures the HttpMethod that are supported by a specific path.

In this case, methods can also be used to identity requests from each other and also enforce different security policies dependending on their presence.

Parameters:

methods -

Returns:

redirectTo

public OutboundRedirectConfigurationBuilder redirectTo(String redirectUrl)

Specifies a url that will be used to redirect the user after a specific path is processed.

For instance, after a logout request you may use this method to redirect the user to a different url.

Specified by:

redirectTo in interface PathConfigurationChildBuilder

Parameters:

redirectUrl -

Returns:

unprotected

public PathConfigurationBuilder unprotected()

Mark a specific path as not protected. When a path is not protected, no security enforcement is applied.

Specified by:

unprotected in interface PathConfigurationChildBuilder

Returns:

create

protected PathConfiguration create()

Description copied from class: Builder

Creates a new configuration.

Overrides:

create in class AbstractSecurityConfigurationBuilder

Returns: