Package org.codelibs.fess.entity

Interface FessUser

All Superinterfaces:
Serializable
All Known Implementing Classes:
EntraIdCredential.EntraIdUser, LdapUser, OpenIdConnectCredential.OpenIdUser, SamlCredential.SamlUser
public interface FessUser extends Serializable
Interface representing a Fess user with authentication and authorization information. Provides access to user name, roles, groups, and permissions.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getGroupNames()
    Gets the user's assigned group names.
    String
    getName()
    Gets the user's display name.
    String[]
    getPermissions()
    Gets the user's permissions.
    String[]
    getRoleNames()
    Gets the user's assigned role names.
    default boolean
    isEditable()
    Determines if the user's information can be edited.
    default boolean
    refresh()
    Refreshes the user's information from the underlying data source.

  • Method Details

    • getName

      String getName()
      Gets the user's display name.
      Returns:
      The user's name.

    • getRoleNames

      String[] getRoleNames()
      Gets the user's assigned role names.
      Returns:
      Array of role names.

    • getGroupNames

      String[] getGroupNames()
      Gets the user's assigned group names.
      Returns:
      Array of group names.

    • getPermissions

      String[] getPermissions()
      Gets the user's permissions.
      Returns:
      Array of permission strings.

    • isEditable

      default boolean isEditable()
      Determines if the user's information can be edited.
      Returns:
      True if the user's information is editable, false otherwise.

    • refresh

      default boolean refresh()
      Refreshes the user's information from the underlying data source.
      Returns:
      True if refresh was successful, false otherwise.