Package org.gcube.common.security.provider

Class AuthorizationSection

java.lang.Object

org.gcube.common.security.provider.AuthorizationSection

public final class AuthorizationSection
extends Object

The authorization section of a YAML configuration file, e.g. container.yaml of SmartGears or dsl.yaml of document-store-lib, and the provider of authorization it gives:

 authorization:
   factory:
     endpoint: https://accounts.d4science.org/auth/realms/d4science/protocol/openid-connect/token
   credentials:
     clientID: node.d4science.org
     secret: "..."
 

factory and credentials may name in class the class to create: DefaultAuthorizationProviderFactory and SimpleCredentials by default. Their other keys are the properties of that class; a key that is not one of them is ignored.

Author:

Luca Frosini (ISTI-CNR)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AuthorizationSection.Configuration	The factory and the credentials a section gives.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS	The key naming the class to create.
static final String	CREDENTIALS	The key of the credentials.
static final String	FACTORY	The key of the factory of the provider.
static final String	SECTION	The name of the section.

Method Summary

Modifier and Type	Method	Description
static AuthorizationSection.Configuration	configuration(Map<?,?> authorization)	Returns the factory and the credentials of a section.
static org.gcube.common.security.factories.AuthorizationProvider	provider(Map<?,?> authorization)	Returns the provider of authorization of a section.
static org.gcube.common.security.factories.AuthorizationProvider	read(Path file)	Returns the provider of authorization of the "authorization" section of a YAML file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SECTION

public static final String SECTION

The name of the section.

See Also:

• Constant Field Values

CLASS

public static final String CLASS

The key naming the class to create.

See Also:

• Constant Field Values

FACTORY

public static final String FACTORY

The key of the factory of the provider.

See Also:

• Constant Field Values

CREDENTIALS

public static final String CREDENTIALS

The key of the credentials.

See Also:

• Constant Field Values

Method Details

configuration

public static AuthorizationSection.Configuration configuration(Map<?,?> authorization)

Returns the factory and the credentials of a section.

Parameters:

authorization - the section, as YAML reads it

Returns:

its configuration

Throws:

IllegalArgumentException - if a class cannot be created or a value does not fit its property

provider

public static org.gcube.common.security.factories.AuthorizationProvider provider(Map<?,?> authorization)

Returns the provider of authorization of a section.

Parameters:

authorization - the section, as YAML reads it

Returns:

the provider

read

public static org.gcube.common.security.factories.AuthorizationProvider read(Path file)
                                                                      throws Exception

Returns the provider of authorization of the "authorization" section of a YAML file.

Parameters:

file - the file

Returns:

the provider

Throws:

IllegalArgumentException - if the file has no such section, or it is not valid

Exception - if the file cannot be read