| Package | Description |
|---|---|
| org.gcube.common.keycloak |
| Modifier and Type | Method and Description |
|---|---|
static KeycloakClientException |
KeycloakClientException.create(String message,
int status,
String contentType,
String textResponse) |
static KeycloakClientException |
KeycloakClientException.create(String message,
int status,
String contentType,
String textResponse,
Exception cause) |
| Modifier and Type | Method and Description |
|---|---|
URL |
KeycloakClient.computeIntrospectionEndpointURL(URL tokenEndpointURL)
Compute the keycloak
introspection endpoint URL starting
from the provided token endpoint. |
URL |
DefaultKeycloakClient.computeIntrospectionEndpointURL(URL tokenEndpointURL) |
protected TokenResponse |
DefaultKeycloakClient.exchangeToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience,
String requestedTokenType,
String scope)
Queries from the OIDC server an exchanged token by using provided access
token, for the given audience (context),
in URLEncoded form or not,
|
TokenResponse |
KeycloakClient.exchangeTokenForAccessToken(String context,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience)
Exchanges a token for another access token for a specific client and a
specific audience
|
TokenResponse |
DefaultKeycloakClient.exchangeTokenForAccessToken(String context,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.exchangeTokenForAccessToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience)
Exchanges a token for another access token for a specific client and a
specific audience
|
TokenResponse |
DefaultKeycloakClient.exchangeTokenForAccessToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.exchangeTokenForOfflineToken(String context,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience)
Exchanges a token for another access and an offline refresh tokens for a
specific client and a specific audience
The refresh token will be of the offline type only if the original token has
the
offline_access within its scopes |
TokenResponse |
DefaultKeycloakClient.exchangeTokenForOfflineToken(String context,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.exchangeTokenForOfflineToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience)
Exchanges a token for another access and an offline refresh tokens for a
specific client and a specific audience
The refresh token will be of the offline type only if the original token has
the scope
offline_access within its scopes |
TokenResponse |
DefaultKeycloakClient.exchangeTokenForOfflineToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.exchangeTokenForRefreshToken(String context,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience)
Exchanges a token for another access and a refresh tokens for a specific
client and a specific audience
|
TokenResponse |
DefaultKeycloakClient.exchangeTokenForRefreshToken(String context,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.exchangeTokenForRefreshToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience)
Exchanges a token for another access and a refresh tokens for a specific
client and a specific audience
|
TokenResponse |
DefaultKeycloakClient.exchangeTokenForRefreshToken(URL tokenURL,
String oidcAccessToken,
String clientId,
String clientSecret,
String audience) |
byte[] |
KeycloakClient.getAvatarData(String context,
TokenResponse tokenResponse)
Retrieves the user's avatar image data from Keycloak server.
|
byte[] |
DefaultKeycloakClient.getAvatarData(String context,
TokenResponse tokenResponse) |
byte[] |
KeycloakClient.getAvatarData(URL avatarURL,
String authorization)
Retrieves the user's avatar image data from Keycloak server.
|
byte[] |
DefaultKeycloakClient.getAvatarData(URL avatarURL,
String authorization) |
byte[] |
KeycloakClient.getAvatarData(URL avatarURL,
TokenResponse tokenResponse)
Retrieves the user's avatar image data from Keycloak server.
|
byte[] |
DefaultKeycloakClient.getAvatarData(URL avatarURL,
TokenResponse tokenResponse) |
URL |
KeycloakClient.getAvatarEndpointURL(URL realmBaseURL)
Constructs the Keycloak
avatar endpoint URL from the
realm's base URL. |
URL |
DefaultKeycloakClient.getAvatarEndpointURL(URL realmBaseURL) |
URL |
KeycloakClient.getIntrospectionEndpointURL(URL realmBaseURL)
Constructs the Keycloak
introspection endpoint URL from
the realm's base URL. |
URL |
DefaultKeycloakClient.getIntrospectionEndpointURL(URL realmBaseURL) |
URL |
KeycloakClient.getJWKEndpointURL(URL realmBaseURL)
Constructs the Keycloak
JWK endpoint URL from the
realm's base URL. |
URL |
DefaultKeycloakClient.getJWKEndpointURL(URL realmBaseURL) |
URL |
KeycloakClient.getRealmBaseURL(String context)
Returns the Keycloak base
URL for the given context and the default
realm (d4science) |
URL |
DefaultKeycloakClient.getRealmBaseURL(String context) |
URL |
KeycloakClient.getRealmBaseURL(String context,
String realm)
Returns the Keycloak base
URL for the given context and in the given
realm. |
URL |
DefaultKeycloakClient.getRealmBaseURL(String context,
String realm) |
PublishedRealmRepresentation |
KeycloakClient.getRealmInfo(URL realmURL)
Gets the realm info setup (RSA
public_key,
token-service URL,
account-service URL and tokens-not-before setting) |
PublishedRealmRepresentation |
DefaultKeycloakClient.getRealmInfo(URL realmURL) |
JSONWebKeySet |
KeycloakClient.getRealmJSONWebKeySet(URL jwkURL)
Loads the actual JWK from the Keycloak server
|
JSONWebKeySet |
DefaultKeycloakClient.getRealmJSONWebKeySet(URL jwkURL) |
URL |
KeycloakClient.getTokenEndpointURL(URL realmBaseURL)
Constructs the Keycloak
token endpoint URL from the
realm's base URL. |
URL |
DefaultKeycloakClient.getTokenEndpointURL(URL realmBaseURL) |
static TokenResponse |
KeycloakClientHelper.getTokenForUser(String context,
String username,
String password)
Gets a new
TokenResponse, containing the AccessToken and the
RefreshToken from the Keycloak server in the environment of the
context represented by the context parameter. |
TokenIntrospectionResponse |
KeycloakClient.introspectAccessToken(String context,
String clientId,
String clientSecret,
String accessTokenJWTString)
Introspects an access token against the Keycloak server.
|
TokenIntrospectionResponse |
DefaultKeycloakClient.introspectAccessToken(String context,
String clientId,
String clientSecret,
String accessTokenJWTString) |
TokenIntrospectionResponse |
KeycloakClient.introspectAccessToken(URL introspectionURL,
String clientId,
String clientSecret,
String accessTokenJWTString)
Introspects an access token against the Keycloak server.
|
TokenIntrospectionResponse |
DefaultKeycloakClient.introspectAccessToken(URL introspectionURL,
String clientId,
String clientSecret,
String accessTokenJWTString) |
boolean |
KeycloakClient.isAccessTokenVerified(String context,
String clientId,
String clientSecret,
String accessTokenJWTString)
Verifies an access token against the Keycloak server.
|
boolean |
DefaultKeycloakClient.isAccessTokenVerified(String context,
String clientId,
String clientSecret,
String accessTokenJWTString) |
boolean |
KeycloakClient.isAccessTokenVerified(URL introspectionURL,
String clientId,
String clientSecret,
String accessTokenJWTString)
Verifies an access token against the Keycloak server.
|
boolean |
DefaultKeycloakClient.isAccessTokenVerified(URL introspectionURL,
String clientId,
String clientSecret,
String accessTokenJWTString) |
protected <T> T |
DefaultKeycloakClient.performRequest(Class<T> returnObjectClass,
URL url,
Map<String,String> headers,
Map<String,List<String>> params) |
protected TokenResponse |
DefaultKeycloakClient.performRequest(URL tokenURL,
Map<String,String> headers,
Map<String,List<String>> params) |
TokenResponse |
KeycloakClient.queryOIDCToken(String context,
String authorization)
Queries an OIDC token from the Keycloak server, by using provided
authorization.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(String context,
String authorization) |
TokenResponse |
KeycloakClient.queryOIDCToken(String context,
String authorization,
Map<String,String> extraHeaders)
Queries an OIDC token from the Keycloak server, by using provided
authorization.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(String context,
String authorization,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCToken(String context,
String clientId,
String clientSecret)
Queries an OIDC token from the context's Keycloak server, by using provided
clientId and client secret.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(String context,
String clientId,
String clientSecret) |
TokenResponse |
KeycloakClient.queryOIDCToken(String context,
String clientId,
String clientSecret,
Map<String,String> extraHeaders)
Queries an OIDC token from the context's Keycloak server, by using provided
clientId and client secret.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(String context,
String clientId,
String clientSecret,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCToken(URL tokenURL,
String authorization)
Queries an OIDC token from the Keycloak server, by using provided
authorization.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(URL tokenURL,
String authorization) |
TokenResponse |
KeycloakClient.queryOIDCToken(URL tokenURL,
String authorization,
Map<String,String> extraHeaders)
Queries an OIDC token from the Keycloak server, by using provided
authorization.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(URL tokenURL,
String authorization,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCToken(URL tokenURL,
String clientId,
String clientSecret)
Queries an OIDC token from the Keycloak server, by using provided clientId
and client secret.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(URL tokenURL,
String clientId,
String clientSecret) |
TokenResponse |
KeycloakClient.queryOIDCToken(URL tokenURL,
String clientId,
String clientSecret,
Map<String,String> extraHeaders)
Queries an OIDC token from the Keycloak server, by using provided clientId
and client secret.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCToken(URL tokenURL,
String clientId,
String clientSecret,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUser(String context,
String clientId,
String clientSecret,
String username,
String password)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUser(String context,
String clientId,
String clientSecret,
String username,
String password) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUser(String context,
String clientId,
String clientSecret,
String username,
String password,
Map<String,String> extraHeaders)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUser(String context,
String clientId,
String clientSecret,
String username,
String password,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String authorization,
String username,
String password,
String audience)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String authorization,
String username,
String password,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String authorization,
String username,
String password,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String authorization,
String username,
String password,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String clientId,
String clientSecret,
String username,
String password,
String audience)
Queries an OIDC token for a specific user from the Keycloak server, by using
provided clientId and client secret and user's username and password,
reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String clientId,
String clientSecret,
String username,
String password,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String clientId,
String clientSecret,
String username,
String password,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token for a specific user from the Keycloak server, by using
provided clientId and client secret and user's username and password,
reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(String context,
String clientId,
String clientSecret,
String username,
String password,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String authorization,
String username,
String password,
String audience)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String authorization,
String username,
String password,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String authorization,
String username,
String password,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String authorization,
String username,
String password,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String clientId,
String clientSecret,
String username,
String password,
String audience)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String clientId,
String clientSecret,
String username,
String password,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String clientId,
String clientSecret,
String username,
String password,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token for a specific user from the context's Keycloak server,
by using provided clientId and client secret and user's username and
password, , reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenOfUserWithContext(URL tokenURL,
String clientId,
String clientSecret,
String username,
String password,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(String context,
String authorization,
String audience)
Queries an OIDC token from the Keycloak server, by using provided
authorization, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(String context,
String authorization,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(String context,
String authorization,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token from the Keycloak server, by using provided
authorization, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(String context,
String authorization,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(String context,
String clientId,
String clientSecret,
String audience)
Queries an OIDC token from the context's Keycloak server, by using provided
clientId and client secret, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(String context,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(String context,
String clientId,
String clientSecret,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token from the context's Keycloak server, by using provided
clientId and client secret, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(String context,
String clientId,
String clientSecret,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String authorization,
String audience)
Queries an OIDC token from the Keycloak server, by using provided
authorization, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String authorization,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String authorization,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token from the Keycloak server, by using provided
authorization, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String authorization,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String clientId,
String clientSecret,
String audience)
Queries an OIDC token from the Keycloak server, by using provided clientId
and client secret, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String clientId,
String clientSecret,
String audience) |
TokenResponse |
KeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String clientId,
String clientSecret,
String audience,
Map<String,String> extraHeaders)
Queries an OIDC token from the Keycloak server, by using provided clientId
and client secret, reducing the audience to the requested one.
|
TokenResponse |
DefaultKeycloakClient.queryOIDCTokenWithContext(URL tokenURL,
String clientId,
String clientSecret,
String audience,
Map<String,String> extraHeaders) |
TokenResponse |
KeycloakClient.queryUMAToken(String context,
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 |
DefaultKeycloakClient.queryUMAToken(String context,
String authorization,
String audience,
List<String> permissions) |
TokenResponse |
KeycloakClient.queryUMAToken(String context,
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 |
DefaultKeycloakClient.queryUMAToken(String context,
String clientId,
String clientSecret,
String audience,
List<String> permissions) |
TokenResponse |
KeycloakClient.queryUMAToken(String context,
TokenResponse oidcTokenResponse,
String audience,
List<String> permissions)
Queries an UMA token from the Keycloak server, by using access-token provided
by the
TokenResponse object
for the given audience (context), in URLEncoded form or not, and optionally a
list of permissions. |
TokenResponse |
DefaultKeycloakClient.queryUMAToken(String context,
TokenResponse oidcTokenResponse,
String audience,
List<String> permissions) |
TokenResponse |
KeycloakClient.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 |
DefaultKeycloakClient.queryUMAToken(URL tokenURL,
String authorization,
String audience,
List<String> permissions) |
TokenResponse |
KeycloakClient.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 |
DefaultKeycloakClient.queryUMAToken(URL tokenURL,
String clientId,
String clientSecret,
String audience,
List<String> permissions) |
TokenResponse |
KeycloakClient.queryUMAToken(URL tokenURL,
TokenResponse oidcTokenResponse,
String audience,
List<String> permissions)
Queries an UMA token from the Keycloak server, by using access-token provided
by the
TokenResponse object
for the given audience (context), in URLEncoded form or not, and optionally a
list of permissions. |
TokenResponse |
DefaultKeycloakClient.queryUMAToken(URL tokenURL,
TokenResponse oidcTokenResponse,
String audience,
List<String> permissions) |
TokenResponse |
KeycloakClient.refreshToken(String context,
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 |
DefaultKeycloakClient.refreshToken(String context,
String clientId,
String clientSecret,
String refreshTokenJWTString) |
TokenResponse |
KeycloakClient.refreshToken(String context,
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 |
DefaultKeycloakClient.refreshToken(String context,
String clientId,
String clientSecret,
TokenResponse tokenResponse) |
TokenResponse |
KeycloakClient.refreshToken(String context,
TokenResponse tokenResponse)
Refreshes a previously issued token from the Keycloak server using the
refresh token JWT encoded string in the
token response object.
|
TokenResponse |
DefaultKeycloakClient.refreshToken(String context,
TokenResponse tokenResponse) |
TokenResponse |
KeycloakClient.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 |
DefaultKeycloakClient.refreshToken(URL tokenURL,
String clientId,
String clientSecret,
String refreshTokenJWTString) |
TokenResponse |
KeycloakClient.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 |
DefaultKeycloakClient.refreshToken(URL tokenURL,
String clientId,
String clientSecret,
TokenResponse tokenResponse) |
TokenResponse |
KeycloakClient.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.
|
TokenResponse |
DefaultKeycloakClient.refreshToken(URL tokenURL,
TokenResponse tokenResponse) |
Copyright © 2026. All rights reserved.