public class UserCredentialStoreManager extends Object implements UserCredentialManager, OnUserCache
Modifier and Type | Field and Description |
---|---|
protected KeycloakSession |
session |
Constructor and Description |
---|
UserCredentialStoreManager(KeycloakSession session) |
Modifier and Type | Method and Description |
---|---|
CredentialValidationOutput |
authenticate(KeycloakSession session,
RealmModel realm,
CredentialInput input)
Given a CredentialInput, authenticate the user.
|
void |
close() |
CredentialModel |
createCredential(RealmModel realm,
UserModel user,
CredentialModel cred) |
CredentialModel |
createCredentialThroughProvider(RealmModel realm,
UserModel user,
CredentialModel model)
Creates a credential from the credentialModel, by looping through the providers to find a match for the type
|
void |
disableCredentialType(RealmModel realm,
UserModel user,
String credentialType)
Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through
each CredentialProvider.
|
List<String> |
getConfiguredUserStorageCredentialTypes(RealmModel realm,
UserModel user)
Return credential types, which are provided by the user storage where user is stored.
|
static <T> List<T> |
getCredentialProviders(KeycloakSession session,
RealmModel realm,
Class<T> type) |
Set<String> |
getDisableableCredentialTypes(RealmModel realm,
UserModel user)
Returns a set of credential types that can be disabled by disableCredentialType() method
|
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)
Checks to see if user has credential type configured.
|
boolean |
isConfiguredLocally(RealmModel realm,
UserModel user,
String type)
Only loops through each CredentialProvider to see if credential type is configured for the user.
|
boolean |
isValid(RealmModel realm,
UserModel user,
CredentialInput... inputs)
Validates list of credentials.
|
boolean |
isValid(RealmModel realm,
UserModel user,
List<CredentialInput> inputs)
Validates list of credentials.
|
boolean |
moveCredentialTo(RealmModel realm,
UserModel user,
String id,
String newPreviousCredentialId) |
void |
onCache(RealmModel realm,
CachedUserModel user,
UserModel delegate) |
boolean |
removeStoredCredential(RealmModel realm,
UserModel user,
String id) |
boolean |
updateCredential(RealmModel realm,
UserModel user,
CredentialInput input)
Updates a credential.
|
void |
updateCredential(RealmModel realm,
UserModel user,
CredentialModel cred) |
void |
updateCredentialLabel(RealmModel realm,
UserModel user,
String credentialId,
String userLabel)
Updates the credential label and invalidates the cache for the user.
|
protected KeycloakSession session
public UserCredentialStoreManager(KeycloakSession session)
protected UserCredentialStore getStoreForUser(UserModel user)
public void updateCredential(RealmModel realm, UserModel user, CredentialModel cred)
updateCredential
in interface UserCredentialStore
public CredentialModel createCredential(RealmModel realm, UserModel user, CredentialModel cred)
createCredential
in interface UserCredentialStore
public boolean removeStoredCredential(RealmModel realm, UserModel user, String id)
removeStoredCredential
in interface UserCredentialStore
public CredentialModel getStoredCredentialById(RealmModel realm, UserModel user, String id)
getStoredCredentialById
in interface UserCredentialStore
public List<CredentialModel> getStoredCredentials(RealmModel realm, UserModel user)
getStoredCredentials
in interface UserCredentialStore
public List<CredentialModel> getStoredCredentialsByType(RealmModel realm, UserModel user, String type)
getStoredCredentialsByType
in interface UserCredentialStore
public CredentialModel getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
getStoredCredentialByNameAndType
in interface UserCredentialStore
public boolean moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
moveCredentialTo
in interface UserCredentialStore
public boolean isValid(RealmModel realm, UserModel user, CredentialInput... inputs)
UserCredentialManager
isValid
in interface UserCredentialManager
public CredentialModel createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model)
UserCredentialManager
createCredentialThroughProvider
in interface UserCredentialManager
public void updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel)
UserCredentialManager
updateCredentialLabel
in interface UserCredentialManager
public boolean isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs)
UserCredentialManager
isValid
in interface UserCredentialManager
public static <T> List<T> getCredentialProviders(KeycloakSession session, RealmModel realm, Class<T> type)
public boolean updateCredential(RealmModel realm, UserModel user, CredentialInput input)
UserCredentialManager
updateCredential
in interface UserCredentialManager
public void disableCredentialType(RealmModel realm, UserModel user, String credentialType)
UserCredentialManager
disableCredentialType
in interface UserCredentialManager
public Set<String> getDisableableCredentialTypes(RealmModel realm, UserModel user)
UserCredentialManager
getDisableableCredentialTypes
in interface UserCredentialManager
public boolean isConfiguredFor(RealmModel realm, UserModel user, String type)
UserCredentialManager
isConfiguredFor
in interface UserCredentialManager
public boolean isConfiguredLocally(RealmModel realm, UserModel user, String type)
UserCredentialManager
isConfiguredLocally
in interface UserCredentialManager
public CredentialValidationOutput authenticate(KeycloakSession session, RealmModel realm, CredentialInput input)
UserCredentialManager
authenticate
in interface UserCredentialManager
public void onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
onCache
in interface OnUserCache
public List<String> getConfiguredUserStorageCredentialTypes(RealmModel realm, UserModel user)
UserCredentialManager
getConfiguredUserStorageCredentialTypes
in interface UserCredentialManager
Copyright © 2020 JBoss by Red Hat. All rights reserved.