ScopeValidator (Helidon 0.10.4 API)

java.lang.Object
- io.helidon.security.abac.scope.ScopeValidator

All Implemented Interfaces:: AbacValidator<ScopeValidator.ScopesConfig>

public final class ScopeValidator
extends java.lang.Object
implements AbacValidator<ScopeValidator.ScopesConfig>

ABAC validator for OAuth2 scopes.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ScopeValidator.Builder`	A fluent API builder for `ScopeValidator`.
`static interface`	`ScopeValidator.Scope`	Scope annotation.
`static interface`	`ScopeValidator.Scopes`	Repeatable annotation for `ScopeValidator.Scope`.
`static class`	`ScopeValidator.ScopesConfig`	Configuration custom class for scope validator.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String SCOPE_GRANT_TYPE
Use this type when constructing a Grant, so this validator can accept it as a scope.

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`SCOPE_GRANT_TYPE`	Use this type when constructing a `Grant`, so this validator can accept it as a scope.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ScopeValidator.Builder`	`builder()`	Create a fluent API builder.
`ScopeValidator.ScopesConfig`	`combine(ScopeValidator.ScopesConfig parent, ScopeValidator.ScopesConfig child)`	Combine two configuration (such as one obtained from annotation and one from config).
`java.lang.Class<ScopeValidator.ScopesConfig>`	`configClass()`	Class of the configuration type.
`java.lang.String`	`configKey()`	Key of a configuration entry that maps to this validator's configuration.
`static ScopeValidator`	`create()`	Create an instance of scope validator with default configuration.
`static ScopeValidator`	`from(Config config)`	Create a new validator instance from configuration.
`ScopeValidator.ScopesConfig`	`fromAnnotations(java.util.List<? extends java.lang.annotation.Annotation> annotations)`	Load configuration class instance from annotations this validator expects.
`ScopeValidator.ScopesConfig`	`fromConfig(Config config)`	Load configuration class instance from `Config`.
`java.util.Collection<java.lang.Class<? extends java.lang.annotation.Annotation>>`	`supportedAnnotations()`	Provide extension annotations supported by this validator (e.g.
`void`	`validate(ScopeValidator.ScopesConfig config, Errors.Collector collector, ProviderRequest request)`	Validate that the configuration provided would grant access to the resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCOPE_GRANT_TYPE
```
public static final java.lang.String SCOPE_GRANT_TYPE
```
    Use this type when constructing a Grant, so this validator can accept it as a scope.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - builder
```
public static ScopeValidator.Builder builder()
```
    Create a fluent API builder.
    
    Returns:
    
    a new builder instance
  - create
```
public static ScopeValidator create()
```
    Create an instance of scope validator with default configuration.
    
    Returns:
    
    scope validator that uses "AND" operator for required scopes
  - from
```
public static ScopeValidator from(Config config)
```
    Create a new validator instance from configuration.
    
    Parameters:
    
    config - configuration on the key of this provider
    
    Returns:
    
    scope validator instance
  - configClass
```
public java.lang.Class<ScopeValidator.ScopesConfig> configClass()
```
    Description copied from interface: AbacValidator
    
    Class of the configuration type.
    
    Specified by:
    
    configClass in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Returns:
    
    class of the type
  - supportedAnnotations
```
public java.util.Collection<java.lang.Class<? extends java.lang.annotation.Annotation>> supportedAnnotations()
```
    Description copied from interface: AbacValidator
    
    Provide extension annotations supported by this validator (e.g. RolesAllowed). Annotations will be collected according to framework in use. For JAX-RS, annotations from application class, resource class and resource methods will be collected. The annotations will be transformed to configuration by AbacValidator.fromAnnotations(List).
    
    Specified by:
    
    supportedAnnotations in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Returns:
    
    Collection of annotations this provider expects.
  - configKey
```
public java.lang.String configKey()
```
    Description copied from interface: AbacValidator
    
    Key of a configuration entry that maps to this validator's configuration.
    
    Specified by:
    
    configKey in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Returns:
    
    key in a config Config
  - fromConfig
```
public ScopeValidator.ScopesConfig fromConfig(Config config)
```
    Description copied from interface: AbacValidator
    
    Load configuration class instance from Config.
    
    Specified by:
    
    fromConfig in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Parameters:
    
    config - configuration located on the key this validator expects in AbacValidator.configKey()
    
    Returns:
    
    instance of configuration class
  - fromAnnotations
```
public ScopeValidator.ScopesConfig fromAnnotations(java.util.List<? extends java.lang.annotation.Annotation> annotations)
```
    Description copied from interface: AbacValidator
    
    Load configuration class instance from annotations this validator expects.
    
    Specified by:
    
    fromAnnotations in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Parameters:
    
    annotations - annotations collected from resource if annotations are supported
    
    Returns:
    
    instance of configuration class
  - combine
```
public ScopeValidator.ScopesConfig combine(ScopeValidator.ScopesConfig parent,
                                           ScopeValidator.ScopesConfig child)
```
    Description copied from interface: AbacValidator
    
    Combine two configuration (such as one obtained from annotation and one from config).
    
    Specified by:
    
    combine in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Parameters:
    
    parent - The parent configuration (e.g. obtained from annotation)
    
    child - The child configuration (e.g. obtained from explicit object)
    
    Returns:
    
    combined configuration
  - validate
```
public void validate(ScopeValidator.ScopesConfig config,
                     Errors.Collector collector,
                     ProviderRequest request)
```
    Description copied from interface: AbacValidator
    
    Validate that the configuration provided would grant access to the resource. Update collector with errors, if access should be denied using Errors.Collector.fatal(Object, String).
    
    Specified by:
    
    validate in interface AbacValidator<ScopeValidator.ScopesConfig>
    
    Parameters:
    
    config - configuration of this validator
    
    collector - error collector to gather issues with this request (e.g. "service not in role ABC")
    
    request - ABAC context containing subject(s), object(s) and environment

Class ScopeValidator

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCOPE_GRANT_TYPE

Method Detail

builder

create

from

configClass

supportedAnnotations

configKey

fromConfig

fromAnnotations

combine

validate