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 final class	SaslAuthenticationFactory.Builder	A builder for SASL server factory configurations.

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	isKnownMechanism(String mechName)	Determine whether the given mechanism name is known to WildFly Elytron.
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, getMechanismConfigurationSelector, 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

Method Details

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

isKnownMechanism

protected boolean isKnownMechanism(String mechName)

Description copied from class: AbstractMechanismAuthenticationFactory

Determine whether the given mechanism name is known to WildFly Elytron. If it is not known we can't filter it out as we can not rely upon the other methods being able to return accurate responses about the mechanisms requirements. As this is a new method and other implementations may not know to override this has a default implementation to match the current behaviour i.e. assume we know about all mechanisms.

Overrides:

isKnownMechanism in class AbstractMechanismAuthenticationFactory<SaslServer,SaslServerFactory,SaslException>

Parameters:

mechName - the mechanism name

Returns:

true if the mechanism is known to WildFly Elytron, false if it is 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.