Package org.simexid.keycloak.service

Class KeycloakUtil

java.lang.Object

org.simexid.keycloak.service.KeycloakUtil

@Service
public class KeycloakUtil
extends Object

Utility class for interacting with Keycloak.

Constructor Summary

Constructors

Constructor	Description
KeycloakUtil()

Method Summary

Modifier and Type	Method	Description
boolean	addRoleToUser(KeycloakEnum.SearchUserType searchUserType, String searchText, String role, KeycloakEnum.Type type, String clientUUID)	Adds a role to a user in Keycloak.
boolean	addUserAttributes(String sub, List<HashMap<String,List<String>>> attributes)	Adds attributes to a user in Keycloak.
boolean	authorized()	Authorizes the client with Keycloak.
boolean	callForAddAttributes(String sub, String payload)	Calls Keycloak to add/remove (rewrite) attributes to a user.
boolean	callForAddRole(String sub, String payload, KeycloakEnum.Type type, String clientUUID)	Calls Keycloak to add/remove (rewrite) a role to a user.
boolean	deleteRoleToUser(KeycloakEnum.SearchUserType searchUserType, String searchText, String role, KeycloakEnum.Type type, String clientUUID)	Deletes a role from a user in Keycloak.
boolean	deleteUserAttributes(String sub, List<String> attributes)	Deletes attributes from a user in Keycloak.
HashMap<String,Object>	getToken()	Get the current keycloak token and expiration
SSOUser	getUserInfo(String sub)	Retrieves the user information from Keycloak.
List<SSORoles>	retrieveUserRole(String sub, KeycloakEnum.Type type, String clientUIID)	Retrieves the roles of a user in Keycloak.
List<SSORoles>	searchRoles(String name, KeycloakEnum.Type type, String clientUUID)	Searches for roles in Keycloak.
List<SSOUser>	searchUser(KeycloakEnum.SearchUserType searchUserType, String searchText)	Searches for a user in Keycloak.
boolean	updateUser(String sub, SSOUser user)	Updates a user in Keycloak.

Methods inherited from class java.lang.Object

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

Constructor Details

KeycloakUtil

public KeycloakUtil()

Method Details

authorized

public boolean authorized()
                   throws AuthorizationException

Authorizes the client with Keycloak. The token is stored in memory until it expires.

Returns:

true if authorization is successful, false otherwise

Throws:

AuthorizationException - if an error occurs during authorization

getUserInfo

public SSOUser getUserInfo(String sub)
                    throws GenericException,
AuthorizationException

Retrieves the user information from Keycloak.

Parameters:

sub - the user ID

Returns:

the user information

Throws:

GenericException - if an error occurs during the operation

AuthorizationException - if the client is not authorized

updateUser

public boolean updateUser(String sub,
 SSOUser user)
                   throws AuthorizationException,
GenericException

Updates a user in Keycloak.

Parameters:

sub - the user ID

user - the user sso representation

Returns:

true if the user was updated successfully, false otherwise

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

addUserAttributes

public boolean addUserAttributes(String sub,
 List<HashMap<String,List<String>>> attributes)
                          throws AuthorizationException,
GenericException,
AttributesException

Adds attributes to a user in Keycloak.

Parameters:

sub - the user ID

attributes - the attributes to add

Returns:

true if the attributes were added successfully, false otherwise

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

AttributesException - if an error occurs during assigment of attributes

deleteUserAttributes

public boolean deleteUserAttributes(String sub,
 List<String> attributes)
                             throws AuthorizationException,
GenericException,
AttributesException

Deletes attributes from a user in Keycloak.

Parameters:

sub - the user ID

attributes - the attributes to delete

Returns:

true if the attributes were deleted successfully, false otherwise

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

AttributesException - if an error occurs during assigment of attributes

callForAddAttributes

public boolean callForAddAttributes(String sub,
 String payload)
                             throws AuthorizationException,
AttributesException

Calls Keycloak to add/remove (rewrite) attributes to a user.

Parameters:

sub - the user ID

payload - the payload containing the attributes

Returns:

true if the attributes were added successfully, false otherwise

Throws:

AuthorizationException - if the client is not authorized

AttributesException - if an error occurs during assigment of attributes

addRoleToUser

public boolean addRoleToUser(KeycloakEnum.SearchUserType searchUserType,
 String searchText,
 String role,
 KeycloakEnum.Type type,
 String clientUUID)
                      throws MultipleUsersFoundException,
MultipleRolesFoundException,
AuthorizationException,
GenericException

Adds a role to a user in Keycloak.

Parameters:

searchUserType - the type of search

searchText - the search text

role - the role to add

type - the type of role (REALM or CLIENT)

clientUUID - the client UUID

Returns:

true if the role was added successfully, false otherwise

Throws:

MultipleUsersFoundException - if multiple users are found

MultipleRolesFoundException - if multiple roles are found

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

deleteRoleToUser

public boolean deleteRoleToUser(KeycloakEnum.SearchUserType searchUserType,
 String searchText,
 String role,
 KeycloakEnum.Type type,
 String clientUUID)
                         throws MultipleUsersFoundException,
MultipleRolesFoundException,
AuthorizationException,
GenericException

Deletes a role from a user in Keycloak.

Parameters:

searchUserType - the type of search

searchText - the search text

role - the role to delete

type - the type of role (REALM or CLIENT)

clientUUID - the client UUID

Returns:

true if the role was deleted successfully, false otherwise

Throws:

MultipleUsersFoundException - if multiple users are found

MultipleRolesFoundException - if multiple roles are found

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

callForAddRole

public boolean callForAddRole(String sub,
 String payload,
 KeycloakEnum.Type type,
 String clientUUID)
                       throws AuthorizationException,
GenericException

Calls Keycloak to add/remove (rewrite) a role to a user.

Parameters:

sub - the user ID

payload - the payload containing the role

type - the type of role (REALM or CLIENT)

clientUUID - the client UUID

Returns:

true if the role was added successfully, false otherwise

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

searchUser

public List<SSOUser> searchUser(KeycloakEnum.SearchUserType searchUserType,
 String searchText)
                         throws AuthorizationException,
GenericException

Searches for a user in Keycloak.

Parameters:

searchUserType - the type of search

searchText - the search text

Returns:

the user information

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

searchRoles

public List<SSORoles> searchRoles(String name,
 KeycloakEnum.Type type,
 String clientUUID)
                           throws AuthorizationException,
GenericException

Searches for roles in Keycloak.

Parameters:

name - the role name

type - the type of role (REALM or CLIENT)

clientUUID - the client UUID

Returns:

the role information

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

retrieveUserRole

public List<SSORoles> retrieveUserRole(String sub,
 KeycloakEnum.Type type,
 String clientUIID)
                                throws AuthorizationException,
GenericException

Retrieves the roles of a user in Keycloak.

Parameters:

sub - the user ID

type - the type of role (REALM or CLIENT)

clientUIID - the client UUID

Returns:

the list of roles

Throws:

AuthorizationException - if the client is not authorized

GenericException - if an error occurs during the operation

getToken

public HashMap<String,Object> getToken()
                                throws AuthorizationException

Get the current keycloak token and expiration

Returns:

an HashMap with the token string as "token" and the expiration in long format as "expiration" if authorized, else a null object

Throws:

AuthorizationException - if the client is not authorized