Package io.helidon.security.abac.role

Class RoleValidator.RoleConfig

java.lang.Object

io.helidon.security.abac.role.RoleValidator.RoleConfig

All Implemented Interfaces:

AbacValidatorConfig

Enclosing class:

RoleValidator

public static class RoleValidator.RoleConfig
extends java.lang.Object
implements AbacValidatorConfig

Attribute configuration class for Role validator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoleValidator.RoleConfig.Builder	A fluent API builder for RoleValidator.RoleConfig.

Method Summary

Modifier and Type	Method	Description
static RoleValidator.RoleConfig.Builder	builder()	A new builder for this class instances.
static RoleValidator.RoleConfig	from(Config config)	Will read roles allowed from configuration.
static RoleValidator.RoleConfig	from(java.lang.String... rolesAllowed)	Create roles config from an array of allowed roles.
static RoleValidator.RoleConfig	from(java.util.Collection<java.lang.String> rolesAllowed)	Create roles config from a collection of allowed roles.
java.util.Set<java.lang.String>	getServiceRolesAllowed()	Set of roles required for a service.
java.util.Set<java.lang.String>	getUserRolesAllowed()	Set of roles required for a user.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static RoleValidator.RoleConfig.Builder builder()

A new builder for this class instances.

Returns:

builder

from

public static RoleValidator.RoleConfig from(java.util.Collection<java.lang.String> rolesAllowed)

Create roles config from a collection of allowed roles.

Parameters:

rolesAllowed - roles allowed

Returns:

instance configured with the userRolesAllowed

from

public static RoleValidator.RoleConfig from(java.lang.String... rolesAllowed)

Create roles config from an array of allowed roles.

Parameters:

rolesAllowed - roles allowed

Returns:

instance configured with the userRolesAllowed

from

public static RoleValidator.RoleConfig from(Config config)

Will read roles allowed from configuration. Format (yaml):

 roles-allowed:
  user: ["role1","role2"]
  service: ["role3]
 

Parameters:

config - configuration located on key "roles-allowed"

Returns:

roles config for the configuration

getServiceRolesAllowed

public java.util.Set<java.lang.String> getServiceRolesAllowed()

Set of roles required for a service.

Returns:

set of roles

getUserRolesAllowed

public java.util.Set<java.lang.String> getUserRolesAllowed()

Set of roles required for a user.

Returns:

set of roles