public class UserCredentialStoreManager extends AbstractStorageManager<UserStorageProvider,UserStorageProviderModel> implements UserCredentialManager.Streams, OnUserCache
UserCredentialManager.Streams
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.
|
Stream<String> |
getConfiguredUserStorageCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the credential types provided by the user storage where the specified user is stored.
|
static <T> Stream<T> |
getCredentialProviders(KeycloakSession session,
Class<T> type) |
Stream<String> |
getDisableableCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the credential types that can be disabled by means of the
UserCredentialManager.disableCredentialType(RealmModel, UserModel, String)
method. |
CredentialModel |
getStoredCredentialById(RealmModel realm,
UserModel user,
String id) |
CredentialModel |
getStoredCredentialByNameAndType(RealmModel realm,
UserModel user,
String name,
String type) |
Stream<CredentialModel> |
getStoredCredentialsByTypeStream(RealmModel realm,
UserModel user,
String type)
Obtains the stored credentials associated with the specified user that match the specified type.
|
Stream<CredentialModel> |
getStoredCredentialsStream(RealmModel realm,
UserModel user)
Obtains the stored credentials associated with the specified user.
|
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.
|
consumeEnabledStorageProvidersWithTimeout, flatMapEnabledStorageProvidersWithTimeout, getEnabledStorageProviders, getStorageProviderFactory, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderInstance, getStorageProviderModel, getStorageProviderModels, getStorageProviderTimeout, mapEnabledStorageProvidersWithTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getConfiguredUserStorageCredentialTypes, getDisableableCredentialTypes
getStoredCredentials, getStoredCredentialsByType
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 Stream<CredentialModel> getStoredCredentialsStream(RealmModel realm, UserModel user)
UserCredentialStore
getStoredCredentialsStream
in interface UserCredentialStore
getStoredCredentialsStream
in interface UserCredentialStore.Streams
realm
- a reference to the realm.user
- the user whose credentials are being searched.Stream
of credentials.public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)
UserCredentialStore
getStoredCredentialsByTypeStream
in interface UserCredentialStore
getStoredCredentialsByTypeStream
in interface UserCredentialStore.Streams
realm
- a reference to the realm.user
- the user whose credentials are being searched.type
- the type of credentials being searched.Stream
of credentials.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> Stream<T> getCredentialProviders(KeycloakSession session, 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 Stream<String> getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
UserCredentialManager
UserCredentialManager.disableCredentialType(RealmModel, UserModel, String)
method.getDisableableCredentialTypesStream
in interface UserCredentialManager
getDisableableCredentialTypesStream
in interface UserCredentialManager.Streams
realm
- a reference to the realm.user
- the user whose credentials are being searched.Stream
of credential types.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 Stream<String> getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)
UserCredentialManager
getConfiguredUserStorageCredentialTypesStream
in interface UserCredentialManager
getConfiguredUserStorageCredentialTypesStream
in interface UserCredentialManager.Streams
realm
- a reference to the realm.user
- a reference to the user.Stream
of credential types.Copyright © 2020 JBoss by Red Hat. All rights reserved.