Module io.helidon.security.providers.idcs.mapper

Package io.helidon.security.providers.idcs.mapper

Class IdcsRoleMapperProvider

java.lang.Object

io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase

io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProvider

All Implemented Interfaces:

SecurityProvider, SubjectMappingProvider

public class IdcsRoleMapperProvider
extends IdcsRoleMapperProviderBase
implements SubjectMappingProvider

SubjectMappingProvider to obtain roles from IDCS server for a user. Supports multi tenancy in IDCS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdcsRoleMapperProvider.Builder<B extends IdcsRoleMapperProvider.Builder<B>>	Fluent API builder for IdcsRoleMapperProvider.

Nested classes/interfaces inherited from class io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase

IdcsRoleMapperProviderBase.AppToken

Field Summary

Fields inherited from class io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase

ACCESS_TOKEN_KEY, IDCS_SUBJECT_TYPE_CLIENT, IDCS_SUBJECT_TYPE_USER, PARENT_CONTEXT_CLIENT_PROPERTY, ROLE_APPROLE, ROLE_GROUP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdcsRoleMapperProvider(IdcsRoleMapperProvider.Builder<?> builder)	Constructor that accepts any IdcsRoleMapperProvider.Builder descendant.

Method Summary

Modifier and Type	Method	Description
protected List<? extends Grant>	addAdditionalGrants(Subject subject, List<Grant> idcsGrants)	Extension point to add additional grants that are not retrieved from IDCS.
static IdcsRoleMapperProvider.Builder<?>	builder()	Creates a new builder to build instances of this class.
protected List<? extends Grant>	computeGrants(Subject subject)	Compute grants for the provided subject.
static SecurityProvider	create(Config config)	Creates an instance from configuration.
protected Subject	enhance(ProviderRequest request, AuthenticationResponse previousResponse, Subject subject)	Enhance subject with IDCS roles, reactive.
protected List<? extends Grant>	getGrantsFromServer(Subject subject)	Retrieves grants from IDCS server.

Methods inherited from class io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase

buildSubject, defaultIdcsSubjectType, map, oidcConfig, processRoleRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.security.spi.SecurityProvider

supportedAnnotations, supportedAttributes, supportedConfigKeys, supportedCustomObjects

Methods inherited from interface io.helidon.security.spi.SubjectMappingProvider

map

Constructor Details

IdcsRoleMapperProvider

protected IdcsRoleMapperProvider(IdcsRoleMapperProvider.Builder<?> builder)

Constructor that accepts any IdcsRoleMapperProvider.Builder descendant.

Parameters:

builder - used to configure this instance

Method Details

builder

public static IdcsRoleMapperProvider.Builder<?> builder()

Creates a new builder to build instances of this class.

Returns:

a new fluent API builder.

create

public static SecurityProvider create(Config config)

Creates an instance from configuration.

Expects:

• oidc-config to load an instance of OidcConfig
• cache-config (optional) to load an instance of EvictableCache for role caching

Parameters:

config - configuration of this provider

Returns:

a new instance configured from config

enhance

protected Subject enhance(ProviderRequest request,
 AuthenticationResponse previousResponse,
 Subject subject)

Description copied from class: IdcsRoleMapperProviderBase

Enhance subject with IDCS roles, reactive.

Specified by:

enhance in class IdcsRoleMapperProviderBase

Parameters:

request - provider request

previousResponse - authenticated response

subject - subject to enhance

Returns:

future with enhanced subject

computeGrants

protected List<? extends Grant> computeGrants(Subject subject)

Compute grants for the provided subject. This implementation gets grants from server getGrantsFromServer(io.helidon.security.Subject).

Parameters:

subject - to retrieve roles (or in general grants)

Returns:

future with grants to be added to the subject

addAdditionalGrants

protected List<? extends Grant> addAdditionalGrants(Subject subject,
 List<Grant> idcsGrants)

Extension point to add additional grants that are not retrieved from IDCS.

Parameters:

subject - subject to enhance

idcsGrants - grants obtained from IDCS

Returns:

grants to add to the subject

getGrantsFromServer

protected List<? extends Grant> getGrantsFromServer(Subject subject)

Retrieves grants from IDCS server.

Parameters:

subject - to get grants for

Returns:

optional list of grants to be added