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

@Deprecated(forRemoval=true,
            since="2.4.0")
public class IdcsRoleMapperProvider
extends IdcsRoleMapperProviderBase
implements SubjectMappingProvider

Deprecated, for removal: This API element is subject to removal in a future version.

use IdcsRoleMapperRxProvider instead

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>>	Deprecated, for removal: This API element is subject to removal in a future version. 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)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor that accepts any IdcsRoleMapperProvider.Builder descendant.

Method Summary

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

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

buildSubject, complete, defaultIdcsSubjectType, map, oidcConfig, processServerResponse

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 Detail

IdcsRoleMapperProvider

protected IdcsRoleMapperProvider(IdcsRoleMapperProvider.Builder<?> builder)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor that accepts any IdcsRoleMapperProvider.Builder descendant.

Parameters:

builder - used to configure this instance

Method Detail

builder

public static IdcsRoleMapperProvider.Builder<?> builder()

Deprecated, for removal: This API element is subject to removal in a future version.

Creates a new builder to build instances of this class.

Returns:

a new fluent API builder.

create

public static SecurityProvider create(Config config)

Deprecated, for removal: This API element is subject to removal in a future version.

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(Subject subject,
                          ProviderRequest request,
                          AuthenticationResponse previousResponse)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: IdcsRoleMapperProviderBase

Enhance subject with IDCS roles.

Specified by:

enhance in class IdcsRoleMapperProviderBase

Parameters:

subject - subject of the user (never null)

request - provider request

previousResponse - authenticated response (never null)

Returns:

stage with the new authentication response

computeGrants

protected Optional<List<Grant>> computeGrants(Subject subject)

Deprecated, for removal: This API element is subject to removal in a future version.

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:

An optional list of grants to be added to the subject

addAdditionalGrants

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Parameters:

subject - subject to enhance

Returns:

grants to add to the subject

getGrantsFromServer

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

Deprecated, for removal: This API element is subject to removal in a future version.

Retrieves grants from IDCS server.

Parameters:

subject - to get grants for

Returns:

optional list of grants to be added