Module cloud.piranha.core.api

Package cloud.piranha.core.api

Interface AuthenticatedIdentity

All Superinterfaces:

Principal

All Known Implementing Classes:

DefaultAuthenticatedIdentity

public interface AuthenticatedIdentity
extends Principal

This interface is implemented by classes that represent the current authenticated identity.

What current means here is context dependent. In a Jakarta Servlet application this refers to the caller (user) details during a single HTTP request.

Author:

Arjan Tijms

Method Summary

Modifier and Type	Method	Description
Principal	getCallerPrincipal()	Returns the caller principal, which represents the primary name of the calling entity (aka the "caller") to a server.
Set<String>	getGroups()	The groups the caller is in.
default String	getName()

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Method Details

getName

default String getName()

Specified by:

getName in interface Principal

getCallerPrincipal

Principal getCallerPrincipal()

Returns the caller principal, which represents the primary name of the calling entity (aka the "caller") to a server.

Returns:

the caller principal, or null if authentication has not (yet) completed successfully.

getGroups

Set<String> getGroups()

The groups the caller is in.

If group to role mapping is not active (the default) groups are equal to roles.

Returns:

the set of groups the caller is in, never null.