ServletFormAuthenticationMechanism (Undertow 1.4.13.Final-SNAPSHOT API)

java.lang.Object
- io.undertow.security.impl.FormAuthenticationMechanism
- - io.undertow.servlet.handlers.security.ServletFormAuthenticationMechanism

All Implemented Interfaces:

AuthenticationMechanism
```
public class ServletFormAuthenticationMechanism
extends FormAuthenticationMechanism
```
Servlet handler for FORM authentication. Instead of using a redirect it serves up error and login pages immediately using a forward

Author:

Stuart Douglas

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ServletFormAuthenticationMechanism.Factory
- Nested classes/interfaces inherited from interface io.undertow.security.api.AuthenticationMechanism
  AuthenticationMechanism.AuthenticationMechanismOutcome, AuthenticationMechanism.ChallengeResult

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServletFormAuthenticationMechanism.Factory`

Field Summary

Fields
Modifier and Type Field and Description

static String SAVE_ORIGINAL_REQUEST
- Fields inherited from class io.undertow.security.impl.FormAuthenticationMechanism
  DEFAULT_POST_LOCATION, LOCATION_ATTRIBUTE

Fields
Modifier and Type	Field and Description
`static String`	`SAVE_ORIGINAL_REQUEST`

Constructor Summary

Constructors
Constructor and Description
`ServletFormAuthenticationMechanism(FormParserFactory formParserFactory, String name, String loginPage, String errorPage)`
`ServletFormAuthenticationMechanism(FormParserFactory formParserFactory, String name, String loginPage, String errorPage, IdentityManager identityManager)`
`ServletFormAuthenticationMechanism(FormParserFactory formParserFactory, String name, String loginPage, String errorPage, IdentityManager identityManager, boolean saveOriginalRequest)`
`ServletFormAuthenticationMechanism(FormParserFactory formParserFactory, String name, String loginPage, String errorPage, String postLocation)`
`ServletFormAuthenticationMechanism(String name, String loginPage, String errorPage)` Deprecated.
`ServletFormAuthenticationMechanism(String name, String loginPage, String errorPage, String postLocation)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`handleRedirectBack(HttpServerExchange exchange)`
`protected Integer`	`servePage(HttpServerExchange exchange, String location)`
`protected void`	`storeInitialLocation(HttpServerExchange exchange)`

Methods inherited from class io.undertow.security.impl.FormAuthenticationMechanism
authenticate, runFormAuth, sendChallenge

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- SAVE_ORIGINAL_REQUEST
```
public static final String SAVE_ORIGINAL_REQUEST
```
  See Also:
  
  Constant Field Values

Constructor Detail

ServletFormAuthenticationMechanism

@Deprecated
public ServletFormAuthenticationMechanism(String name,
                                                      String loginPage,
                                                      String errorPage)

Deprecated.

ServletFormAuthenticationMechanism

@Deprecated
public ServletFormAuthenticationMechanism(String name,
                                                      String loginPage,
                                                      String errorPage,
                                                      String postLocation)

Deprecated.

ServletFormAuthenticationMechanism

public ServletFormAuthenticationMechanism(FormParserFactory formParserFactory,
                                          String name,
                                          String loginPage,
                                          String errorPage,
                                          String postLocation)

ServletFormAuthenticationMechanism

public ServletFormAuthenticationMechanism(FormParserFactory formParserFactory,
                                          String name,
                                          String loginPage,
                                          String errorPage)

ServletFormAuthenticationMechanism

public ServletFormAuthenticationMechanism(FormParserFactory formParserFactory,
                                          String name,
                                          String loginPage,
                                          String errorPage,
                                          IdentityManager identityManager)

ServletFormAuthenticationMechanism

public ServletFormAuthenticationMechanism(FormParserFactory formParserFactory,
                                          String name,
                                          String loginPage,
                                          String errorPage,
                                          IdentityManager identityManager,
                                          boolean saveOriginalRequest)

Method Detail

servePage

protected Integer servePage(HttpServerExchange exchange,
                            String location)

Overrides:: servePage in class FormAuthenticationMechanism

storeInitialLocation
```
protected void storeInitialLocation(HttpServerExchange exchange)
```
Overrides:

storeInitialLocation in class FormAuthenticationMechanism

handleRedirectBack
```
protected void handleRedirectBack(HttpServerExchange exchange)
```
Overrides:

handleRedirectBack in class FormAuthenticationMechanism

Class ServletFormAuthenticationMechanism

Nested Class Summary

Nested classes/interfaces inherited from interface io.undertow.security.api.AuthenticationMechanism

Field Summary

Fields inherited from class io.undertow.security.impl.FormAuthenticationMechanism

Constructor Summary

Method Summary

Methods inherited from class io.undertow.security.impl.FormAuthenticationMechanism

Methods inherited from class java.lang.Object

Field Detail

SAVE_ORIGINAL_REQUEST

Constructor Detail

ServletFormAuthenticationMechanism

ServletFormAuthenticationMechanism

ServletFormAuthenticationMechanism

ServletFormAuthenticationMechanism

ServletFormAuthenticationMechanism

ServletFormAuthenticationMechanism

Method Detail

servePage

storeInitialLocation

handleRedirectBack