org.keycloak.credential

Class PasswordCredentialProvider

java.lang.Object

org.keycloak.credential.PasswordCredentialProvider

All Implemented Interfaces:

CredentialInputUpdater, CredentialInputValidator, CredentialProvider, OnUserCache, Provider

public class PasswordCredentialProvider
extends Object
implements CredentialProvider, CredentialInputValidator, CredentialInputUpdater, OnUserCache

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASSWORD_CACHE_KEY
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor and Description
PasswordCredentialProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method and Description
void	disableCredentialType(RealmModel realm, UserModel user, String credentialType)
protected void	expirePassword(RealmModel realm, UserModel user, PasswordPolicy policy)
protected UserCredentialStore	getCredentialStore()
Set<String>	getDisableableCredentialTypes(RealmModel realm, UserModel user)
protected PasswordHashProvider	getHashProvider(PasswordPolicy policy)
CredentialModel	getPassword(RealmModel realm, UserModel user)
boolean	isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	isValid(RealmModel realm, UserModel user, CredentialInput input)
void	onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
boolean	supportsCredentialType(String credentialType)
boolean	updateCredential(RealmModel realm, UserModel user, CredentialInput input)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.credential.CredentialProvider

close

Field Detail

PASSWORD_CACHE_KEY

public static final String PASSWORD_CACHE_KEY

session

protected KeycloakSession session

Constructor Detail

PasswordCredentialProvider

public PasswordCredentialProvider(KeycloakSession session)

Method Detail

getCredentialStore

protected UserCredentialStore getCredentialStore()

getPassword

public CredentialModel getPassword(RealmModel realm,
                                   UserModel user)

updateCredential

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

Specified by:

updateCredential in interface CredentialInputUpdater

expirePassword

protected void expirePassword(RealmModel realm,
                              UserModel user,
                              PasswordPolicy policy)

getHashProvider

protected PasswordHashProvider getHashProvider(PasswordPolicy policy)

disableCredentialType

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

Specified by:

disableCredentialType in interface CredentialInputUpdater

getDisableableCredentialTypes

public Set<String> getDisableableCredentialTypes(RealmModel realm,
                                                 UserModel user)

Specified by:

getDisableableCredentialTypes in interface CredentialInputUpdater

supportsCredentialType

public boolean supportsCredentialType(String credentialType)

Specified by:

supportsCredentialType in interface CredentialInputUpdater

Specified by:

supportsCredentialType in interface CredentialInputValidator

isConfiguredFor

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

Specified by:

isConfiguredFor in interface CredentialInputValidator

isValid

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

Specified by:

isValid in interface CredentialInputValidator

onCache

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

Specified by:

onCache in interface OnUserCache