Package io.helidon.security

Class Grant

java.lang.Object

io.helidon.security.Grant

All Implemented Interfaces:

AbacSupport, Principal

Direct Known Subclasses:

Role

public class Grant
extends Object
implements AbacSupport, Principal

A concept representing anything that can be granted to a subject. This may be:

• role
• scope
• permission
• anything else grantable, including additional principals

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Grant.Builder<T extends Grant.Builder>	A fluent API builder for Grant.

Nested classes/interfaces inherited from interface io.helidon.security.util.AbacSupport

AbacSupport.BasicAttributes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Grant(Grant.Builder<?> builder)	Create an instance based on a builder.
protected	Grant(String type, String name)	Create an instance for a type and a name.
protected	Grant(String type, String name, AbacSupport abacSupport)	Create an instance for a type and a name and a set of custom attributes.

Method Summary

Modifier and Type	Method	Description
static Grant.Builder	builder()	Creates a fluent API builder to build new instances of this class.
Collection<String>	getAttributeNames()	A collection of all property names in this container.
Object	getAttributeRaw(String key)	Return the actual property value or null if not present.
String	getName()
String	getType()	Type of this grant.
String	toString()

Methods inherited from interface io.helidon.security.util.AbacSupport

getAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Constructor Detail

Grant

protected Grant(String type,
                String name)

Create an instance for a type and a name.

Parameters:

type - type of the grant (currently in use are "role" and "scope")

name - name of the grant (e.g. "admin", "calendar-read" etc.)

Grant

protected Grant(String type,
                String name,
                AbacSupport abacSupport)

Create an instance for a type and a name and a set of custom attributes.

Parameters:

type - type of the grant (currently in use are "role" and "scope")

name - name of the grant (e.g. "admin", "calendar-read" etc.)

abacSupport - container of attributes to be available to attribute based access control (e.g. "nickname")

Grant

protected Grant(Grant.Builder<?> builder)

Create an instance based on a builder.

Parameters:

builder - builder instance

Method Detail

builder

public static Grant.Builder builder()

Creates a fluent API builder to build new instances of this class.

Returns:

builder instance

getAttributeRaw

public Object getAttributeRaw(String key)

Description copied from interface: AbacSupport

Return the actual property value or null if not present. This is the only method that needs to be implemented.

Specified by:

getAttributeRaw in interface AbacSupport

Parameters:

key - key (name) of the property

Returns:

value of the property or null

getAttributeNames

public Collection<String> getAttributeNames()

Description copied from interface: AbacSupport

A collection of all property names in this container.

Specified by:

getAttributeNames in interface AbacSupport

Returns:

collection of keys

getType

public String getType()

Type of this grant. Known types:

• "role" - represents a role grant, also a dedicated class is created for this type: Role
• "scope" - represents a OAuth2 scope grant

Returns:

type of the grant

getName

public String getName()

Specified by:

getName in interface Principal

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object