org.keycloak.credential

Class UserCredentialStoreManager

java.lang.Object

org.keycloak.credential.UserCredentialStoreManager

All Implemented Interfaces:

UserCredentialStore, OnUserCache, UserCredentialManager, Provider

public class UserCredentialStoreManager
extends Object
implements UserCredentialManager, OnUserCache

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected KeycloakSession	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)
void	disableCredential(RealmModel realm, UserModel user, String credentialType)
protected <T> List<T>	getCredentialProviders(RealmModel realm, Class<T> type)
CredentialModel	getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
List<CredentialModel>	getStoredCredentials(RealmModel realm, UserModel user)
List<CredentialModel>	getStoredCredentialsByType(RealmModel realm, UserModel user, String type)
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)
void	onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
boolean	removeStoredCredential(RealmModel realm, UserModel user, String id)
void	updateCredential(RealmModel realm, UserModel user, CredentialInput input)
void	updateCredential(RealmModel realm, UserModel user, CredentialModel cred)

Methods inherited from class java.lang.Object

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

Field Detail

session

protected KeycloakSession session

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

getStoredCredentials

public List<CredentialModel> getStoredCredentials(RealmModel realm,
                                                  UserModel user)

Specified by:

getStoredCredentials in interface UserCredentialStore

getStoredCredentialsByType

public List<CredentialModel> getStoredCredentialsByType(RealmModel realm,
                                                        UserModel user,
                                                        String type)

Specified by:

getStoredCredentialsByType in interface UserCredentialStore

getStoredCredentialByNameAndType

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

Specified by:

getStoredCredentialByNameAndType in interface UserCredentialStore

isValid

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

Specified by:

isValid in interface UserCredentialManager

isValid

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

Specified by:

isValid in interface UserCredentialManager

getCredentialProviders

protected <T> List<T> getCredentialProviders(RealmModel realm,
                                             Class<T> type)

updateCredential

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

Specified by:

updateCredential in interface UserCredentialManager

disableCredential

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

Specified by:

disableCredential in interface UserCredentialManager

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

close

public void close()

Specified by:

close in interface Provider