Package ch.tocco.nice2.security.api

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.

Method Summary

Modifier and Type	Method	Description
boolean	addRole(Role role)
Object	getAttribute(String key)
Set<String>	getAttributeKeys()
String	getName()
Optional<Long>	getPrimaryKey()
Set<Role>	getRoles()
boolean	hasRole(String role)
boolean	isAnonymous()
boolean	isSupportUser()
boolean	removeRole(Role role)
boolean	requiresTwoFactorAuth()
void	setAttribute(String key, @Nullable Object value)
void	setName(String name)

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)

setAttribute

void setAttribute(String key,
 @Nullable
 @Nullable Object value)

getAttribute

Object getAttribute(String key)

getAttributeKeys

Set<String> getAttributeKeys()

getPrimaryKey

Optional<Long> getPrimaryKey()