A C D F G H I L M N O P R S U V

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.

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/)

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) - 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, 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.

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

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

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.

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(Throwable) - Constructor for exception org.gcube.common.iam.D4ScienceIAMClientException

Creates a new exception with the specified cause.

D4ScienceIAMClientException(String, Throwable) - Constructor for exception org.gcube.common.iam.D4ScienceIAMClientException

Creates a new exception with the specified message and cause.

D4ScienceJWTObject - Class in org.gcube.common.iam

D4ScienceJWTObject() - Constructor for class org.gcube.common.iam.D4ScienceJWTObject

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.

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.

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.D4ScienceJWTObject

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

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.

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

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(boolean) - 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 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(boolean) - 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 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

M

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

N

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.

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

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.

R

refresh() - Method in class org.gcube.common.iam.AbstractIAMResponse

refresh(String, String) - Method in class org.gcube.common.iam.AbstractIAMResponse

Refreshes the token using the specified client credentials.

refresh() - Method in interface org.gcube.common.iam.IAMResponse

Refreshes the current response, new data can be obtained again with accessors.

S

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.

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(boolean) - 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 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(boolean) - 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 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 C D F G H I L M N O P R S U V