Class FormLoginConfigurer

java.lang.Object

com.codename1.backend.security.SecurityConfigurer

com.codename1.backend.security.FormLoginConfigurer

public final class FormLoginConfigurer
extends SecurityConfigurer

Sign-in through an HTML form.

http.formLogin(form -> form
        .loginPage("/signin")
        .defaultSuccessUrl("/home")
        .permitAll());

With nothing set, the chain serves a plain login page at GET /login, takes the form at POST /login with the fields username and password, sends a signed-in user back to the page that asked -- or to / -- and a refused one to /login?error. Naming a loginPage hands the page to the application: the chain then serves none, and takes the form at that same path.

Method Summary

Modifier and Type	Method	Description
void	configure(HttpSecurity http)	Adds this part's filters; nothing by default.
FormLoginConfigurer	defaultSuccessUrl(String defaultSuccessUrl)	Where a user goes after signing in when no page asked for the sign-in.
FormLoginConfigurer	defaultSuccessUrl(String defaultSuccessUrl, boolean alwaysUse)
FormLoginConfigurer	failureHandler(AuthenticationFailureHandler failureHandler)	Answers a refused sign-in itself, instead of the redirect.
FormLoginConfigurer	failureUrl(String failureUrl)	Where a refused sign-in goes; the login page with ?error unless set.
void	init(HttpSecurity http)	Shares what other parts need to know; nothing by default.
FormLoginConfigurer	loginPage(String loginPage)	The application's own login page: a path the application serves.
FormLoginConfigurer	loginProcessingUrl(String loginProcessingUrl)	Where the form is posted; the login page's path unless set.
FormLoginConfigurer	passwordParameter(String passwordParameter)
FormLoginConfigurer	permitAll()	Lets everyone reach the login page, the form's target and the failure page, whatever the authorization rules say.
FormLoginConfigurer	successHandler(AuthenticationSuccessHandler successHandler)	Answers a sign-in itself, instead of the redirects.
FormLoginConfigurer	usernameParameter(String usernameParameter)

Methods inherited from class SecurityConfigurer

disable, getBuilder

Methods inherited from class Object

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

Method Details

loginPage

public FormLoginConfigurer loginPage(String loginPage)

The application's own login page: a path the application serves.

loginProcessingUrl

public FormLoginConfigurer loginProcessingUrl(String loginProcessingUrl)

Where the form is posted; the login page's path unless set.

usernameParameter

public FormLoginConfigurer usernameParameter(String usernameParameter)

passwordParameter

public FormLoginConfigurer passwordParameter(String passwordParameter)

defaultSuccessUrl

public FormLoginConfigurer defaultSuccessUrl(String defaultSuccessUrl)

Where a user goes after signing in when no page asked for the sign-in.

defaultSuccessUrl

public FormLoginConfigurer defaultSuccessUrl(String defaultSuccessUrl,
 boolean alwaysUse)

Parameters:

alwaysUse - go there even when a page asked for the sign-in

failureUrl

public FormLoginConfigurer failureUrl(String failureUrl)

Where a refused sign-in goes; the login page with ?error unless set.

successHandler

public FormLoginConfigurer successHandler(AuthenticationSuccessHandler successHandler)

Answers a sign-in itself, instead of the redirects.

failureHandler

public FormLoginConfigurer failureHandler(AuthenticationFailureHandler failureHandler)

Answers a refused sign-in itself, instead of the redirect.

permitAll

public FormLoginConfigurer permitAll()

Lets everyone reach the login page, the form's target and the failure page, whatever the authorization rules say. Needed with a loginPage of the application's: without it anyRequest().authenticated() redirects the login page to itself.

init

public void init(HttpSecurity http)

Description copied from class: SecurityConfigurer

Shares what other parts need to know; nothing by default.

Overrides:

init in class SecurityConfigurer

configure

public void configure(HttpSecurity http)

Description copied from class: SecurityConfigurer

Adds this part's filters; nothing by default.

Overrides:

configure in class SecurityConfigurer