Package io.helidon.security

Class Principal

java.lang.Object

io.helidon.security.Principal

All Implemented Interfaces:

AbacSupport, Principal

public class Principal
extends Object
implements AbacSupport, Principal

A security principal.

See Also:

Principal

Nested Class Summary

Nested Classes

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

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

AbacSupport.BasicAttributes

Method Summary

Modifier and Type	Method	Description
static Principal.Builder	builder()	Creates a fluent API builder to build new instances of this class.
static Principal	create(String id)	Create a principal instance for an id (or name).
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	getId()	Id of this principal.
String	getName()
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

Method Detail

builder

public static Principal.Builder builder()

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

Returns:

a builder instance

create

public static Principal create(String id)

Create a principal instance for an id (or name).

Parameters:

id - identification used both for name and id attributes of this principal

Returns:

a new principal with the specified id (and name)

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

getName

public String getName()

Specified by:

getName in interface Principal

getId

public String getId()

Id of this principal.

Returns:

id if defined, name otherwise

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object