org.picketlink.config.http

Class FormAuthenticationConfigurationBuilder

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.AuthenticationMethodConfigurationBuilder

org.picketlink.config.http.FormAuthenticationConfigurationBuilder

All Implemented Interfaces:

HttpSecurityConfigurationChildBuilder, PathConfigurationChildBuilder, SecurityConfigurationChildBuilder

public class FormAuthenticationConfigurationBuilder
extends AuthenticationMethodConfigurationBuilder

Configures HTTP FORM Authentication for a specific path.

Author:

Pedro Igor

Method Summary

Methods

Modifier and Type	Method and Description
FormAuthenticationConfigurationBuilder	authenticationUri(String authenticationUri) Specifies the URI that must be used to initiate the authentication.
FormAuthenticationConfigurationBuilder	errorPage(String errorPageUrl) Specifies the login error page url.
FormAuthenticationConfigurationBuilder	loginPage(String loginPageUrl) Specifies the login page url.
FormAuthenticationConfigurationBuilder	restoreOriginalRequest() Indicates if the original request should be restored after a successful authentication.

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

authenticateWith, authorizeWith, cors, 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

restoreOriginalRequest

public FormAuthenticationConfigurationBuilder restoreOriginalRequest()

Indicates if the original request should be restored after a successful authentication. The original request is usually the last one that originatly initiated the authentication process.

Returns:

loginPage

public FormAuthenticationConfigurationBuilder loginPage(String loginPageUrl)

Specifies the login page url. If the user is not authenticated the give url will be used to redirect the user to.

Parameters:

loginPageUrl -

Returns:

errorPage

public FormAuthenticationConfigurationBuilder errorPage(String errorPageUrl)

Specifies the login error page url. If the user is not authenticated after right after an authentication attepmt the give url will be used to redirect the user to.

Parameters:

errorPageUrl -

Returns:

authenticationUri

public FormAuthenticationConfigurationBuilder authenticationUri(String authenticationUri)

Specifies the URI that must be used to initiate the authentication. Defaults to j_security_check..

Parameters:

authenticationUri -

Returns: