org.gcube.oidc.keycloak

Class KeycloakHelper

java.lang.Object

org.gcube.oidc.keycloak.KeycloakHelper

public class KeycloakHelper
extends Object

Author:

Mauro Mugnaini (mauro.mugnaini@nubisware.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Method Summary

Modifier and Type	Method and Description
org.keycloak.admin.client.resource.ClientResource	addClient(org.keycloak.admin.client.resource.RealmResource realm, String clientId, String name, String description, String rootUrl)
org.keycloak.admin.client.resource.ClientResource	addPublicClient(org.keycloak.admin.client.resource.RealmResource realm, String clientId, String name, String description, String rootUrl, String loginTheme)
org.keycloak.admin.client.resource.ResourceResource	addResource(org.keycloak.admin.client.resource.ClientResource clientResource, String name, String type, String displayName, boolean ownerManagedAccess, Set<org.keycloak.representations.idm.authorization.ScopeRepresentation> scopes, Set<String> uris)
org.keycloak.representations.idm.authorization.ResourcePermissionRepresentation	addResourcePermission(org.keycloak.admin.client.resource.ClientResource clientResource, Set<String> resources, String name, org.keycloak.representations.idm.authorization.DecisionStrategy decisionStrategy, Set<String> policies)
org.keycloak.admin.client.resource.RoleResource	addRole(org.keycloak.admin.client.resource.ClientResource clientResource, boolean clientRole, String id, String name, String description, String containerId)
org.keycloak.admin.client.resource.PolicyResource	addRoleResourcePolicy(org.keycloak.admin.client.resource.ClientResource clientResource, Set<String> resources, Set<String> scopes, String name, org.keycloak.representations.idm.authorization.Logic logic, Map<String,Set<String>> clientRoles)
org.keycloak.admin.client.resource.ClientResource	findClient(org.keycloak.admin.client.resource.RealmResource realm, String clientId)
org.keycloak.admin.client.resource.UserResource	findUser(org.keycloak.admin.client.resource.RealmResource realmResource, String username)
List<org.keycloak.representations.idm.RoleRepresentation>	getEffectiveClientRoles(org.keycloak.admin.client.resource.RealmResource realm, org.keycloak.admin.client.resource.UserResource userResource, String clientId)
static KeycloakHelper	getInstance(String serverUrl)
PublicKey	getRealmSigPublicKey(String realm)
void	mapRoleTo(org.keycloak.admin.client.resource.UserResource userResource, org.keycloak.admin.client.resource.ClientResource client, String roleName)
void	mapRoleTo(org.keycloak.admin.client.resource.UserResource userResource, String clientId, org.keycloak.admin.client.resource.RoleResource roleResource)
org.keycloak.admin.client.Keycloak	newKeycloak(String realm, String clientId, String clientSecret)
org.keycloak.admin.client.Keycloak	newKeycloak(String realm, String username, String password, String clientId)
org.keycloak.admin.client.Keycloak	newKeycloakAdmin(String username, String password)
void	removeClient(org.keycloak.admin.client.resource.RealmResource realm, String clientId)
<T extends org.keycloak.representations.JsonWebToken> T	verifyAndGetToken(Class<T> tokenClass, String tokenString, PublicKey publicKey)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.slf4j.Logger logger

Method Detail

getInstance

public static KeycloakHelper getInstance(String serverUrl)
                                  throws KeyManagementException,
                                         NoSuchAlgorithmException

Throws:

KeyManagementException

NoSuchAlgorithmException

newKeycloakAdmin

public org.keycloak.admin.client.Keycloak newKeycloakAdmin(String username,
                                                           String password)
                                                    throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

newKeycloak

public org.keycloak.admin.client.Keycloak newKeycloak(String realm,
                                                      String username,
                                                      String password,
                                                      String clientId)
                                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

newKeycloak

public org.keycloak.admin.client.Keycloak newKeycloak(String realm,
                                                      String clientId,
                                                      String clientSecret)
                                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getRealmSigPublicKey

public PublicKey getRealmSigPublicKey(String realm)

findUser

public org.keycloak.admin.client.resource.UserResource findUser(org.keycloak.admin.client.resource.RealmResource realmResource,
                                                                String username)

mapRoleTo

public void mapRoleTo(org.keycloak.admin.client.resource.UserResource userResource,
                      String clientId,
                      org.keycloak.admin.client.resource.RoleResource roleResource)

mapRoleTo

public void mapRoleTo(org.keycloak.admin.client.resource.UserResource userResource,
                      org.keycloak.admin.client.resource.ClientResource client,
                      String roleName)

getEffectiveClientRoles

public List<org.keycloak.representations.idm.RoleRepresentation> getEffectiveClientRoles(org.keycloak.admin.client.resource.RealmResource realm,
                                                                                         org.keycloak.admin.client.resource.UserResource userResource,
                                                                                         String clientId)

addClient

public org.keycloak.admin.client.resource.ClientResource addClient(org.keycloak.admin.client.resource.RealmResource realm,
                                                                   String clientId,
                                                                   String name,
                                                                   String description,
                                                                   String rootUrl)
                                                            throws KeycloakResourceCreationException,
                                                                   UnsupportedEncodingException

Throws:

KeycloakResourceCreationException

UnsupportedEncodingException

addPublicClient

public org.keycloak.admin.client.resource.ClientResource addPublicClient(org.keycloak.admin.client.resource.RealmResource realm,
                                                                         String clientId,
                                                                         String name,
                                                                         String description,
                                                                         String rootUrl,
                                                                         String loginTheme)
                                                                  throws KeycloakResourceCreationException,
                                                                         UnsupportedEncodingException

Throws:

KeycloakResourceCreationException

UnsupportedEncodingException

findClient

public org.keycloak.admin.client.resource.ClientResource findClient(org.keycloak.admin.client.resource.RealmResource realm,
                                                                    String clientId)
                                                             throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

removeClient

public void removeClient(org.keycloak.admin.client.resource.RealmResource realm,
                         String clientId)
                  throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

addRole

public org.keycloak.admin.client.resource.RoleResource addRole(org.keycloak.admin.client.resource.ClientResource clientResource,
                                                               boolean clientRole,
                                                               String id,
                                                               String name,
                                                               String description,
                                                               String containerId)

addResource

public org.keycloak.admin.client.resource.ResourceResource addResource(org.keycloak.admin.client.resource.ClientResource clientResource,
                                                                       String name,
                                                                       String type,
                                                                       String displayName,
                                                                       boolean ownerManagedAccess,
                                                                       Set<org.keycloak.representations.idm.authorization.ScopeRepresentation> scopes,
                                                                       Set<String> uris)
                                                                throws KeycloakResourceCreationException

Throws:

KeycloakResourceCreationException

addRoleResourcePolicy

public org.keycloak.admin.client.resource.PolicyResource addRoleResourcePolicy(org.keycloak.admin.client.resource.ClientResource clientResource,
                                                                               Set<String> resources,
                                                                               Set<String> scopes,
                                                                               String name,
                                                                               org.keycloak.representations.idm.authorization.Logic logic,
                                                                               Map<String,Set<String>> clientRoles)
                                                                        throws KeycloakResourceCreationException

Throws:

KeycloakResourceCreationException

addResourcePermission

public org.keycloak.representations.idm.authorization.ResourcePermissionRepresentation addResourcePermission(org.keycloak.admin.client.resource.ClientResource clientResource,
                                                                                                             Set<String> resources,
                                                                                                             String name,
                                                                                                             org.keycloak.representations.idm.authorization.DecisionStrategy decisionStrategy,
                                                                                                             Set<String> policies)
                                                                                                      throws KeycloakResourceCreationException

Throws:

KeycloakResourceCreationException

verifyAndGetToken

public <T extends org.keycloak.representations.JsonWebToken> T verifyAndGetToken(Class<T> tokenClass,
                                                                                 String tokenString,
                                                                                 PublicKey publicKey)
                                                                          throws org.keycloak.common.VerificationException

Throws:

org.keycloak.common.VerificationException