Package org.wildfly.security.auth.realm.jdbc

Interface KeyMapper

All Superinterfaces:

ColumnMapper

All Known Implementing Classes:

PasswordKeyMapper

public interface KeyMapper
extends ColumnMapper

A key mapper is responsible to map data from a column in a table to a specific credential type.

Author:

Pedro Igor

Method Summary

Modifier and Type	Method	Description
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec)	Determine whether a credential of the given type and algorithm is definitely obtainable, possibly obtainable (for] some identities), or definitely not obtainable.
default SupportLevel	getEvidenceVerifySupport(Class<? extends Evidence> evidenceType, String algorithmName)	Determine whether a given type of evidence is definitely verifiable, possibly verifiable (for some identities), or definitely not verifiable.
Credential	map(ResultSet resultSet, Supplier<Provider[]> providers)	Maps the given ResultSet to some internal representation.

Method Detail

getCredentialAcquireSupport

SupportLevel getCredentialAcquireSupport(Class<? extends Credential> credentialType,
                                         String algorithmName,
                                         AlgorithmParameterSpec parameterSpec)

Determine whether a credential of the given type and algorithm is definitely obtainable, possibly obtainable (for] some identities), or definitely not obtainable.

Parameters:

credentialType - the exact credential type (must not be null)

algorithmName - the algorithm name, or null if any algorithm is acceptable or the credential type does not support algorithm names

parameterSpec - the algorithm parameters to match, or null if any parameters are acceptable or the credential type does not support algorithm parameters

Returns:

the level of support for this credential

getEvidenceVerifySupport

default SupportLevel getEvidenceVerifySupport(Class<? extends Evidence> evidenceType,
                                              String algorithmName)

Determine whether a given type of evidence is definitely verifiable, possibly verifiable (for some identities), or definitely not verifiable.

Parameters:

evidenceType - the type of evidence to be verified (must not be null)

algorithmName - the algorithm name, or null if any algorithm is acceptable or the evidence type does not support algorithm names

Returns:

the level of support for this evidence type

map

Credential map(ResultSet resultSet,
               Supplier<Provider[]> providers)
        throws SQLException

Description copied from interface: ColumnMapper

Maps the given ResultSet to some internal representation.

Specified by:

map in interface ColumnMapper

Parameters:

resultSet - the result set previously created based on a query

providers - the providers to use if required

Returns:

the resulting object mapped from the given ResultSet

Throws:

SQLException - if any error occurs when manipulating the given ResultSet