org.gcube.common.keycloak

Interface KeycloakClient

All Known Implementing Classes:

AbstractPlugin, DefaultKeycloakClient

public interface KeycloakClient

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY
static String	DESCRIPTION
static org.slf4j.Logger	logger
static String	NAME

Method Summary

Modifier and Type	Method and Description
URL	findTokenEndpointURL() Finds the keycloak endpoint URL discovering it in the current scope provided by ScopeProvider
TokenResponse	queryUMAToken(String clientId, String clientSecret, List<String> permissions) Queries an UMA token from the discovered Keycloak server in the current scope, by using provided clientId and client secret for the current scope audience (context), in URLEncoded form or not, and optionally a list of permissions.
TokenResponse	queryUMAToken(String clientId, String clientSecret, String audience, List<String> permissions) Queries an UMA token from the discovered Keycloak server in the current scope, by using provided clientId and client secret for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.
TokenResponse	queryUMAToken(URL tokenURL, String authorization, String audience, List<String> permissions) Queries an UMA token from the Keycloak server, by using provided authorization, for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.
TokenResponse	queryUMAToken(URL tokenURL, String clientId, String clientSecret, String audience, List<String> permissions) Queries an UMA token from the Keycloak server, by using provided clientId and client secret for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Field Detail

logger

static final org.slf4j.Logger logger

CATEGORY

static final String CATEGORY

See Also:

Constant Field Values

NAME

static final String NAME

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

Constant Field Values

Method Detail

findTokenEndpointURL

URL findTokenEndpointURL()
                  throws KeycloakClientException

Finds the keycloak endpoint URL discovering it in the current scope provided by ScopeProvider

Returns:

the keycloak endpoint URL in the current scope

Throws:

KeycloakClientException - if something goes wrong discovering the endpoint URL

queryUMAToken

TokenResponse queryUMAToken(URL tokenURL,
                            String authorization,
                            String audience,
                            List<String> permissions)
                     throws KeycloakClientException

Queries an UMA token from the Keycloak server, by using provided authorization, for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

authorization - the authorization to be set as header (e.g. a "Basic ...." auth or an encoded JWT access token preceded by the "Bearer " string)

audience - the audience (context) where to request the issuing of the ticket (URLEncoded)

permissions - a list of permissions, can be null

Returns:

the issued token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the query

queryUMAToken

TokenResponse queryUMAToken(URL tokenURL,
                            String clientId,
                            String clientSecret,
                            String audience,
                            List<String> permissions)
                     throws KeycloakClientException

Queries an UMA token from the Keycloak server, by using provided clientId and client secret for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

tokenURL - the token endpoint URL of the Keycloak server

clientId - the client id

clientSecret - the client secret

audience - the audience (context) where to request the issuing of the ticket

permissions - a list of permissions, can be null

Returns:

the issued token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the query

queryUMAToken

TokenResponse queryUMAToken(String clientId,
                            String clientSecret,
                            String audience,
                            List<String> permissions)
                     throws KeycloakClientException

Queries an UMA token from the discovered Keycloak server in the current scope, by using provided clientId and client secret for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

clientId - the client id

clientSecret - the client secret

audience - the audience (context) where to request the issuing of the ticket

permissions - a list of permissions, can be null

Returns:

the issued token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the query

queryUMAToken

TokenResponse queryUMAToken(String clientId,
                            String clientSecret,
                            List<String> permissions)
                     throws KeycloakClientException

Queries an UMA token from the discovered Keycloak server in the current scope, by using provided clientId and client secret for the current scope audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

clientId - the client id

clientSecret - the client secret

permissions - a list of permissions, can be null

Returns:

the issued token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the query