Package org.wildfly.security.auth.server.sasl

Class SaslAuthenticationFactory

java.lang.Object

org.wildfly.security.auth.server.AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

org.wildfly.security.auth.server.sasl.SaslAuthenticationFactory

All Implemented Interfaces:

MechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

public final class SaslAuthenticationFactory
extends AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

A SASL server factory configuration.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SaslAuthenticationFactory.Builder	A builder for SASL server factory configurations.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static Map<String,String>	QUERY_ALL
private SaslServerFactory	saslServerFactory

Constructor Summary

Constructors

Constructor	Description
SaslAuthenticationFactory(SecurityDomain securityDomain, MechanismConfigurationSelector mechanismConfigurationSelector, SaslServerFactory saslServerFactory)

Method Summary

Modifier and Type	Method	Description
static SaslAuthenticationFactory.Builder	builder()	Obtain a new SaslAuthenticationFactory.Builder capable of building a SaslAuthenticationFactory.
protected SaslServer	doCreate(String name, CallbackHandler callbackHandler, UnaryOperator<SaslServerFactory> factoryTransformation)
protected Collection<String>	getAllSupportedMechNames()
protected Collection<String>	getSupportedCredentialAlgorithmNames(Class<? extends AlgorithmCredential> credentialType, String mechName)
protected Collection<Class<? extends Credential>>	getSupportedCredentialTypes(String mechName)
protected Collection<String>	getSupportedEvidenceAlgorithmNames(Class<? extends AlgorithmEvidence> evidenceType, String mechName)
protected Collection<Class<? extends Evidence>>	getSupportedEvidenceTypes(String mechName)
protected boolean	usesCredentials(String mechName)	Determine whether the given mechanism name needs credentials from a realm in order to authenticate.

Methods inherited from class org.wildfly.security.auth.server.AbstractMechanismAuthenticationFactory

createMechanism, getFactory, getMechanismNames, getSecurityDomain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.auth.server.MechanismAuthenticationFactory

createMechanism

Field Detail

saslServerFactory

private final SaslServerFactory saslServerFactory

QUERY_ALL

static final Map<String,String> QUERY_ALL

Constructor Detail

SaslAuthenticationFactory

SaslAuthenticationFactory(SecurityDomain securityDomain,
                          MechanismConfigurationSelector mechanismConfigurationSelector,
                          SaslServerFactory saslServerFactory)

Method Detail

doCreate

protected SaslServer doCreate(String name,
                              CallbackHandler callbackHandler,
                              UnaryOperator<SaslServerFactory> factoryTransformation)
                       throws SaslException

Specified by:

doCreate in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

Throws:

SaslException

getAllSupportedMechNames

protected Collection<String> getAllSupportedMechNames()

Specified by:

getAllSupportedMechNames in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

getSupportedEvidenceTypes

protected Collection<Class<? extends Evidence>> getSupportedEvidenceTypes(String mechName)

Specified by:

getSupportedEvidenceTypes in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

getSupportedEvidenceAlgorithmNames

protected Collection<String> getSupportedEvidenceAlgorithmNames(Class<? extends AlgorithmEvidence> evidenceType,
                                                                String mechName)

Specified by:

getSupportedEvidenceAlgorithmNames in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

getSupportedCredentialTypes

protected Collection<Class<? extends Credential>> getSupportedCredentialTypes(String mechName)

Specified by:

getSupportedCredentialTypes in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

getSupportedCredentialAlgorithmNames

protected Collection<String> getSupportedCredentialAlgorithmNames(Class<? extends AlgorithmCredential> credentialType,
                                                                  String mechName)

Specified by:

getSupportedCredentialAlgorithmNames in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

usesCredentials

protected boolean usesCredentials(String mechName)

Description copied from class: AbstractMechanismAuthenticationFactory

Determine whether the given mechanism name needs credentials from a realm in order to authenticate.

Specified by:

usesCredentials in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

Parameters:

mechName - the mechanism name

Returns:

true if the mechanism requires realm credential support, false if it does not

builder

public static SaslAuthenticationFactory.Builder builder()

Obtain a new SaslAuthenticationFactory.Builder capable of building a SaslAuthenticationFactory.

Returns:

a new SaslAuthenticationFactory.Builder capable of building a SaslAuthenticationFactory.