Package org.pac4j.core.profile

Interface UserProfile

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractJwtProfile, AnonymousProfile, BasicUserProfile, CommonProfile

public interface UserProfile
extends Serializable

A minimal user profile: the getId() method must be implemented, absolutely required methods have a default behavior, others throw a UnsupportedOperationException.

Since:

4.0.0

Author:

Jerome Leleu

Method Summary

Modifier and Type	Method	Description
default void	addPermission(String permission)
default void	addPermissions(Collection<String> permissions)
default void	addRole(String role)
default void	addRoles(Collection<String> roles)
default Principal	asPrincipal()
default boolean	containsAttribute(String name)
default Object	getAttribute(String name)
default String	getClientName()
String	getId()
default Set<String>	getPermissions()
default Set<String>	getRoles()
default String	getUsername()
default boolean	isExpired()
default boolean	isRemembered()
default void	setClientName(String clientName)
default void	setRemembered(boolean rme)

Method Detail

getId

String getId()

getUsername

default String getUsername()

getAttribute

default Object getAttribute(String name)

containsAttribute

default boolean containsAttribute(String name)

addRole

default void addRole(String role)

addRoles

default void addRoles(Collection<String> roles)

getRoles

default Set<String> getRoles()

addPermission

default void addPermission(String permission)

addPermissions

default void addPermissions(Collection<String> permissions)

getPermissions

default Set<String> getPermissions()

isRemembered

default boolean isRemembered()

setRemembered

default void setRemembered(boolean rme)

getClientName

default String getClientName()

setClientName

default void setClientName(String clientName)

isExpired

default boolean isExpired()

asPrincipal

default Principal asPrincipal()