Package org.opencastproject.security.api

Interface Role

All Known Implementing Classes:
JaxbRole, JpaRole
public interface Role
Represent a role in Opencast

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Role.Target
    The target (intended purpose) of a set of roles USER - Roles which are assigned to users and/or groups to provide access to capabilities ACL - Roles which are used to manage access to resources (Event, Series) in an ACL ALL - All roles
    static enum 
    Role.Type
    The type of role: SYSTEM - A role granted automatically by Opencast, not persisted INTERNAL - A role indicating an ability that the user has within Opencast, persisted GROUP - A role indicating membership of an Opencast group, persisted EXTERNAL - A role granted to a user from an external system, not persisted EXTERNAL_GROUP - A role indicating membership of an Opencast group from an external system, not persisted DERIVED - A role which is derived from the user's group membership (a role which the group has), not persisted

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Comparator<Role>
    BY_NAME
    Orders roles by name, ignoring case, so that e.g.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Gets the role description
    String
    getName()
    Gets the role name
    String
    getOrganizationId()
    Returns the role's organization identifier.
    Role.Type
    getType()
    Returns the role's Role.Type

  • Field Details

    • BY_NAME

      static final Comparator<Role> BY_NAME
      Orders roles by name, ignoring case, so that e.g. "anna" is listed between "Anna" and "Leon". Names that only differ in case are ordered by their case, to keep the order stable.

  • Method Details

    • getName

      String getName()
      Gets the role name
      Returns:
      the role name

    • getDescription

      String getDescription()
      Gets the role description
      Returns:
      the role description

    • getOrganizationId

      String getOrganizationId()
      Returns the role's organization identifier.
      Returns:
      the organization identifier

    • getType

      Role.Type getType()
      Returns the role's Role.Type
      Returns:
      the type