Index (D4Science IAM Client 2.1.0-SNAPSHOT API)

A B C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractIAMResponse - Class in org.gcube.common.iam: Abstract base class for D4Science IAM responses that implements common functionality for handling authentication and authorization responses.
AbstractIAMResponse(D4ScienceIAMClient, TokenResponse) - Constructor for class org.gcube.common.iam.AbstractIAMResponse: Creates a new AbstractIAMResponse with the specified IAM client and token response.
asD4sContextDynamicScope(String) - Static method in class org.gcube.common.iam.D4ScienceIAMClient
authenticate(String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Authenticates the client with provided id and secret
authenticate(String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Authenticates the client with provided credentials, reducing the token audience to the requested `context`
authenticateUser(String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Deprecated.
this authn method is deprecated in the oauth2 specifications (see https://oauth.net/2/grant-types/password/)
authenticateUser(String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Deprecated.
this authn method is deprecated in the oauth2 specifications (see https://oauth.net/2/grant-types/password/)
authenticateUser(String, String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Deprecated.
this authn method is deprecated in the oauth2 specifications (see https://oauth.net/2/grant-types/password/)
authenticateUser(String, String, String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Deprecated.
this authn method is deprecated in the oauth2 specifications (see https://oauth.net/2/grant-types/password/)
authenticateWithCode(String, String, String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Authenticates with the code received on the redirect URI of the authorization code flow.
authorizationURL(String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Starts the URL of the authorization endpoint the browser has to be redirected to (authorization code flow).
AuthorizationURLBuilder - Class in org.gcube.common.iam: Builds the URL of the authorization endpoint the browser is redirected to in the authorization code flow (response type code), with optional PKCE (S256).
authorize(String) - Method in class org.gcube.common.iam.D4ScienceIAMClientAuthn: Authorizes the client or the user by using the authn already obtained, for the specific context audience and no optional permissions.
authorize(String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Directly authorizes the client by using the provided credentials, for the specific context audience and with no optional permissions
authorize(String, String, String, List<String>) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Directly authorizes the client by using the provided credentials, for the specific context audience and with optional permissions
authorize(String, List<String>) - Method in class org.gcube.common.iam.D4ScienceIAMClientAuthn: Authorizes the client or the user by using the authn already obtained, for the specific context audience and with optional permissions.

B

build() - Method in class org.gcube.common.iam.AuthorizationURLBuilder

C

canBeRefreshed() - Method in class org.gcube.common.iam.AbstractIAMResponse
canBeRefreshed() - Method in interface org.gcube.common.iam.IAMResponse: Check if the current response can be refreshed
clearPublicKeyCache() - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Empties the realm public keys cache (e.g. after a known key rotation).
CLIENT_CONTACT_ORGANISATION - Static variable in class org.gcube.common.iam.D4ScienceCustomClaims: The registered contact organization of a client with service account
CLIENT_CONTACT_PERSON - Static variable in class org.gcube.common.iam.D4ScienceCustomClaims: The registered contact person of a client with service account
CLIENT_NAME - Static variable in class org.gcube.common.iam.D4ScienceCustomClaims: The display name of a client with service account
codeChallengeS256(String) - Method in class org.gcube.common.iam.AuthorizationURLBuilder: Enables PKCE with the S256 method.
codeChallengeS256Of(String) - Static method in class org.gcube.common.iam.AuthorizationURLBuilder

D

D4ScienceCustomClaims - Class in org.gcube.common.iam: Constants for D4Science custom claims used in JWT tokens.
D4ScienceCustomClaims() - Constructor for class org.gcube.common.iam.D4ScienceCustomClaims
D4ScienceIAMClient - Class in org.gcube.common.iam: Helper class that acts as IAM client providing authentication and authorization using the IAM hiding the underlying implementation
D4ScienceIAMClientAuthn - Class in org.gcube.common.iam: Abstract base class for D4Science IAM client authentication responses.
D4ScienceIAMClientAuthn(D4ScienceIAMClient, TokenResponse) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn: Creates a new authentication response.
D4ScienceIAMClientAuthn4Client - Class in org.gcube.common.iam: D4Science IAM client authentication implementation for client credentials flow.
D4ScienceIAMClientAuthn4Client(D4ScienceIAMClient, String, String) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn4Client: Creates a new client authentication instance using client credentials.
D4ScienceIAMClientAuthn4Client(D4ScienceIAMClient, String, String, String) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn4Client: Creates a new client authentication instance with specific context.
D4ScienceIAMClientAuthn4Code - Class in org.gcube.common.iam: D4Science IAM client authentication implementation for the authorization code flow: the tokens are obtained by exchanging the code the browser brought back on the redirect URI.
D4ScienceIAMClientAuthn4Code(D4ScienceIAMClient, String, String, String, String, String) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn4Code: Exchanges the authorization code for the tokens.
D4ScienceIAMClientAuthn4Tokens - Class in org.gcube.common.iam: D4Science IAM client authentication object built over tokens obtained elsewhere (e.g. by a login performed by another component): gives the whole IAMResponse API (claims, expiry, refresh, exchange, verification, logout) without performing any request.
D4ScienceIAMClientAuthn4Tokens(D4ScienceIAMClient, TokenResponse) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn4Tokens
D4ScienceIAMClientAuthn4User - Class in org.gcube.common.iam: D4Science IAM client authentication implementation for user credentials.
D4ScienceIAMClientAuthn4User(D4ScienceIAMClient, String, String, String, String) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn4User: Creates a new user authentication instance without context.
D4ScienceIAMClientAuthn4User(D4ScienceIAMClient, String, String, String, String, String) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthn4User: Creates a new user authentication instance with context.
D4ScienceIAMClientAuthz - Class in org.gcube.common.iam: D4Science IAM client authorization implementation.
D4ScienceIAMClientAuthz(D4ScienceIAMClientAuthn, String, List<String>) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthz: Creates a new authorization instance using an existing authentication.
D4ScienceIAMClientAuthz(D4ScienceIAMClient, String, String, String, List<String>) - Constructor for class org.gcube.common.iam.D4ScienceIAMClientAuthz: Creates a new authorization instance using client credentials.
D4ScienceIAMClientException - Exception in org.gcube.common.iam: Exception thrown by D4Science IAM client operations.
D4ScienceIAMClientException(String) - Constructor for exception org.gcube.common.iam.D4ScienceIAMClientException: Creates a new exception with the specified message.
D4ScienceIAMClientException(String, Throwable) - Constructor for exception org.gcube.common.iam.D4ScienceIAMClientException: Creates a new exception with the specified message and cause.
D4ScienceIAMClientException(Throwable) - Constructor for exception org.gcube.common.iam.D4ScienceIAMClientException: Creates a new exception with the specified cause.
D4ScienceJWTObject - Class in org.gcube.common.iam
D4ScienceJWTObject() - Constructor for class org.gcube.common.iam.D4ScienceJWTObject

E

exchange(String, String, String, String) - Method in class org.gcube.common.iam.AbstractIAMResponse
exchange(String, String, String, String) - Method in interface org.gcube.common.iam.IAMResponse: Exchanges and updates the current response with new one obtained with parameters provided.
exchangeForRefreshToken(String, String, String, String) - Method in class org.gcube.common.iam.AbstractIAMResponse: Same as AbstractIAMResponse.exchange(String, String, String, String) but asks the IAM also for a refresh token (requested_token_type=refresh_token): afterwards AbstractIAMResponse.getRefreshTokenString() gives it, and AbstractIAMResponse.getRefreshExpiresIn() its lifetime.
expiryMillis(String) - Static method in class org.gcube.common.iam.D4ScienceIAMClient

F

fromAccessTokenString(String) - Static method in class org.gcube.common.iam.OIDCBearerAuth: Constructs a new object from an OIDC base64 encoded access-token string.
fromAuthorizationHeader(String) - Static method in class org.gcube.common.iam.OIDCBearerAuth: Constructs a new object from an HTTP authorization header containing the bearer token with an OIDC access-token.
fromBearerAuthorization(String) - Static method in class org.gcube.common.iam.OIDCBearerAuth: Constructs a new object from a bearer token with an OIDC access-token.
fromTokens(String, String, String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Wraps tokens this component obtained elsewhere (e.g. by a login performed by another component) into the IAMResponse API: claims, expiry, refresh, exchange, verification and logout, with no request performed.

G

getAccessToken() - Method in class org.gcube.common.iam.AbstractIAMResponse
getAccessToken() - Method in interface org.gcube.common.iam.IAMResponse: Returns the access token in the response.
getAccessTokenExpiryMillis() - Method in class org.gcube.common.iam.AbstractIAMResponse
getAccessTokenString() - Method in class org.gcube.common.iam.AbstractIAMResponse
getAccessTokenString() - Method in interface org.gcube.common.iam.IAMResponse: Returns the access token in the response as string.
getClientName() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getContactOrganisation() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getContactOrganization() - Method in class org.gcube.common.iam.AbstractIAMResponse
getContactOrganization() - Method in interface org.gcube.common.iam.IAMResponse: Returns the client's contact organization from the token
getContactPerson() - Method in class org.gcube.common.iam.AbstractIAMResponse
getContactPerson() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getContactPerson() - Method in interface org.gcube.common.iam.IAMResponse: Returns the client's contact person from the token
getContentType() - Method in exception org.gcube.common.iam.D4ScienceIAMClientException: Returns the content type if the cause is a KeycloakClientException.
getContext() - Method in class org.gcube.common.iam.AbstractIAMResponse
getContext() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getContext() - Method in interface org.gcube.common.iam.IAMResponse: Returns the token context is issued for This is done by checking in the order: If the token contains the d4s_context claim, as specified also in KeycloakClient.D4S_DYNAMIC_SCOPE_NAME_TOKEN_CLAIM The value of the aud claim if contains a single value (for retro-compatibility) It returns null if none of the options are satisfied and the context cannot be determined.
getContextRoles() - Method in class org.gcube.common.iam.AbstractIAMResponse
getContextRoles() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getContextRoles() - Method in interface org.gcube.common.iam.IAMResponse: Returns the resource roles for the resource specified in the token context
getError() - Method in exception org.gcube.common.iam.D4ScienceIAMClientException: Returns the OAuth error of the IAM answer (e.g.
getErrorDescription() - Method in exception org.gcube.common.iam.D4ScienceIAMClientException: Returns the OAuth error_description of the IAM answer, if the answer is a JSON error object.
getExpiresIn() - Method in class org.gcube.common.iam.AbstractIAMResponse: Returns the lifetime of the access token as stated by the IAM when it issued it.
getGlobalRoles() - Method in class org.gcube.common.iam.AbstractIAMResponse
getGlobalRoles() - Method in interface org.gcube.common.iam.IAMResponse: Returns the realm roles in the token
getIamClient() - Method in class org.gcube.common.iam.AbstractIAMResponse: Returns the IAM client instance.
getIdTokenString() - Method in class org.gcube.common.iam.AbstractIAMResponse
getKeycloakClient() - Method in class org.gcube.common.iam.D4ScienceIAMClient: Returns the underlying Keycloak client instance.
getName() - Method in class org.gcube.common.iam.AbstractIAMResponse
getName() - Method in interface org.gcube.common.iam.IAMResponse: Returns the client's name from the token
getRawContext() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getRealmBaseURL() - Method in class org.gcube.common.iam.D4ScienceIAMClient: Returns the base URL of the realm.
getRealmRoles() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getRefreshExpiresIn() - Method in class org.gcube.common.iam.AbstractIAMResponse: Returns the lifetime of the refresh token as stated by the IAM when it issued it.
getRefreshTokenExpiryMillis() - Method in class org.gcube.common.iam.AbstractIAMResponse
getRefreshTokenString() - Method in class org.gcube.common.iam.AbstractIAMResponse: Returns the refresh token as a string.
getResourceRoles(String) - Method in class org.gcube.common.iam.AbstractIAMResponse
getResourceRoles(String) - Method in interface org.gcube.common.iam.IAMResponse: Returns the resource roles for the resource specified in the resource parameter
getResponseString() - Method in exception org.gcube.common.iam.D4ScienceIAMClientException: Returns the response string if the cause is a KeycloakClientException.
getRoles() - Method in class org.gcube.common.iam.AbstractIAMResponse
getRoles() - Method in class org.gcube.common.iam.D4ScienceJWTObject
getRoles() - Method in interface org.gcube.common.iam.IAMResponse: Returns all the roles, realm and from all the resources in the token in the same set
getStatus() - Method in exception org.gcube.common.iam.D4ScienceIAMClientException: Returns the HTTP status code if the cause is a KeycloakClientException.
getTokenResponse() - Method in class org.gcube.common.iam.AbstractIAMResponse: Returns the token response.
getUsername() - Method in class org.gcube.common.iam.D4ScienceJWTObject

H

hasJSONPayload() - Method in exception org.gcube.common.iam.D4ScienceIAMClientException: Checks if the response has a JSON payload.

I

IAMResponse - Interface in org.gcube.common.iam: Interface for D4Science IAM response handling.
isAccessTokenValid() - Method in class org.gcube.common.iam.AbstractIAMResponse
isAccessTokenValid() - Method in interface org.gcube.common.iam.IAMResponse: Quick way to check if the access token is valid by checking the digital signature and the token expiration
isAccessTokenValid(boolean) - Method in class org.gcube.common.iam.AbstractIAMResponse
isAccessTokenValid(boolean) - Method in interface org.gcube.common.iam.IAMResponse: Quick way to check if the access token is valid by checking the digital signature and the token expiration if the checkExpiration parameter is true
isApplication() - Method in class org.gcube.common.iam.D4ScienceJWTObject
isExpired() - Method in class org.gcube.common.iam.AbstractIAMResponse
isExpired() - Method in interface org.gcube.common.iam.IAMResponse: Check if the current response is expired
isExternalService() - Method in class org.gcube.common.iam.D4ScienceJWTObject
isRefreshTokenValid() - Method in class org.gcube.common.iam.AbstractIAMResponse
isRefreshTokenValid() - Method in interface org.gcube.common.iam.IAMResponse: Quick way to check if the refresh token present in the current response and it is valid by checking the digital signature and the token expiration
isRefreshTokenValid(boolean) - Method in class org.gcube.common.iam.AbstractIAMResponse
isRefreshTokenValid(boolean) - Method in interface org.gcube.common.iam.IAMResponse: Quick way to check if the refresh token present in the current response and it is valid by checking the digital signature and the token expiration if the checkExpiration parameter is true
isTokenValid(String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Checks if the token is valid (signature and expiration).
isTokenValid(String, boolean) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Checks if the token is valid and optionally checks for expiration.

L

logger - Static variable in class org.gcube.common.iam.D4ScienceIAMClient: Logger instance for this class
logout() - Method in class org.gcube.common.iam.AbstractIAMResponse: Ends the user session on the IAM (end session endpoint) using the refresh token, for a public client or a client the token was issued to: the client id is read from the access token (azp).
logout(String, String) - Method in class org.gcube.common.iam.AbstractIAMResponse: Ends the user session on the IAM (end session endpoint) using the refresh token.

M

MINIMAL_ROLES - Static variable in class org.gcube.common.iam.D4ScienceJWTObject

N

newCodeVerifier() - Static method in class org.gcube.common.iam.AuthorizationURLBuilder
newInstance(String) - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Creates a new client for the specific context, in the default IAM realm.
newInstance(String, String) - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Creates a new client for the specific context, in the default realm.
newInstance(URL) - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Creates a new client with the provided base URL.
newInstanceForTokenEndpoint(URL) - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Creates a new client from the full token endpoint URL of the realm (...
nonce(String) - Method in class org.gcube.common.iam.AuthorizationURLBuilder

O

OIDCBearerAuth - Class in org.gcube.common.iam: OIDC Bearer authentication implementation for handling bearer tokens.
OIDCBearerAuth(D4ScienceIAMClient, TokenResponse) - Constructor for class org.gcube.common.iam.OIDCBearerAuth: Creates a new OIDC bearer authentication instance.
org.gcube.common.iam - package org.gcube.common.iam

P

param(String, String) - Method in class org.gcube.common.iam.AuthorizationURLBuilder: Adds (or replaces) any other authorization request parameter (e.g.
parse(String) - Static method in class org.gcube.common.iam.D4ScienceJWTObject: Reads the claims of a token JWT string WITHOUT verifying signature nor expiry.
parseAccessToken(String) - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Reads the claims of a token JWT string WITHOUT verifying signature nor expiry (use D4ScienceIAMClient.verifyToken(String) for that).
performClientAuthn(D4ScienceIAMClient, String, String, String) - Static method in class org.gcube.common.iam.D4ScienceIAMClientAuthn4Client: Performs the actual client authentication using client credentials flow.
performUserAuthn(D4ScienceIAMClient, String, String, String, String, String) - Static method in class org.gcube.common.iam.D4ScienceIAMClientAuthn4User: Performs user authentication using username and password credentials.
PUBLIC_KEY_CACHE_TTL_MILLIS - Static variable in class org.gcube.common.iam.D4ScienceIAMClient: How long the realm public key is kept before asking the IAM again (milliseconds, 0 disables the cache).
PUBLIC_KEY_MIN_REFRESH_MILLIS - Static variable in class org.gcube.common.iam.D4ScienceIAMClient: A key that failed a verification is fetched again only if the cached one is older than this (milliseconds).

R

refresh() - Method in class org.gcube.common.iam.AbstractIAMResponse
refresh() - Method in interface org.gcube.common.iam.IAMResponse: Refreshes the current response, new data can be obtained again with accessors.
refresh(String, String) - Method in class org.gcube.common.iam.AbstractIAMResponse: Refreshes the token using the specified client credentials.
ROOT_DYNAMIC_SCOPE_FOR_ENABLING - Static variable in class org.gcube.common.iam.D4ScienceIAMClient

S

scope(String) - Method in class org.gcube.common.iam.AuthorizationURLBuilder
setClientId(String) - Method in class org.gcube.common.iam.D4ScienceJWTObject
setClientName(String) - Method in class org.gcube.common.iam.D4ScienceJWTObject
setContactOrganisation(String) - Method in class org.gcube.common.iam.D4ScienceJWTObject
setContactPerson(String) - Method in class org.gcube.common.iam.D4ScienceJWTObject
setDefaultGatewayClientID(String) - Static method in class org.gcube.common.iam.D4ScienceIAMClient: Sets the new default GW clientId used for all the queries to the IAM server.
setIamClient(D4ScienceIAMClient) - Method in class org.gcube.common.iam.AbstractIAMResponse: Sets the IAM client instance.
setTokenResponse(TokenResponse) - Method in class org.gcube.common.iam.AbstractIAMResponse: Sets the token response.
state(String) - Method in class org.gcube.common.iam.AuthorizationURLBuilder

T

toString() - Method in class org.gcube.common.iam.AuthorizationURLBuilder

U

USE_DYNAMIC_SCOPES - Static variable in class org.gcube.common.iam.D4ScienceIAMClient: Flag to enable/disable dynamic scopes functionality

V

verifyAccessToken() - Method in class org.gcube.common.iam.AbstractIAMResponse
verifyAccessToken() - Method in interface org.gcube.common.iam.IAMResponse: Verifies the access token integrity and validity; token digital signature and expiration are reported via specific exceptions.
verifyAccessToken(boolean) - Method in class org.gcube.common.iam.AbstractIAMResponse
verifyAccessToken(boolean) - Method in interface org.gcube.common.iam.IAMResponse: Verifies the access token integrity and optionally for expiration; token digital signature and expiration are reported via specific exceptions.
verifyRefreshToken() - Method in class org.gcube.common.iam.AbstractIAMResponse
verifyRefreshToken() - Method in interface org.gcube.common.iam.IAMResponse: Verifies the refresh token integrity and validity; token digital signature and expiration are reported via specific exceptions.
verifyRefreshToken(boolean) - Method in class org.gcube.common.iam.AbstractIAMResponse
verifyRefreshToken(boolean) - Method in interface org.gcube.common.iam.IAMResponse: Verifies the refresh token integrity and validity; token digital signature and expiration are reported via specific exceptions.
verifyToken(String) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Verifies the token signature and also checks the expiration.
verifyToken(String, boolean) - Method in class org.gcube.common.iam.D4ScienceIAMClient: Verifies the token signature and optionally checks for expiration.

A B C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form