org.wildfly.security.credential.source

Class CredentialStoreCredentialSource

java.lang.Object

org.wildfly.security.credential.source.CredentialStoreCredentialSource

All Implemented Interfaces:

CredentialSource

public final class CredentialStoreCredentialSource
extends Object
implements CredentialSource

A credential source which is backed by an entry in a credential store.

Author:

David M. Lloyd, Peter Skopek

Field Summary

Fields inherited from interface org.wildfly.security.credential.source.CredentialSource

NONE

Constructor Summary

Constructors

Constructor and Description
CredentialStoreCredentialSource(CredentialStore credentialStore, String alias) Construct a new instance.
CredentialStoreCredentialSource(SecurityFactory<CredentialStore> credentialStoreFactory, String alias) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
<C extends Credential> C	getCredential(Class<C> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec) Acquire a credential of the given type.
SupportLevel	getCredentialAcquireSupport(Class<? extends Credential> credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec) Determine whether a given credential is definitely obtainable, possibly obtainable, or definitely not obtainable.

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.credential.source.CredentialSource

applyToCredential, applyToCredential, applyToCredential, fromSecurityFactory, getCredential, getCredential, getCredentialAcquireSupport, getCredentialAcquireSupport, with, without, without, without

Constructor Detail

CredentialStoreCredentialSource

public CredentialStoreCredentialSource(SecurityFactory<CredentialStore> credentialStoreFactory,
                                       String alias)

Construct a new instance.

Parameters:

credentialStoreFactory - the credential store factory (must not be null)

alias - the credential store factory alias (must not be null)

CredentialStoreCredentialSource

public CredentialStoreCredentialSource(CredentialStore credentialStore,
                                       String alias)

Construct a new instance.

Parameters:

credentialStore - the literal credential store (must not be null)

alias - the credential store factory alias (must not be null)

Method Detail

getCredentialAcquireSupport

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

Description copied from interface: CredentialSource

Determine whether a given credential is definitely obtainable, possibly obtainable, or definitely not obtainable.

Specified by:

getCredentialAcquireSupport in interface CredentialSource

Parameters:

credentialType - the credential type class (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 type (not null)

Throws:

IOException - if the credential source failed to determine the support level

getCredential

public <C extends Credential> C getCredential(Class<C> credentialType,
                                              String algorithmName,
                                              AlgorithmParameterSpec parameterSpec)
                                       throws IOException

Description copied from interface: CredentialSource

Acquire a credential of the given type. The credential type is defined by its Class and an optional algorithmName. If the algorithm name is not given, then the query is performed for any algorithm of the given type.

Specified by:

getCredential in interface CredentialSource

Type Parameters:

C - the credential type

Parameters:

credentialType - the credential type class (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 credential, or null if the principal has no credential of that type

Throws:

IOException - if the realm is not able to handle requests for any reason