Package org.keycloak.credential

Class UserCredentialManager

java.lang.Object

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

org.keycloak.credential.UserCredentialManager

All Implemented Interfaces:

org.keycloak.models.SubjectCredentialManager, org.keycloak.models.UserCredentialManager

public class UserCredentialManager
extends AbstractStorageManager<UserStorageProvider,UserStorageProviderModel>
implements org.keycloak.models.UserCredentialManager

Handling credentials for a given user for the store.

Author:

Alexander Schwartz

Constructor Summary

Constructors

Constructor	Description
UserCredentialManager(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)	It is not recommended to use this method directly from your user-storage providers!

Method Summary

Modifier and Type	Method	Description
org.keycloak.credential.CredentialModel	createCredentialThroughProvider(org.keycloak.credential.CredentialModel model)
org.keycloak.credential.CredentialModel	createStoredCredential(org.keycloak.credential.CredentialModel cred)
void	disableCredentialType(String credentialType)
Stream<String>	getConfiguredUserStorageCredentialTypesStream()
Stream<String>	getDisableableCredentialTypesStream()
Stream<org.keycloak.credential.CredentialModel>	getFederatedCredentialsStream()
Stream<org.keycloak.credential.CredentialModel>	getFirstFactorCredentialsStream()
org.keycloak.credential.CredentialModel	getStoredCredentialById(String id)
org.keycloak.credential.CredentialModel	getStoredCredentialByNameAndType(String name, String type)
Stream<org.keycloak.credential.CredentialModel>	getStoredCredentialsByTypeStream(String type)
Stream<org.keycloak.credential.CredentialModel>	getStoredCredentialsStream()
boolean	isConfiguredFor(String type)
boolean	isConfiguredLocally(String type)
boolean	isValid(List<org.keycloak.credential.CredentialInput> inputs)
boolean	moveStoredCredentialTo(String id, String newPreviousCredentialId)
boolean	removeStoredCredentialById(String id)
boolean	updateCredential(org.keycloak.credential.CredentialInput input)
void	updateCredentialLabel(String credentialId, String userLabel)
void	updateStoredCredential(org.keycloak.credential.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(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.RealmModel realm,
 org.keycloak.models.UserModel user)

It is not recommended to use this method directly from your user-storage providers! Please use session.users().getUserCredentialManager(user) instead.

Method Details

isValid

public boolean isValid(List<org.keycloak.credential.CredentialInput> inputs)

Specified by:

isValid in interface org.keycloak.models.SubjectCredentialManager

updateCredential

public boolean updateCredential(org.keycloak.credential.CredentialInput input)

Specified by:

updateCredential in interface org.keycloak.models.SubjectCredentialManager

updateStoredCredential

public void updateStoredCredential(org.keycloak.credential.CredentialModel cred)

Specified by:

updateStoredCredential in interface org.keycloak.models.SubjectCredentialManager

createStoredCredential

public org.keycloak.credential.CredentialModel createStoredCredential(org.keycloak.credential.CredentialModel cred)

Specified by:

createStoredCredential in interface org.keycloak.models.SubjectCredentialManager

removeStoredCredentialById

public boolean removeStoredCredentialById(String id)

Specified by:

removeStoredCredentialById in interface org.keycloak.models.SubjectCredentialManager

getStoredCredentialById

public org.keycloak.credential.CredentialModel getStoredCredentialById(String id)

Specified by:

getStoredCredentialById in interface org.keycloak.models.SubjectCredentialManager

getStoredCredentialsStream

public Stream<org.keycloak.credential.CredentialModel> getStoredCredentialsStream()

Specified by:

getStoredCredentialsStream in interface org.keycloak.models.SubjectCredentialManager

getFederatedCredentialsStream

public Stream<org.keycloak.credential.CredentialModel> getFederatedCredentialsStream()

Specified by:

getFederatedCredentialsStream in interface org.keycloak.models.SubjectCredentialManager

getStoredCredentialsByTypeStream

public Stream<org.keycloak.credential.CredentialModel> getStoredCredentialsByTypeStream(String type)

Specified by:

getStoredCredentialsByTypeStream in interface org.keycloak.models.SubjectCredentialManager

getStoredCredentialByNameAndType

public org.keycloak.credential.CredentialModel getStoredCredentialByNameAndType(String name,
 String type)

Specified by:

getStoredCredentialByNameAndType in interface org.keycloak.models.SubjectCredentialManager

moveStoredCredentialTo

public boolean moveStoredCredentialTo(String id,
 String newPreviousCredentialId)

Specified by:

moveStoredCredentialTo in interface org.keycloak.models.SubjectCredentialManager

updateCredentialLabel

public void updateCredentialLabel(String credentialId,
 String userLabel)

Specified by:

updateCredentialLabel in interface org.keycloak.models.SubjectCredentialManager

disableCredentialType

public void disableCredentialType(String credentialType)

Specified by:

disableCredentialType in interface org.keycloak.models.SubjectCredentialManager

getDisableableCredentialTypesStream

public Stream<String> getDisableableCredentialTypesStream()

Specified by:

getDisableableCredentialTypesStream in interface org.keycloak.models.SubjectCredentialManager

isConfiguredFor

public boolean isConfiguredFor(String type)

Specified by:

isConfiguredFor in interface org.keycloak.models.SubjectCredentialManager

isConfiguredLocally

public boolean isConfiguredLocally(String type)

Specified by:

isConfiguredLocally in interface org.keycloak.models.SubjectCredentialManager

getConfiguredUserStorageCredentialTypesStream

public Stream<String> getConfiguredUserStorageCredentialTypesStream()

Specified by:

getConfiguredUserStorageCredentialTypesStream in interface org.keycloak.models.SubjectCredentialManager

createCredentialThroughProvider

public org.keycloak.credential.CredentialModel createCredentialThroughProvider(org.keycloak.credential.CredentialModel model)

Specified by:

createCredentialThroughProvider in interface org.keycloak.models.SubjectCredentialManager

getFirstFactorCredentialsStream

public Stream<org.keycloak.credential.CredentialModel> getFirstFactorCredentialsStream()

Specified by:

getFirstFactorCredentialsStream in interface org.keycloak.models.SubjectCredentialManager