Package org.keycloak.credential

Class UserCredentialManager

java.lang.Object

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

org.keycloak.credential.UserCredentialManager

All Implemented Interfaces:

SubjectCredentialManager

public class UserCredentialManager
extends AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>
implements SubjectCredentialManager

Handling credentials for a given user for the store.

Author:

Alexander Schwartz

Constructor Summary

Constructors

Constructor	Description
UserCredentialManager(KeycloakSession session, RealmModel realm, UserModel user)

Method Summary

Modifier and Type	Method	Description
CredentialModel	createCredentialThroughProvider(CredentialModel model)
CredentialModel	createStoredCredential(CredentialModel cred)
void	disableCredentialType(String credentialType)
Stream<String>	getConfiguredUserStorageCredentialTypesStream()
Stream<String>	getDisableableCredentialTypesStream()
Stream<CredentialModel>	getFederatedCredentialsStream()
CredentialModel	getStoredCredentialById(String id)
CredentialModel	getStoredCredentialByNameAndType(String name, String type)
Stream<CredentialModel>	getStoredCredentialsByTypeStream(String type)
Stream<CredentialModel>	getStoredCredentialsStream()
boolean	isConfiguredFor(String type)
boolean	isConfiguredLocally(String type)
boolean	isValid(List<CredentialInput> inputs)
boolean	moveStoredCredentialTo(String id, String newPreviousCredentialId)
boolean	removeStoredCredentialById(String id)
boolean	updateCredential(CredentialInput input)
void	updateCredentialLabel(String credentialId, String userLabel)
void	updateStoredCredential(CredentialModel cred)

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.SubjectCredentialManager

getCredentials, isValid

Constructor Details

UserCredentialManager

public UserCredentialManager(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Method Details

isValid

public boolean isValid(List<CredentialInput> inputs)

Specified by:

isValid in interface SubjectCredentialManager

updateCredential

public boolean updateCredential(CredentialInput input)

Specified by:

updateCredential in interface SubjectCredentialManager

updateStoredCredential

public void updateStoredCredential(CredentialModel cred)

Specified by:

updateStoredCredential in interface SubjectCredentialManager

createStoredCredential

public CredentialModel createStoredCredential(CredentialModel cred)

Specified by:

createStoredCredential in interface SubjectCredentialManager

removeStoredCredentialById

public boolean removeStoredCredentialById(String id)

Specified by:

removeStoredCredentialById in interface SubjectCredentialManager

getStoredCredentialById

public CredentialModel getStoredCredentialById(String id)

Specified by:

getStoredCredentialById in interface SubjectCredentialManager

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream()

Specified by:

getStoredCredentialsStream in interface SubjectCredentialManager

getFederatedCredentialsStream

public Stream<CredentialModel> getFederatedCredentialsStream()

Specified by:

getFederatedCredentialsStream in interface SubjectCredentialManager

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(String type)

Specified by:

getStoredCredentialsByTypeStream in interface SubjectCredentialManager

getStoredCredentialByNameAndType

public CredentialModel getStoredCredentialByNameAndType(String name,
 String type)

Specified by:

getStoredCredentialByNameAndType in interface SubjectCredentialManager

moveStoredCredentialTo

public boolean moveStoredCredentialTo(String id,
 String newPreviousCredentialId)

Specified by:

moveStoredCredentialTo in interface SubjectCredentialManager

updateCredentialLabel

public void updateCredentialLabel(String credentialId,
 String userLabel)

Specified by:

updateCredentialLabel in interface SubjectCredentialManager

disableCredentialType

public void disableCredentialType(String credentialType)

Specified by:

disableCredentialType in interface SubjectCredentialManager

getDisableableCredentialTypesStream

public Stream<String> getDisableableCredentialTypesStream()

Specified by:

getDisableableCredentialTypesStream in interface SubjectCredentialManager

isConfiguredFor

public boolean isConfiguredFor(String type)

Specified by:

isConfiguredFor in interface SubjectCredentialManager

isConfiguredLocally

public boolean isConfiguredLocally(String type)

Specified by:

isConfiguredLocally in interface SubjectCredentialManager

getConfiguredUserStorageCredentialTypesStream

public Stream<String> getConfiguredUserStorageCredentialTypesStream()

Specified by:

getConfiguredUserStorageCredentialTypesStream in interface SubjectCredentialManager

createCredentialThroughProvider

public CredentialModel createCredentialThroughProvider(CredentialModel model)

Specified by:

createCredentialThroughProvider in interface SubjectCredentialManager