Package io.helidon.security

Class Subject

java.lang.Object

io.helidon.security.Subject

All Implemented Interfaces:

AbacSupport

public final class Subject
extends java.lang.Object
implements AbacSupport

A security subject, representing a user or a service.

Nested Class Summary

Nested Classes

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

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

AbacSupport.BasicAttributes

Method Summary

Modifier and Type	Method and Description
static Subject.Builder	builder() Creates a fluent API builder to build new instances of this class.
Subject	combine(Subject another) Will add all principals and credentials from another subject to this subject, will not replace getPrincipals().
static Subject	create(Principal principal) Create a new subject for a principal.
java.util.Collection<java.lang.String>	getAttributeNames() A collection of all property names in this container.
java.lang.Object	getAttributeRaw(java.lang.String key) Return the actual property value or null if not present.
<T extends Grant> java.util.List<T>	getGrants(java.lang.Class<T> grantType) Get all grants of a specific type determined by type's class.
java.util.List<Grant>	getGrantsByType(java.lang.String grantType) Get all grants of a specific type determined by type's name.
Principal	getPrincipal() Get the principal this subject is created for (e.g.
java.util.List<Principal>	getPrincipals() Get all principals of this subject (including the one returned by getPrincipal()).
<T> java.util.Optional<T>	getPrivateCredential(java.lang.Class<T> credential) Get private credential for the specified type.
<T> java.util.Optional<T>	getPublicCredential(java.lang.Class<T> credential) Get public credential for the specified type.
javax.security.auth.Subject	toJavaSubject() Create a java Subject from this subject.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

getAttribute

Method Detail

builder

public static Subject.Builder builder()

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

Returns:

a new builder instance

create

public static Subject create(Principal principal)

Create a new subject for a principal. If you want to configure additional details (Grants, public and/or private credentials, additional Principals), please use fluent API builder().

Parameters:

principal - principal this subject represents

Returns:

a new subject instance with the single principal

getPrincipal

public Principal getPrincipal()

Get the principal this subject is created for (e.g. the "main" principal of this subject).

Returns:

principal

getPrincipals

public java.util.List<Principal> getPrincipals()

Get all principals of this subject (including the one returned by getPrincipal()).

Returns:

all principals of this subject

getGrants

public <T extends Grant> java.util.List<T> getGrants(java.lang.Class<T> grantType)

Get all grants of a specific type determined by type's class.

Type Parameters:

T - type of the grant's type (e.g. Role

Parameters:

grantType - type of grant (e.g. Role.class)

Returns:

list of grants of the specific type associated with this subject (may be empty)

getGrantsByType

public java.util.List<Grant> getGrantsByType(java.lang.String grantType)

Get all grants of a specific type determined by type's name.

Parameters:

grantType - type of grant (e.g. "role" or "scope")

Returns:

list of grants of the specific type associated with this subject (may be empty)

getAttributeRaw

public java.lang.Object getAttributeRaw(java.lang.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 java.util.Collection<java.lang.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

getPublicCredential

public <T> java.util.Optional<T> getPublicCredential(java.lang.Class<T> credential)

Get public credential for the specified type.

Type Parameters:

T - credential type

Parameters:

credential - credential type's class

Returns:

optional of public credential of the type defined

getPrivateCredential

public <T> java.util.Optional<T> getPrivateCredential(java.lang.Class<T> credential)

Get private credential for the specified type.

Type Parameters:

T - credential type

Parameters:

credential - credential type's class

Returns:

optional of private credential of the type defined

toJavaSubject

public javax.security.auth.Subject toJavaSubject()

Create a java Subject from this subject.

Returns:

an instance of Subject

combine

public Subject combine(Subject another)

Will add all principals and credentials from another subject to this subject, will not replace getPrincipals().

Parameters:

another - the other subject to combine with this subject

Returns:

a new subject that is a combination of this subject and the other subject, this subject is more significant

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object