Interface Principal

All Known Implementing Classes:

AnonymousPrincipal, AnonymousRolePrincipal, ModifiablePrincipal

public interface Principal

The principal represents a user. If no user was logged in, a special anonymous principal is used.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ADMIN_ROLE_TYPES

Method Summary

Modifier and Type	Method	Description
boolean	addRole(Role role)
Object	getAttribute(String key)	Use PrincipalAttributes for key name
Set<String>	getAttributeKeys()
String	getName()
Optional<Long>	getPrimaryKey()
Set<Role>	getRoles()
default boolean	hasAdminRole()	Returns true if the principal has a role to access the admin.
boolean	hasRole(String role)
boolean	isAnonymous()
boolean	isSupportUser()
boolean	removeRole(Role role)
boolean	requiresTwoFactorAuth()
void	setAttribute(String key, @Nullable Object value)	Use PrincipalAttributes for key name
void	setName(String name)

Field Details

ADMIN_ROLE_TYPES

static final Set<String> ADMIN_ROLE_TYPES

Method Details

isAnonymous

boolean isAnonymous()

requiresTwoFactorAuth

boolean requiresTwoFactorAuth()

isSupportUser

boolean isSupportUser()

getName

String getName()

setName

void setName(String name)
      throws UnauthorizedException

Throws:

UnauthorizedException

getRoles

Set<Role> getRoles()

addRole

boolean addRole(Role role)
         throws UnauthorizedException

Throws:

UnauthorizedException

removeRole

boolean removeRole(Role role)
            throws UnauthorizedException

Throws:

UnauthorizedException

hasRole

boolean hasRole(String role)

hasAdminRole

default boolean hasAdminRole()

Returns true if the principal has a role to access the admin.

setAttribute

void setAttribute(String key,
 @Nullable Object value)

Use PrincipalAttributes for key name

getAttribute

Object getAttribute(String key)

Use PrincipalAttributes for key name

getAttributeKeys

Set<String> getAttributeKeys()

getPrimaryKey

Optional<Long> getPrimaryKey()