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()

      getId.

      Returns:
      a String object

    • setId

      void setId(String id)

      setId.

      Parameters:
      id - a String object

    • getTypedId

      String getTypedId()

      getTypedId.

      Returns:
      a String object

    • getUsername

      String getUsername()

      getUsername.

      Returns:
      a String object

    • getAttribute

      Object getAttribute(String name)

      getAttribute.

      Parameters:
      name - a String object
      Returns:
      a Object object

    • getAttributes

      Map<String,Object> getAttributes()

      getAttributes.

      Returns:
      a Map object

    • containsAttribute

      boolean containsAttribute(String name)

      containsAttribute.

      Parameters:
      name - a String object
      Returns:
      a boolean

    • addAttribute

      void addAttribute(String key, Object value)

      addAttribute.

      Parameters:
      key - a String object
      value - a Object object

    • removeAttribute

      void removeAttribute(String key)

      removeAttribute.

      Parameters:
      key - a String object

    • addAuthenticationAttribute

      void addAuthenticationAttribute(String key, Object value)

      addAuthenticationAttribute.

      Parameters:
      key - a String object
      value - a Object object

    • removeAuthenticationAttribute

      void removeAuthenticationAttribute(String key)

      removeAuthenticationAttribute.

      Parameters:
      key - a String object

    • addRole

      void addRole(String role)

      addRole.

      Parameters:
      role - a String object

    • addRoles

      void addRoles(Collection<String> roles)

      addRoles.

      Parameters:
      roles - a Collection object

    • getRoles

      Set<String> getRoles()

      getRoles.

      Returns:
      a Set object

    • isRemembered

      boolean isRemembered()

      isRemembered.

      Returns:
      a boolean

    • setRemembered

      void setRemembered(boolean rme)

      setRemembered.

      Parameters:
      rme - a boolean

    • getClientName

      String getClientName()

      getClientName.

      Returns:
      a String object

    • setClientName

      void setClientName(String clientName)

      setClientName.

      Parameters:
      clientName - a String object

    • getLinkedId

      String getLinkedId()

      getLinkedId.

      Returns:
      a String object

    • setLinkedId

      void setLinkedId(String linkedId)

      setLinkedId.

      Parameters:
      linkedId - a String object

    • isExpired

      boolean isExpired()

      isExpired.

      Returns:
      a boolean

    • asPrincipal

      Principal asPrincipal()

      asPrincipal.

      Returns:
      a Principal object