Undertow 2.3.12.Final · io.undertow.security.impl.FormAuthenticationMechanism

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_POST_LOCATION
private final String	errorPage
private final FormParserFactory	formParserFactory
private final IdentityManager	identityManager
public static final String	LOCATION_ATTRIBUTE
private final String	loginPage
private final String	name
private final String	postLocation

Constructor Summary

Access	Constructor and Description
public	FormAuthenticationMechanism(final String name, final String loginPage, final String errorPage)
public	FormAuthenticationMechanism(final String name, final String loginPage, final String errorPage, final String postLocation)
public	FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage)
public	FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage, final IdentityManager identityManager)
public	FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage, final String postLocation)
public	FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage, final String postLocation, final IdentityManager identityManager)

Method Summary

Modifier and Type	Method and Description
public AuthenticationMechanism.AuthenticationMechanismOutcome	authenticate(final HttpServerExchange The exchange exchange, final SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.authenticate. Perform authentication of the request.
private IdentityManager	getIdentityManager(SecurityContext securityContext)
protected void	handleRedirectBack(final HttpServerExchange exchange)
public AuthenticationMechanism.AuthenticationMechanismOutcome	runFormAuth(final HttpServerExchange exchange, final SecurityContext securityContext)
public AuthenticationMechanism.ChallengeResult	sendChallenge(final HttpServerExchange The exchange exchange, final SecurityContext The security context securityContext) Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge. Send an authentication challenge to the remote client.
pack-priv static void	sendRedirect(final HttpServerExchange exchange, final String location)
protected Integer	servePage(final HttpServerExchange exchange, final String location)
protected void	storeInitialLocation(final HttpServerExchange exchange)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_POST_LOCATION	back to summary
public static final String DEFAULT_POST_LOCATION

errorPage	back to summary
private final String errorPage

formParserFactory	back to summary
private final FormParserFactory formParserFactory

identityManager	back to summary
private final IdentityManager identityManager

LOCATION_ATTRIBUTE	back to summary
public static final String LOCATION_ATTRIBUTE

loginPage	back to summary
private final String loginPage

name	back to summary
private final String name

postLocation	back to summary
private final String postLocation

Constructor Detail

FormAuthenticationMechanism	back to summary
public FormAuthenticationMechanism(final String name, final String loginPage, final String errorPage)

FormAuthenticationMechanism	back to summary
public FormAuthenticationMechanism(final String name, final String loginPage, final String errorPage, final String postLocation)

FormAuthenticationMechanism	back to summary
public FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage)

FormAuthenticationMechanism	back to summary
public FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage, final IdentityManager identityManager)

FormAuthenticationMechanism	back to summary
public FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage, final String postLocation)

FormAuthenticationMechanism	back to summary
public FormAuthenticationMechanism(final FormParserFactory formParserFactory, final String name, final String loginPage, final String errorPage, final String postLocation, final IdentityManager identityManager)

Method Detail

authenticate	back to summary
public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(final HttpServerExchange exchange, final SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.authenticate. Doc from io.undertow.security.api.AuthenticationMechanism.authenticate. Perform authentication of the request. Any potentially blocking work should be performed in the handoff executor provided Parameters exchange:HttpServerExchange The exchange Annotations @Override

authenticate

back to summary

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

Implements io.undertow.security.api.AuthenticationMechanism.authenticate.

Doc from io.undertow.security.api.AuthenticationMechanism.authenticate.

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

Parameters

exchange:HttpServerExchange: The exchange

Annotations

@Override

getIdentityManager	back to summary
private IdentityManager getIdentityManager(SecurityContext securityContext) Annotations @SuppressWarnings:deprecation

handleRedirectBack	back to summary
protected void handleRedirectBack(final HttpServerExchange exchange)

runFormAuth	back to summary
public AuthenticationMechanism.AuthenticationMechanismOutcome runFormAuth(final HttpServerExchange exchange, final SecurityContext securityContext)

sendChallenge back to summary

sendChallenge	back to summary
public AuthenticationMechanism.ChallengeResult sendChallenge(final HttpServerExchange exchange, final SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge. Doc from io.undertow.security.api.AuthenticationMechanism.sendChallenge. Send an authentication challenge to the remote client. The individual mechanisms should update the response headers and body of the message as appropriate however they should not set the response code, instead that should be indicated in the `ChallengeResult` and the most appropriate overall response code will be selected. This method should not return `null`. Parameters exchange:HttpServerExchange The exchange securityContext:SecurityContext The security context Returns:AuthenticationMechanism.ChallengeResult A `ChallengeResult` indicating if a challenge was sent and the desired response code.

public AuthenticationMechanism.ChallengeResult sendChallenge(final HttpServerExchange exchange, final SecurityContext securityContext)

Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge.

Doc from io.undertow.security.api.AuthenticationMechanism.sendChallenge.

Send an authentication challenge to the remote client.

The individual mechanisms should update the response headers and body of the message as appropriate however they should not set the response code, instead that should be indicated in the ChallengeResult and the most appropriate overall response code will be selected. This method should not return null.