Package org.apache.felix.webconsole.servlet

Interface User

All Known Subinterfaces:
User
@ProviderType public interface User
Representation of a user. The user object can be used by plugins to authorize(String) the user.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    USER_ATTRIBUTE
    The name of the request attribute providing an object of this class

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    authorize(String role)
    Checks whether the user has the given role permission.
    Object
    getUserObject()
    Return the user object.

  • Field Details

    • USER_ATTRIBUTE

      static final String USER_ATTRIBUTE
      The name of the request attribute providing an object of this class

  • Method Details

    • getUserObject

      Object getUserObject()
      Return the user object. This method might return null if no web console security provider is configured and access to the console is allowed without authentication.
      Returns:
      The user object or null

    • authorize

      boolean authorize(String role)
      Checks whether the user has the given role permission.
      Parameters:
      role - The requested role
      Returns:
      true if the user is given permission for the given role.