Top Description Fields Methods
io.undertow.security.api

public Interface AuthenticationMechanismFactory

Known Direct Implementers
io.undertow.security.impl.BasicAuthenticationMechanism.Factory, io.undertow.security.impl.ClientCertAuthenticationMechanism.Factory, io.undertow.security.impl.DigestAuthenticationMechanism.Factory, io.undertow.security.impl.ExternalAuthenticationMechanism.Factory, io.undertow.security.impl.GenericHeaderAuthenticationMechanism.Factory, io.undertow.util.ImmediateAuthenticationMechanismFactory
Imports
io.undertow.security.idm.IdentityManager, io.undertow.server.handlers.form.FormParserFactory, java.util.Map
Factory for authentication mechanisms.
Author
Stuart Douglas

Field Summary

Modifier and TypeField and Description
public static final String
CONTEXT_PATH

public static final String
DEFAULT_PAGE

public static final String
ERROR_PAGE

public static final String
LOGIN_PAGE

public static final String
OVERRIDE_INITIAL

public static final String
REALM

Method Summary

Modifier and TypeMethod and Description
public default AuthenticationMechanism

Returns:

The mechanism
create(String
The name under which this factory was registered
mechanismName, FormParserFactory
Parser to create a form data parser for a given request.
formParserFactory, final Map<String, String>
The properties
properties)
Deprecated

Creates an authentication mechanism using the specified properties

public default AuthenticationMechanism

Returns:

The mechanism
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, final Map<String, String>
The properties
properties)

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

Field Detail

CONTEXT_PATHback to summary
public static final String CONTEXT_PATH
DEFAULT_PAGEback to summary
public static final String DEFAULT_PAGE
ERROR_PAGEback to summary
public static final String ERROR_PAGE
LOGIN_PAGEback to summary
public static final String LOGIN_PAGE
OVERRIDE_INITIALback to summary
public static final String OVERRIDE_INITIAL
REALMback to summary
public static final String REALM

Method Detail

createback to summary
public default AuthenticationMechanism create(String mechanismName, FormParserFactory formParserFactory, final Map<String, String> properties)

Deprecated

Creates an authentication mechanism using the specified properties

Parameters
mechanismName:String

The name under which this factory was registered

formParserFactory:FormParserFactory

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

properties:Map<String, String>

The properties

Returns:AuthenticationMechanism

The mechanism

Annotations
@Deprecated
createback to summary
public default AuthenticationMechanism create(String mechanismName, IdentityManager identityManager, FormParserFactory formParserFactory, final Map<String, String> properties)

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