io.undertow.security.impl

Class BasicAuthenticationMechanism

java.lang.Object

io.undertow.security.impl.BasicAuthenticationMechanism

All Implemented Interfaces:

AuthenticationMechanism

public class BasicAuthenticationMechanism
extends Object
implements AuthenticationMechanism

The authentication handler responsible for BASIC authentication as described by RFC2617

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicAuthenticationMechanism.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 BasicAuthenticationMechanism.Factory	FACTORY
static String	SILENT

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationMechanism(String realmName)
BasicAuthenticationMechanism(String realmName, String mechanismName)
BasicAuthenticationMechanism(String realmName, String mechanismName, boolean silent)

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationMechanism.AuthenticationMechanismOutcome	authenticate(HttpServerExchange exchange, SecurityContext securityContext) Perform authentication of the request.
AuthenticationMechanism.ChallengeResult	sendChallenge(HttpServerExchange exchange, SecurityContext securityContext) Send an authentication challenge to the remote client.

Methods inherited from class java.lang.Object

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

Field Detail

SILENT

public static final String SILENT

See Also:

Constant Field Values

FACTORY

public static final BasicAuthenticationMechanism.Factory FACTORY

Constructor Detail

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName)

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName,
                            String mechanismName)

BasicAuthenticationMechanism

public BasicAuthenticationMechanism(String realmName,
                            String mechanismName,
                            boolean silent)

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

Parameters:

exchange - The exchange

Returns:

See Also:

HttpHandler.handleRequest(io.undertow.server.HttpServerExchange)

sendChallenge

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

Description copied from interface: AuthenticationMechanism

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 AuthenticationMechanism.ChallengeResult and the most appropriate overall response code will be selected.

Specified by:

sendChallenge in interface AuthenticationMechanism

Parameters:

exchange - The exchange

securityContext - The security context

Returns:

A AuthenticationMechanism.ChallengeResult indicating if a challenge was sent and the desired response code.