Package org.pac4j.core.profile

Interface UserProfile

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractJwtProfile, AnonymousProfile, BasicUserProfile, CommonProfile
public interface UserProfile extends Serializable
The contract that all user profiles must respect.
Since:
4.0.0
Author:
Jerome Leleu

  • Method Details

    • getId

      String getId()

    • setId

      void setId(String id)

    • getTypedId

      String getTypedId()

    • getUsername

      String getUsername()

    • getAttribute

      Object getAttribute(String name)

    • getAttributes

      Map<String,Object> getAttributes()

    • containsAttribute

      boolean containsAttribute(String name)

    • addAttribute

      void addAttribute(String key, Object value)

    • removeAttribute

      void removeAttribute(String key)

    • addAuthenticationAttribute

      void addAuthenticationAttribute(String key, Object value)

    • removeAuthenticationAttribute

      void removeAuthenticationAttribute(String key)

    • addRole

      void addRole(String role)

    • addRoles

      void addRoles(Collection<String> roles)

    • getRoles

      Set<String> getRoles()

    • addPermission

      @Deprecated void addPermission(String permission)
      Deprecated.

    • addPermissions

      @Deprecated void addPermissions(Collection<String> permissions)
      Deprecated.

    • getPermissions

      @Deprecated Set<String> getPermissions()
      Deprecated.

    • isRemembered

      boolean isRemembered()

    • setRemembered

      void setRemembered(boolean rme)

    • getClientName

      String getClientName()

    • setClientName

      void setClientName(String clientName)

    • getLinkedId

      String getLinkedId()

    • setLinkedId

      void setLinkedId(String linkedId)

    • isExpired

      boolean isExpired()

    • asPrincipal

      Principal asPrincipal()