Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AuthorizationProvider - Interface in org.gcube.common.security.factories
-
Provides a contract for retrieving authorization secrets and credentials.
- AuthorizationProviderFactory<T extends AuthorizationProvider> - Interface in org.gcube.common.security.factories
-
A factory interface for creating instances of
AuthorizationProvider. - AuthorizedTasks - Class in org.gcube.common.security
-
Utility class for executing code within a specific
Secret(authorization context). - AuthorizedTasks() - Constructor for class org.gcube.common.security.AuthorizedTasks
B
- bind(Runnable) - Static method in class org.gcube.common.security.AuthorizedTasks
-
Binds a
Runnabletask to the current authorization context. - bind(Runnable, Secret) - Static method in class org.gcube.common.security.AuthorizedTasks
- bind(Callable<V>) - Static method in class org.gcube.common.security.AuthorizedTasks
-
Binds a
Callabletask to the current authorization context. - bind(Callable<V>, Secret) - Static method in class org.gcube.common.security.AuthorizedTasks
C
- connect(Credentials) - Method in interface org.gcube.common.security.factories.AuthorizationProviderFactory
-
Creates and initializes an instance of
AuthorizationProviderusing the provided credentials. - ContextBean - Class in org.gcube.common.security
-
A data object model representing a hierarchical scope.
- ContextBean(String) - Constructor for class org.gcube.common.security.ContextBean
-
Constructs a new
ContextBeanfrom a linear string representation. - ContextBean.Type - Enum Class in org.gcube.common.security
-
Enumeration for the different types of scopes supported.
- Credentials - Interface in org.gcube.common.security.credentials
-
A marker interface representing a set of credentials.
E
- enclosingScope() - Method in class org.gcube.common.security.ContextBean
-
Returns the enclosing scope in the hierarchy.
- equals(Object) - Method in class org.gcube.common.security.ContextBean
-
Compares this object with another object for equality.
- executeSafely(Runnable, Secret) - Static method in class org.gcube.common.security.AuthorizedTasks
-
Executes a
Runnabletask immediately within a specific secret context. - executeSafely(Callable<T>, Secret) - Static method in class org.gcube.common.security.AuthorizedTasks
-
Executes a
Callabletask immediately within a specific secret context.
G
- get() - Static method in class org.gcube.common.security.providers.SecretManagerProvider
-
Retrieves the
Secretassociated with the current thread. - getClientName() - Method in class org.gcube.common.security.Owner
-
Gets the pretty name of the client application, if applicable (e.g., "Catalogue").
- getContactOrganisation() - Method in class org.gcube.common.security.Owner
-
Gets the name of the organization or community using the client.
- getContactPerson() - Method in class org.gcube.common.security.Owner
-
Gets the username of the user who requested the client application.
- getContext() - Method in class org.gcube.common.security.secrets.Secret
-
Retrieves the authorization context to which this secret belongs.
- getContextRoles() - Method in class org.gcube.common.security.Owner
-
Returns the roles of the owner that are specific to a particular context.
- getContexts() - Method in interface org.gcube.common.security.factories.AuthorizationProvider
-
Retrieves the set of all available authorization contexts.
- getCredentials() - Method in interface org.gcube.common.security.factories.AuthorizationProvider
-
Deprecated.
- getEmail() - Method in class org.gcube.common.security.Owner
-
Gets the email address of the owner.
- getFirstName() - Method in class org.gcube.common.security.Owner
-
Gets the first name of the owner.
- getGlobalRoles() - Method in class org.gcube.common.security.Owner
-
Returns the roles of the owner that are not specific to a context.
- getHTTPAuthorizationHeaders() - Method in class org.gcube.common.security.secrets.Secret
-
Retrieves a map of HTTP authorization headers to be used with this secret.
- getId() - Method in class org.gcube.common.security.Owner
-
Gets the unique identifier of the owner.
- getLastName() - Method in class org.gcube.common.security.Owner
-
Gets the last name of the owner.
- getOwner() - Method in class org.gcube.common.security.secrets.Secret
-
Retrieves the
Ownerassociated with this secret. - getRoles() - Method in class org.gcube.common.security.Owner
-
Returns all roles assigned to the owner, including both global and context-specific roles.
- getSecretForContext(String) - Method in interface org.gcube.common.security.factories.AuthorizationProvider
-
Retrieves the secret for a given authorization context.
H
- hashCode() - Method in class org.gcube.common.security.ContextBean
-
Calculates the hash code for this object based on its name, type, and enclosing scope.
I
- INFRASTRUCTURE - Enum constant in enum class org.gcube.common.security.ContextBean.Type
-
Represents the top-level infrastructure scope.
- is(ContextBean.Type) - Method in class org.gcube.common.security.ContextBean
-
Checks if the scope has a specific
ContextBean.Type. - isApplication() - Method in class org.gcube.common.security.Owner
-
Checks if the owner is an application rather than a human user.
- isExpired() - Method in class org.gcube.common.security.secrets.Secret
-
Checks if the secret has expired.
- isExternalClient() - Method in class org.gcube.common.security.Owner
-
Checks if the owner is an external client.
- isValid() - Method in class org.gcube.common.security.secrets.Secret
-
Checks if the secret is currently valid and usable for authorization.
M
- MDC_CONTEXT_KEY - Static variable in class org.gcube.common.security.providers.SecretManagerProvider
-
MDC key used to store the current gcube security context in the logging context.
- MDC_USER_KEY - Static variable in class org.gcube.common.security.providers.SecretManagerProvider
-
MDC key used to store the identifier of the owner of the current secret (the user or the client that makes the request, or the container in its own tasks) in the logging context; absent when no secret is set in the current thread.
N
- name() - Method in class org.gcube.common.security.ContextBean
-
Returns the name of this scope level.
O
- org.gcube.common.security - package org.gcube.common.security
- org.gcube.common.security.credentials - package org.gcube.common.security.credentials
- org.gcube.common.security.exception - package org.gcube.common.security.exception
- org.gcube.common.security.factories - package org.gcube.common.security.factories
- org.gcube.common.security.providers - package org.gcube.common.security.providers
- org.gcube.common.security.secrets - package org.gcube.common.security.secrets
- Owner - Class in org.gcube.common.security
-
Represents the owner of a resource or process.
- Owner(String, List<String>, boolean, boolean) - Constructor for class org.gcube.common.security.Owner
-
Constructs an
Ownerobject for a user or application with a set of context-specific roles. - Owner(String, List<String>, String, String, String, boolean, boolean) - Constructor for class org.gcube.common.security.Owner
-
Constructs an
Ownerobject for a human user with context-specific roles and personal details. - Owner(String, List<String>, List<String>, String, String, String, boolean, boolean) - Constructor for class org.gcube.common.security.Owner
-
Constructs an
Ownerobject with both context-specific and global roles, along with personal details.
P
- priority() - Method in class org.gcube.common.security.secrets.Secret
-
The priority of this secret.
R
- reset() - Static method in class org.gcube.common.security.providers.SecretManagerProvider
-
Resets the
Secretfor the current thread, effectively removing it. - runAsync(Runnable, Secret) - Static method in class org.gcube.common.security.AuthorizedTasks
S
- Secret - Class in org.gcube.common.security.secrets
-
An abstract class representing a secret used for authorization.
- Secret() - Constructor for class org.gcube.common.security.secrets.Secret
- SecretManagerProvider - Class in org.gcube.common.security.providers
-
Provides a thread-safe way to manage and access a
Secretobject within the current execution thread. - SecretManagerProvider() - Constructor for class org.gcube.common.security.providers.SecretManagerProvider
- SecurityException - Exception in org.gcube.common.security.exception
-
An exception class that indicates a security violation.
- SecurityException() - Constructor for exception org.gcube.common.security.exception.SecurityException
-
Constructs a new
SecurityExceptionwithnullas its detail message. - SecurityException(String) - Constructor for exception org.gcube.common.security.exception.SecurityException
-
Constructs a new
SecurityExceptionwith the specified detail message. - SecurityException(String, Throwable) - Constructor for exception org.gcube.common.security.exception.SecurityException
-
Constructs a new
SecurityExceptionwith the specified detail message and cause. - SecurityException(String, Throwable, boolean, boolean) - Constructor for exception org.gcube.common.security.exception.SecurityException
-
Constructs a new
SecurityExceptionwith the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled. - SecurityException(Throwable) - Constructor for exception org.gcube.common.security.exception.SecurityException
-
Constructs a new
SecurityExceptionwith the specified cause and a detail message of(cause==null ? null : cause.toString())(which typically contains the class and detail message ofcause). - separator - Static variable in class org.gcube.common.security.ContextBean
-
Separator used in the linear syntax of scopes.
- set(Secret) - Static method in class org.gcube.common.security.providers.SecretManagerProvider
-
Sets the
Secretfor the current thread. - setClientName(String) - Method in class org.gcube.common.security.Owner
-
Sets the pretty name of the client application.
- setContactOrganisation(String) - Method in class org.gcube.common.security.Owner
-
Sets the name of the organization or community using the client.
- setContactPerson(String) - Method in class org.gcube.common.security.Owner
-
Sets the username of the user who requested the client application.
T
- toString() - Method in class org.gcube.common.security.ContextBean
-
Returns the linear string representation of the scope.
- type() - Method in class org.gcube.common.security.ContextBean
-
Returns the
ContextBean.Typeof this scope.
V
- valueOf(String) - Static method in enum class org.gcube.common.security.ContextBean.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.gcube.common.security.ContextBean.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VO - Enum constant in enum class org.gcube.common.security.ContextBean.Type
-
Represents a Virtual Organization scope, enclosed within an infrastructure.
- VRE - Enum constant in enum class org.gcube.common.security.ContextBean.Type
-
Represents a Virtual Research Environment scope, enclosed within a VO.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
AuthorizationProvider.getSecretForContext(String)instead. This method will be removed in a future version.