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

Field Summary

Modifier and Type	Field and Description
public static final AuthenticationMechanismFactory	FACTORY
public static final String	IDENTITY_HEADER
private final List<HttpString>	identityHeaders
private final IdentityManager	identityManager
private final String	mechanismName
public static final String	NAME
public static final String	SESSION_HEADER
private final List<String>	sessionCookieNames

Constructor Summary

Access	Constructor and Description
public	GenericHeaderAuthenticationMechanism(String mechanismName, List<HttpString> identityHeaders, List<String> sessionCookieNames, IdentityManager identityManager)

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 String	getPrincipal(HttpServerExchange exchange)
private String	getSession(HttpServerExchange exchange)
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

FACTORY	back to summary
public static final AuthenticationMechanismFactory FACTORY

IDENTITY_HEADER	back to summary
public static final String IDENTITY_HEADER

identityHeaders	back to summary
private final List<HttpString> identityHeaders

identityManager	back to summary
private final IdentityManager identityManager

mechanismName	back to summary
private final String mechanismName

NAME	back to summary
public static final String NAME

SESSION_HEADER	back to summary
public static final String SESSION_HEADER

sessionCookieNames	back to summary
private final List<String> sessionCookieNames

Constructor Detail

GenericHeaderAuthenticationMechanism	back to summary
public GenericHeaderAuthenticationMechanism(String mechanismName, List<HttpString> identityHeaders, List<String> sessionCookieNames, IdentityManager identityManager)

Method Detail

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

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

getPrincipal	back to summary
private String getPrincipal(HttpServerExchange exchange)

getSession	back to summary
private String getSession(HttpServerExchange exchange)

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 GenericHeaderAuthenticationMechanism.Factory

Class Inheritance

extends Object
implements AuthenticationMechanismFactory

java.lang.Object
io.undertow.security.impl.GenericHeaderAuthenticationMechanism.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 GenericHeaderAuthenticationMechanism

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class GenericHeaderAuthenticationMechanism.Factory

Constructor Summary

Method Summary

Constructor Detail

Method Detail