io.undertow.servlet.handlers.security

Class ServletFormAuthenticationMechanism

java.lang.Object

io.undertow.security.impl.FormAuthenticationMechanism

io.undertow.servlet.handlers.security.ServletFormAuthenticationMechanism

All Implemented Interfaces:

AuthenticationMechanism

Direct Known Subclasses:

IDPAuthenticationMechanism, SPFormAuthenticationMechanism

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

Field Summary

Fields

Modifier and Type	Field and Description
static AuthenticationMechanismFactory	FACTORY
static String	SAVE_ORIGINAL_REQUEST

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

authenticationSessionTimeout, DEFAULT_POST_LOCATION, LOCATION_ATTRIBUTE, ORIGINAL_SESSION_TIMEOUT

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(FormParserFactory formParserFactory, String name, String loginPage, String errorPage, String defaultPage, boolean overrideInitial, IdentityManager identityManager, boolean saveOriginalRequest)
ServletFormAuthenticationMechanism(String name, String loginPage, String errorPage) Deprecated.
ServletFormAuthenticationMechanism(String name, String loginPage, String errorPage, String postLocation) Deprecated.

Method Summary

Modifier and Type	Method and Description
AuthenticationMechanism.AuthenticationMechanismOutcome	authenticate(HttpServerExchange exchange, SecurityContext securityContext) Perform authentication of the request.
protected void	handleRedirectBack(HttpServerExchange exchange)
protected Integer	servePage(HttpServerExchange exchange, String location)
protected void	storeInitialLocation(HttpServerExchange exchange)
protected void	storeInitialLocation(HttpServerExchange exchange, byte[] bytes, int contentLength) This method doesn't save content of request but instead uses data from parameter.

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

runFormAuth, sendChallenge

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final AuthenticationMechanismFactory FACTORY

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)

ServletFormAuthenticationMechanism

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

Method Detail

authenticate

public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(HttpServerExchange exchange,
                                                                           SecurityContext securityContext)

Description copied from interface: AuthenticationMechanism

Perform authentication of the request. Any potentially blocking work should be performed in the handoff executor provided

Specified by:

authenticate in interface AuthenticationMechanism

Overrides:

authenticate in class FormAuthenticationMechanism

Parameters:

exchange - The exchange

Returns:

servePage

protected Integer servePage(HttpServerExchange exchange,
                            String location)

Overrides:

servePage in class FormAuthenticationMechanism

storeInitialLocation

protected void storeInitialLocation(HttpServerExchange exchange)

Overrides:

storeInitialLocation in class FormAuthenticationMechanism

storeInitialLocation

protected void storeInitialLocation(HttpServerExchange exchange,
                                    byte[] bytes,
                                    int contentLength)

This method doesn't save content of request but instead uses data from parameter. This should be used in case that data from request was already read and therefore it is not possible to save them.

Parameters:

exchange -

bytes -

contentLength -

handleRedirectBack

protected void handleRedirectBack(HttpServerExchange exchange)

Overrides:

handleRedirectBack in class FormAuthenticationMechanism