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 Keycloak server discovered 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 Keycloak server discovered 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.
TokenResponse	refreshToken(String clientId, String refreshTokenJWTString) Refreshes a previously issued token from the Keycloak server discovered in the current scope using the provided client id and the refresh token JWT encoded string obtained with the access token in the previous token response.
TokenResponse	refreshToken(String clientId, String clientSecret, String refreshTokenJWTString) Refreshes a previously issued token from the Keycloak server discovered in the current scope using the provided client id and secret and the refresh token JWT encoded string obtained with the access token in the previous token response.
TokenResponse	refreshToken(String clientId, String clientSecret, TokenResponse tokenResponse) Refreshes a previously issued token from the Keycloak server discovered in the current scope using the refresh token JWT encoded string in the token response object and the provided client id and secret.
TokenResponse	refreshToken(String clientId, TokenResponse tokenResponse) Refreshes a previously issued token from the Keycloak server discovered in the current scope using the refresh token JWT encoded string in the token response object and the provided client id.
TokenResponse	refreshToken(TokenResponse tokenResponse) Refreshes a previously issued token from the Keycloak server discovered in the current scope using the refresh token JWT encoded string in the token response object.
TokenResponse	refreshToken(URL tokenURL, String clientId, String clientSecret, String refreshTokenJWTString) Refreshes a previously issued token from the Keycloak server by using the client id and secret and the refresh token JWT encoded string obtained with the access token in the previous token response.
TokenResponse	refreshToken(URL tokenURL, String clientId, String clientSecret, TokenResponse tokenResponse) Refreshes a previously issued token from the Keycloak server using the refresh token JWT encoded string in the token response object and the provided client id and secret.
TokenResponse	refreshToken(URL tokenURL, TokenResponse tokenResponse) Refreshes a previously issued token from the Keycloak server using the refresh token JWT encoded string in the token response object.

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 Keycloak server discovered 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 Keycloak server discovered 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

refreshToken

TokenResponse refreshToken(TokenResponse tokenResponse)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server discovered in the current scope using the refresh token JWT encoded string in the token response object. Client id will be read from "issued for" access token's claim and client secret will be not sent.
NOTE: For public clients types only.

Parameters:

tokenResponse - the previously issued token as TokenResponse object

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(URL tokenURL,
                           TokenResponse tokenResponse)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server using the refresh token JWT encoded string in the token response object. Client id will be read from "issued for" access token's claim and client secret will be not sent.
NOTE: For public clients types only.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

tokenResponse - the previously issued token as TokenResponse object

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(String clientId,
                           TokenResponse tokenResponse)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server discovered in the current scope using the refresh token JWT encoded string in the token response object and the provided client id. Client secret will be not sent.
NOTE: For public clients types only.

Parameters:

clientId - the requestor client id, may be null and in this case will be take from the access token "issued for" claim

tokenResponse - the previously issued token as TokenResponse object

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(String clientId,
                           String clientSecret,
                           TokenResponse tokenResponse)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server discovered in the current scope using the refresh token JWT encoded string in the token response object and the provided client id and secret.

Parameters:

clientId - the requestor client id, may be null and in this case will be take from the access token "issued for" claim

clientSecret - the requestor client secret, may be null for non-confidential clients

tokenResponse - the previously issued token as TokenResponse object

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(URL tokenURL,
                           String clientId,
                           String clientSecret,
                           TokenResponse tokenResponse)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server using the refresh token JWT encoded string in the token response object and the provided client id and secret.

Parameters:

clientId - the requestor client id, may be null and in this case will be take from the access token "issued for" claim

clientSecret - the requestor client secret, may be null for non-confidential clients

tokenResponse - the previously issued token as TokenResponse object

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(String clientId,
                           String refreshTokenJWTString)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server discovered in the current scope using the provided client id and the refresh token JWT encoded string obtained with the access token in the previous token response. Client secret will be not used.
NOTE: For public clients types only.

Parameters:

clientId - the requestor client id

refreshTokenJWTString - the previously issued refresh token JWT string taken from the same token response of the access token parameter

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(String clientId,
                           String clientSecret,
                           String refreshTokenJWTString)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server discovered in the current scope using the provided client id and secret and the refresh token JWT encoded string obtained with the access token in the previous token response.

Parameters:

clientId - the requestor client id

clientSecret - the requestor client secret, may be null for non-confidential clients

refreshTokenJWTString - the previously issued refresh token JWT string taken from the same token response of the access token parameter

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query

refreshToken

TokenResponse refreshToken(URL tokenURL,
                           String clientId,
                           String clientSecret,
                           String refreshTokenJWTString)
                    throws KeycloakClientException

Refreshes a previously issued token from the Keycloak server by using the client id and secret and the refresh token JWT encoded string obtained with the access token in the previous token response.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

clientId - the requestor client id

clientSecret - the requestor client secret, may be null for non-confidential clients

refreshTokenJWTString - the previously issued refresh token JWT string

Returns:

the refreshed token as TokenResponse object

Throws:

KeycloakClientException - if something goes wrong performing the refresh query