org.keycloak.credential

Class UserCredentialStoreManager

java.lang.Object

org.keycloak.storage.AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>

org.keycloak.credential.UserCredentialStoreManager

All Implemented Interfaces:

UserCredentialStore, UserCredentialStore.Streams, OnUserCache, UserCredentialManager, UserCredentialManager.Streams, Provider

public class UserCredentialStoreManager
extends AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>
implements UserCredentialManager.Streams, OnUserCache

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.UserCredentialManager

UserCredentialManager.Streams

Field Summary

Fields inherited from class org.keycloak.storage.AbstractStorageManager

session

Constructor Summary

Constructors

Constructor and Description
UserCredentialStoreManager(KeycloakSession session)

Method Summary

Modifier and Type	Method and Description
CredentialValidationOutput	authenticate(KeycloakSession session, RealmModel realm, CredentialInput input)
void	close()
CredentialModel	createCredential(RealmModel realm, UserModel user, CredentialModel cred)
CredentialModel	createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model)
void	disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Stream<String>	getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)
static <T> Stream<T>	getCredentialProviders(KeycloakSession session, Class<T> type)
Stream<String>	getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
CredentialModel	getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
Stream<CredentialModel>	getStoredCredentialsStream(RealmModel realm, UserModel user)
protected UserCredentialStore	getStoreForUser(UserModel user)
boolean	isConfiguredFor(RealmModel realm, UserModel user, String type)
boolean	isConfiguredLocally(RealmModel realm, UserModel user, String type)
boolean	isValid(RealmModel realm, UserModel user, CredentialInput... inputs)
boolean	isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs)
boolean	moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
void	onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
boolean	removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	updateCredential(RealmModel realm, UserModel user, CredentialInput input)
void	updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel)

Methods inherited from class org.keycloak.storage.AbstractStorageManager

consumeEnabledStorageProvidersWithTimeout, flatMapEnabledStorageProvidersWithTimeout, getEnabledStorageProviders, getStorageProviderFactory, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderModel, getStorageProviderModels, getStorageProviderTimeout, mapEnabledStorageProvidersWithTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.UserCredentialManager.Streams

getConfiguredUserStorageCredentialTypes, getDisableableCredentialTypes

Methods inherited from interface org.keycloak.credential.UserCredentialStore.Streams

getStoredCredentials, getStoredCredentialsByType

Constructor Detail

UserCredentialStoreManager

public UserCredentialStoreManager(KeycloakSession session)

Method Detail

getStoreForUser

protected UserCredentialStore getStoreForUser(UserModel user)

updateCredential

public void updateCredential(RealmModel realm,
                             UserModel user,
                             CredentialModel cred)

Specified by:

updateCredential in interface UserCredentialStore

createCredential

public CredentialModel createCredential(RealmModel realm,
                                        UserModel user,
                                        CredentialModel cred)

Specified by:

createCredential in interface UserCredentialStore

removeStoredCredential

public boolean removeStoredCredential(RealmModel realm,
                                      UserModel user,
                                      String id)

Specified by:

removeStoredCredential in interface UserCredentialStore

getStoredCredentialById

public CredentialModel getStoredCredentialById(RealmModel realm,
                                               UserModel user,
                                               String id)

Specified by:

getStoredCredentialById in interface UserCredentialStore

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream(RealmModel realm,
                                                          UserModel user)

Specified by:

getStoredCredentialsStream in interface UserCredentialStore

Specified by:

getStoredCredentialsStream in interface UserCredentialStore.Streams

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm,
                                                                UserModel user,
                                                                String type)

Specified by:

getStoredCredentialsByTypeStream in interface UserCredentialStore

Specified by:

getStoredCredentialsByTypeStream in interface UserCredentialStore.Streams

getStoredCredentialByNameAndType

public CredentialModel getStoredCredentialByNameAndType(RealmModel realm,
                                                        UserModel user,
                                                        String name,
                                                        String type)

Specified by:

getStoredCredentialByNameAndType in interface UserCredentialStore

moveCredentialTo

public boolean moveCredentialTo(RealmModel realm,
                                UserModel user,
                                String id,
                                String newPreviousCredentialId)

Specified by:

moveCredentialTo in interface UserCredentialStore

isValid

public boolean isValid(RealmModel realm,
                       UserModel user,
                       CredentialInput... inputs)

Specified by:

isValid in interface UserCredentialManager

createCredentialThroughProvider

public CredentialModel createCredentialThroughProvider(RealmModel realm,
                                                       UserModel user,
                                                       CredentialModel model)

Specified by:

createCredentialThroughProvider in interface UserCredentialManager

updateCredentialLabel

public void updateCredentialLabel(RealmModel realm,
                                  UserModel user,
                                  String credentialId,
                                  String userLabel)

Specified by:

updateCredentialLabel in interface UserCredentialManager

isValid

public boolean isValid(RealmModel realm,
                       UserModel user,
                       List<CredentialInput> inputs)

Specified by:

isValid in interface UserCredentialManager

getCredentialProviders

public static <T> Stream<T> getCredentialProviders(KeycloakSession session,
                                                   Class<T> type)

updateCredential

public boolean updateCredential(RealmModel realm,
                                UserModel user,
                                CredentialInput input)

Specified by:

updateCredential in interface UserCredentialManager

disableCredentialType

public void disableCredentialType(RealmModel realm,
                                  UserModel user,
                                  String credentialType)

Specified by:

disableCredentialType in interface UserCredentialManager

getDisableableCredentialTypesStream

public Stream<String> getDisableableCredentialTypesStream(RealmModel realm,
                                                          UserModel user)

Specified by:

getDisableableCredentialTypesStream in interface UserCredentialManager

Specified by:

getDisableableCredentialTypesStream in interface UserCredentialManager.Streams

isConfiguredFor

public boolean isConfiguredFor(RealmModel realm,
                               UserModel user,
                               String type)

Specified by:

isConfiguredFor in interface UserCredentialManager

isConfiguredLocally

public boolean isConfiguredLocally(RealmModel realm,
                                   UserModel user,
                                   String type)

Specified by:

isConfiguredLocally in interface UserCredentialManager

authenticate

public CredentialValidationOutput authenticate(KeycloakSession session,
                                               RealmModel realm,
                                               CredentialInput input)

Specified by:

authenticate in interface UserCredentialManager

onCache

public void onCache(RealmModel realm,
                    CachedUserModel user,
                    UserModel delegate)

Specified by:

onCache in interface OnUserCache

getConfiguredUserStorageCredentialTypesStream

public Stream<String> getConfiguredUserStorageCredentialTypesStream(RealmModel realm,
                                                                    UserModel user)

Specified by:

getConfiguredUserStorageCredentialTypesStream in interface UserCredentialManager

Specified by:

getConfiguredUserStorageCredentialTypesStream in interface UserCredentialManager.Streams

close

public void close()

Specified by:

close in interface Provider