org.keycloak.models.utils

Class KeycloakModelUtils

java.lang.Object

org.keycloak.models.utils.KeycloakModelUtils

public final class KeycloakModelUtils
extends Object

Set of helper methods, which are useful in various model implementations.

Author:

Marek Posolda

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkKerberosCredential(RealmModel realm, UserFederationProviderModel model) Automatically add "kerberos" to required realm credentials if it's supported by saved provider
static ClientModel	createClient(RealmModel realm, String name)
static UserFederationMapperModel	createUserFederationMapperModel(String name, String federationProviderId, String mapperType, String... config)
static void	ensureUniqueDisplayName(String displayName, UserFederationProviderModel myProvider, List<UserFederationProviderModel> federationProviders) Ensure that displayName of myProvider (if not null) is unique and there is no other provider with same displayName in the list.
static UserModel	findUserByNameOrEmail(KeycloakSession session, RealmModel realm, String username) Try to find user by given username.
static UserFederationProviderModel	findUserFederationProviderByDisplayName(String displayName, RealmModel realm)
static UserFederationProviderModel	findUserFederationProviderById(String fedProviderId, RealmModel realm)
static void	generateClientKeyPairCertificate(ClientModel client)
static String	generateCodeSecret()
static String	generateId()
static void	generateRealmCertificate(RealmModel realm)
static void	generateRealmKeys(RealmModel realm)
static UserCredentialModel	generateSecret(ClientModel app)
static X509Certificate	getCertificate(String cert)
static String	getMasterRealmAdminApplicationClientId(RealmModel realm)
static String	getPemFromCertificate(X509Certificate certificate)
static String	getPemFromKey(Key key)
static PrivateKey	getPrivateKey(String privateKeyPem)
static PublicKey	getPublicKey(String publicKeyPem)
static Key	getSecretKey(String secret)
static boolean	hasRole(Set<RoleModel> roles, RoleModel targetRole)
static void	runJobInTransaction(KeycloakSessionFactory factory, KeycloakSessionTask task) Wrap given runnable job into KeycloakTransaction.
static boolean	searchFor(RoleModel role, RoleModel composite, Set<RoleModel> visited) Deep search if given role is descendant of composite role

Methods inherited from class java.lang.Object

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

Method Detail

generateId

public static String generateId()

getPublicKey

public static PublicKey getPublicKey(String publicKeyPem)

getCertificate

public static X509Certificate getCertificate(String cert)

getPrivateKey

public static PrivateKey getPrivateKey(String privateKeyPem)

getSecretKey

public static Key getSecretKey(String secret)

getPemFromKey

public static String getPemFromKey(Key key)

getPemFromCertificate

public static String getPemFromCertificate(X509Certificate certificate)

generateRealmKeys

public static void generateRealmKeys(RealmModel realm)

generateRealmCertificate

public static void generateRealmCertificate(RealmModel realm)

generateClientKeyPairCertificate

public static void generateClientKeyPairCertificate(ClientModel client)

generateSecret

public static UserCredentialModel generateSecret(ClientModel app)

generateCodeSecret

public static String generateCodeSecret()

createClient

public static ClientModel createClient(RealmModel realm,
                       String name)

searchFor

public static boolean searchFor(RoleModel role,
                RoleModel composite,
                Set<RoleModel> visited)

Deep search if given role is descendant of composite role

Parameters:

role - role to check

composite - composite role

visited - set of already visited roles (used for recursion)

Returns:

true if "role" is descendant of "composite"

findUserByNameOrEmail

public static UserModel findUserByNameOrEmail(KeycloakSession session,
                              RealmModel realm,
                              String username)

Try to find user by given username. If it fails, then fallback to find him by email

Parameters:

realm - realm

username - username or email of user

Returns:

found user

runJobInTransaction

public static void runJobInTransaction(KeycloakSessionFactory factory,
                       KeycloakSessionTask task)

Wrap given runnable job into KeycloakTransaction.

Parameters:

factory -

task -

getMasterRealmAdminApplicationClientId

public static String getMasterRealmAdminApplicationClientId(RealmModel realm)

hasRole

public static boolean hasRole(Set<RoleModel> roles,
              RoleModel targetRole)

Parameters:

roles -

targetRole -

Returns:

true if targetRole is in roles (directly or indirectly via composite role)

ensureUniqueDisplayName

public static void ensureUniqueDisplayName(String displayName,
                           UserFederationProviderModel myProvider,
                           List<UserFederationProviderModel> federationProviders)
                                    throws ModelDuplicateException

Ensure that displayName of myProvider (if not null) is unique and there is no other provider with same displayName in the list.

Parameters:

displayName - to check for duplications

myProvider - provider, which is excluded from the list (if present)

federationProviders -

Throws:

ModelDuplicateException - if there is other provider with same displayName

findUserFederationProviderByDisplayName

public static UserFederationProviderModel findUserFederationProviderByDisplayName(String displayName,
                                                                  RealmModel realm)

findUserFederationProviderById

public static UserFederationProviderModel findUserFederationProviderById(String fedProviderId,
                                                         RealmModel realm)

createUserFederationMapperModel

public static UserFederationMapperModel createUserFederationMapperModel(String name,
                                                        String federationProviderId,
                                                        String mapperType,
                                                        String... config)

checkKerberosCredential

public static boolean checkKerberosCredential(RealmModel realm,
                              UserFederationProviderModel model)

Automatically add "kerberos" to required realm credentials if it's supported by saved provider

Parameters:

realm -

model -

Returns:

true if kerberos credentials were added