Modifier and Type	Class and Description
public static class	BasicAuthenticationMechanism.Factory

Field Summary

Modifier and Type	Field and Description
private static final String	BASIC_PREFIX
private final String	challenge
public static final String	CHARSET
private final Charset	charset
private static final String	COLON
public static final AuthenticationMechanismFactory	FACTORY
private final IdentityManager	identityManager
private static final String	LOWERCASE_BASIC_PREFIX
private final String	name
private static final int	PREFIX_LENGTH
public static final String	SILENT
private final boolean	silent If silent is true then this mechanism will only take effect if there is an Authorization header.
public static final String	USER_AGENT_CHARSETS A comma separated list of patterns and charsets.
private final Map<Pattern, Charset>	userAgentCharsets

Constructor Summary

Access	Constructor and Description
public	BasicAuthenticationMechanism(final String realmName)
public	BasicAuthenticationMechanism(final String realmName, final String mechanismName)
public	BasicAuthenticationMechanism(final String realmName, final String mechanismName, final boolean silent)
public	BasicAuthenticationMechanism(final String realmName, final String mechanismName, final boolean silent, final IdentityManager identityManager)
public	BasicAuthenticationMechanism(final String realmName, final String mechanismName, final boolean silent, final IdentityManager identityManager, Charset charset, Map<Pattern, Charset> userAgentCharsets)

Method Summary

Modifier and Type	Method and Description
public AuthenticationMechanism.AuthenticationMechanismOutcome	authenticate(HttpServerExchange The exchange exchange, SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.authenticate. Perform authentication of the request.
private static void	clear(final char[] array)
private IdentityManager	getIdentityManager(SecurityContext securityContext)
public AuthenticationMechanism.ChallengeResult	sendChallenge(HttpServerExchange The exchange exchange, SecurityContext The security context securityContext) Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge. Send an authentication challenge to the remote client.

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

Field Detail

BASIC_PREFIX	back to summary
private static final String BASIC_PREFIX

challenge	back to summary
private final String challenge

CHARSET	back to summary
public static final String CHARSET

charset	back to summary
private final Charset charset

COLON	back to summary
private static final String COLON

FACTORY	back to summary
public static final AuthenticationMechanismFactory FACTORY

identityManager	back to summary
private final IdentityManager identityManager

LOWERCASE_BASIC_PREFIX	back to summary
private static final String LOWERCASE_BASIC_PREFIX

name	back to summary
private final String name

PREFIX_LENGTH	back to summary
private static final int PREFIX_LENGTH

SILENT	back to summary
public static final String SILENT

silent	back to summary
private final boolean silent If silent is true then this mechanism will only take effect if there is an Authorization header. This allows you to combine basic auth with form auth, so human users will use form based auth, but allows programmatic clients to login using basic auth.

USER_AGENT_CHARSETS	back to summary
public static final String USER_AGENT_CHARSETS A comma separated list of patterns and charsets. The pattern is a regular expression. Because different browsers user different encodings this allows for the correct encoding to be selected based on the current browser. In general though it is recommended that BASIC auth not be used when passwords contain characters outside ASCII, as some browsers use the current locate to determine encoding. This list must have an even number of elements, as it is interpreted as pattern,charset,pattern,charset,...

USER_AGENT_CHARSETS

back to summary

public static final String USER_AGENT_CHARSETS

A comma separated list of patterns and charsets. The pattern is a regular expression. Because different browsers user different encodings this allows for the correct encoding to be selected based on the current browser. In general though it is recommended that BASIC auth not be used when passwords contain characters outside ASCII, as some browsers use the current locate to determine encoding. This list must have an even number of elements, as it is interpreted as pattern,charset,pattern,charset,...

userAgentCharsets	back to summary
private final Map<Pattern, Charset> userAgentCharsets

Constructor Detail

BasicAuthenticationMechanism	back to summary
public BasicAuthenticationMechanism(final String realmName)

BasicAuthenticationMechanism	back to summary
public BasicAuthenticationMechanism(final String realmName, final String mechanismName)

BasicAuthenticationMechanism	back to summary
public BasicAuthenticationMechanism(final String realmName, final String mechanismName, final boolean silent)

BasicAuthenticationMechanism	back to summary
public BasicAuthenticationMechanism(final String realmName, final String mechanismName, final boolean silent, final IdentityManager identityManager)

BasicAuthenticationMechanism	back to summary
public BasicAuthenticationMechanism(final String realmName, final String mechanismName, final boolean silent, final IdentityManager identityManager, Charset charset, Map<Pattern, Charset> userAgentCharsets)

Method Detail

authenticate back to summary

authenticate	back to summary
public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(HttpServerExchange exchange, 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 See Also `io.undertow.server.HttpHandler#handleRequest(io.undertow.server.HttpServerExchange)`

public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(HttpServerExchange exchange, 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

clear	back to summary
private static void clear(final char[] array)

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

sendChallenge back to summary

sendChallenge	back to summary
public AuthenticationMechanism.ChallengeResult sendChallenge(HttpServerExchange exchange, 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. Annotations @Override

public AuthenticationMechanism.ChallengeResult sendChallenge(HttpServerExchange exchange, 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.

Annotations

@Override

io.undertow.security.impl back to summary

public Class BasicAuthenticationMechanism.Factory

Class Inheritance

extends Object
implements AuthenticationMechanismFactory

java.lang.Object
io.undertow.security.impl.BasicAuthenticationMechanism.Factory

All Implemented Interfaces

io.undertow.security.api.AuthenticationMechanismFactory

Constructor Summary

Access	Constructor and Description
public	Factory(IdentityManager identityManager) Deprecated
public	Factory()

Method Summary

Modifier and Type	Method and Description
public AuthenticationMechanism	create(String The name under which this factory was registered mechanismName, IdentityManager the IdentityManager instance asscociated with the deployment identityManager, FormParserFactory Parser to create a form data parser for a given request. formParserFactory, Map<String, String> The properties properties) Overrides default io.undertow.security.api.AuthenticationMechanismFactory.create. Creates an authentication mechanism that needs access to the deployment IdentityManager and specified properties

Modifier and Type

Method and Description

public AuthenticationMechanism

create(String

The name under which this factory was registered

mechanismName, IdentityManager

the IdentityManager instance asscociated with the deployment

identityManager, FormParserFactory

Parser to create a form data parser for a given request.

formParserFactory, Map<String, String>

The properties

properties)

Overrides default io.undertow.security.api.AuthenticationMechanismFactory.create.

Creates an authentication mechanism that needs access to the deployment IdentityManager and specified properties

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

Constructor Detail

Factory	back to summary
public Factory(IdentityManager identityManager) Deprecated Annotations @Deprecated

Factory	back to summary
public Factory()

Method Detail

create	back to summary
public AuthenticationMechanism create(String mechanismName, IdentityManager identityManager, FormParserFactory formParserFactory, Map<String, String> properties) Overrides default io.undertow.security.api.AuthenticationMechanismFactory.create. Doc from io.undertow.security.api.AuthenticationMechanismFactory.create. Creates an authentication mechanism that needs access to the deployment IdentityManager and specified properties Parameters mechanismName:String The name under which this factory was registered identityManager:IdentityManager the IdentityManager instance asscociated with the deployment formParserFactory:FormParserFactory Parser to create a form data parser for a given request. properties:Map<String, String> The properties Returns:AuthenticationMechanism The mechanism Annotations @Override

create

back to summary

public AuthenticationMechanism create(String mechanismName, IdentityManager identityManager, FormParserFactory formParserFactory, Map<String, String> properties)

Overrides default io.undertow.security.api.AuthenticationMechanismFactory.create.

Doc from io.undertow.security.api.AuthenticationMechanismFactory.create.

Creates an authentication mechanism that needs access to the deployment IdentityManager and specified properties

Parameters

mechanismName:String: The name under which this factory was registered
identityManager:IdentityManager: the IdentityManager instance asscociated with the deployment
formParserFactory:FormParserFactory: Parser to create a form data parser for a given request.
properties:Map<String, String>: The properties

Returns:AuthenticationMechanism

The mechanism

Annotations

@Override

public Class BasicAuthenticationMechanism

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class BasicAuthenticationMechanism.Factory

Constructor Summary

Method Summary

Constructor Detail

Method Detail