Package org.keycloak.models.cache.infinispan

Class SubjectCredentialManagerCacheAdapter

java.lang.Object

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

org.keycloak.credential.UserCredentialManager

org.keycloak.models.cache.infinispan.SubjectCredentialManagerCacheAdapter

All Implemented Interfaces:

SubjectCredentialManager

public abstract class SubjectCredentialManagerCacheAdapter
extends UserCredentialManager

Author:

Alexander Schwartz

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CredentialModel	createCredentialThroughProvider(CredentialModel model)
CredentialModel	createStoredCredential(CredentialModel cred)	Updates a credential of the entity with an updated CredentialModel.
void	disableCredentialType(String credentialType)	Disable a credential by type.
abstract void	invalidateCacheForEntity()
boolean	moveStoredCredentialTo(String id, String newPreviousCredentialId)	Re-order the stored credentials.
boolean	removeStoredCredentialById(String id)	Updates a credential of the entity with an updated CredentialModel.
boolean	updateCredential(CredentialInput input)	Updates a credential of the entity with the inputs provided by the entity.
void	updateCredentialLabel(String credentialId, String userLabel)	Update the label for a stored credentials chosen by the owner of the entity.
void	updateStoredCredential(CredentialModel cred)	Updates a credential of the entity with an updated CredentialModel.

Methods inherited from class org.keycloak.credential.UserCredentialManager

getConfiguredUserStorageCredentialTypesStream, getDisableableCredentialTypesStream, getFederatedCredentialsStream, getStoredCredentialById, getStoredCredentialByNameAndType, getStoredCredentialsByTypeStream, getStoredCredentialsStream, isConfiguredFor, isConfiguredLocally, isValid

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

SubjectCredentialManagerCacheAdapter

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

Method Details

invalidateCacheForEntity

public abstract void invalidateCacheForEntity()

updateCredential

public boolean updateCredential(CredentialInput input)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with the inputs provided by the entity.

Specified by:

updateCredential in interface SubjectCredentialManager

Overrides:

updateCredential in class UserCredentialManager

Returns:

true if credentials have been updated successfully

updateStoredCredential

public void updateStoredCredential(CredentialModel cred)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with an updated CredentialModel. Usually called by a CredentialProvider.

Specified by:

updateStoredCredential in interface SubjectCredentialManager

Overrides:

updateStoredCredential in class UserCredentialManager

createStoredCredential

public CredentialModel createStoredCredential(CredentialModel cred)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with an updated CredentialModel. Usually called by a CredentialProvider.

Specified by:

createStoredCredential in interface SubjectCredentialManager

Overrides:

createStoredCredential in class UserCredentialManager

removeStoredCredentialById

public boolean removeStoredCredentialById(String id)

Description copied from interface: SubjectCredentialManager

Updates a credential of the entity with an updated CredentialModel. Usually called by a CredentialProvider, or from the account management when a user removes, for example, an OTP token.

Specified by:

removeStoredCredentialById in interface SubjectCredentialManager

Overrides:

removeStoredCredentialById in class UserCredentialManager

moveStoredCredentialTo

public boolean moveStoredCredentialTo(String id,
 String newPreviousCredentialId)

Description copied from interface: SubjectCredentialManager

Re-order the stored credentials.

Specified by:

moveStoredCredentialTo in interface SubjectCredentialManager

Overrides:

moveStoredCredentialTo in class UserCredentialManager

updateCredentialLabel

public void updateCredentialLabel(String credentialId,
 String userLabel)

Description copied from interface: SubjectCredentialManager

Update the label for a stored credentials chosen by the owner of the entity.

Specified by:

updateCredentialLabel in interface SubjectCredentialManager

Overrides:

updateCredentialLabel in class UserCredentialManager

disableCredentialType

public void disableCredentialType(String credentialType)

Description copied from interface: SubjectCredentialManager

Disable a credential by type.

Specified by:

disableCredentialType in interface SubjectCredentialManager

Overrides:

disableCredentialType in class UserCredentialManager

createCredentialThroughProvider

public CredentialModel createCredentialThroughProvider(CredentialModel model)

Specified by:

createCredentialThroughProvider in interface SubjectCredentialManager

Overrides:

createCredentialThroughProvider in class UserCredentialManager