Package org.keycloak.models.jpa

Class JpaUserCredentialStore

java.lang.Object

org.keycloak.models.jpa.JpaUserCredentialStore

All Implemented Interfaces:

UserCredentialStore, Provider

public class JpaUserCredentialStore
extends Object
implements UserCredentialStore

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected final jakarta.persistence.EntityManager	em
protected static final org.jboss.logging.Logger	logger
static final int	PRIORITY_DIFFERENCE

Constructor Summary

Constructors

Constructor	Description
JpaUserCredentialStore(KeycloakSession session, jakarta.persistence.EntityManager em)

Method Summary

Modifier and Type	Method	Description
void	close()
CredentialModel	createCredential(RealmModel realm, UserModel user, CredentialModel cred)
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.
boolean	moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	removeStoredCredential(RealmModel realm, UserModel user, String id)	Removes credential with the id for the user.
void	updateCredential(RealmModel realm, UserModel user, CredentialModel cred)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PRIORITY_DIFFERENCE

public static final int PRIORITY_DIFFERENCE

See Also:

• Constant Field Values

logger

protected static final org.jboss.logging.Logger logger

em

protected final jakarta.persistence.EntityManager em

Constructor Details

JpaUserCredentialStore

public JpaUserCredentialStore(KeycloakSession session,
 jakarta.persistence.EntityManager em)

Method Details

updateCredential

public void updateCredential(RealmModel realm,
 UserModel user,
 CredentialModel cred)

Specified by:

updateCredential in interface UserCredentialStore

createCredential

public CredentialModel createCredential(RealmModel realm,
 UserModel user,
 CredentialModel cred)

Specified by:

createCredential in interface UserCredentialStore

removeStoredCredential

public boolean removeStoredCredential(RealmModel realm,
 UserModel user,
 String id)

Description copied from interface: UserCredentialStore

Removes credential with the id for the user.

Specified by:

removeStoredCredential in interface UserCredentialStore

Parameters:

realm - realm.

user - user

id - id

Returns:

true if the credential was removed, false otherwise TODO: Make this method return Boolean so that store can return "I don't know" answer, this can be used for example in async stores

getStoredCredentialById

public CredentialModel getStoredCredentialById(RealmModel realm,
 UserModel user,
 String id)

Specified by:

getStoredCredentialById in interface UserCredentialStore

getStoredCredentialsStream

public Stream<CredentialModel> getStoredCredentialsStream(RealmModel realm,
 UserModel user)

Description copied from interface: UserCredentialStore

Obtains the stored credentials associated with the specified user.

Specified by:

getStoredCredentialsStream in interface UserCredentialStore

Parameters:

realm - a reference to the realm.

user - the user whose credentials are being searched.

Returns:

a non-null Stream of credentials.

getStoredCredentialsByTypeStream

public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm,
 UserModel user,
 String type)

Description copied from interface: UserCredentialStore

Obtains the stored credentials associated with the specified user that match the specified type.

Specified by:

getStoredCredentialsByTypeStream in interface UserCredentialStore

Parameters:

realm - a reference to the realm.

user - the user whose credentials are being searched.

type - the type of credentials being searched.

Returns:

a non-null Stream of credentials.

getStoredCredentialByNameAndType

public CredentialModel getStoredCredentialByNameAndType(RealmModel realm,
 UserModel user,
 String name,
 String type)

Specified by:

getStoredCredentialByNameAndType in interface UserCredentialStore

close

public void close()

Specified by:

close in interface Provider

moveCredentialTo

public boolean moveCredentialTo(RealmModel realm,
 UserModel user,
 String id,
 String newPreviousCredentialId)

Specified by:

moveCredentialTo in interface UserCredentialStore