Package com.attivio.sdk.security

Class AttivioRole

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class AttivioRole
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
    An AttivioRole represents role authorization permissions on client APIs.

    It has a required name representing the role name, and an optional subgroup/resource for partitioning of the role.

    For example, a module might have an administrative role like: 

      AttivioUserRole('ROLE_MODULE_ADMIN')
    And it might have collection specific roles like: 
      AttivioUserRole('ROLE_MODULE_USER','support')
  AttivioUserRole('ROLE_MODULE_USER','production')
    Or collectionId specific roles, like: 
      AttivioUserRole('ROLE_MODULE_USER','collection001')
  AttivioUserRole('ROLE_MODULE_USER','collection002')
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String SUBGROUP_ANY
      Represents that all subroups match.

    • Constructor Summary

      Constructors 
      Constructor Description
      AttivioRole()
      Constructor intended for use by serialization code.
      AttivioRole​(java.lang.Enum<?> role)
      Constructs a user role via an enum value for the role name.
      AttivioRole​(java.lang.Enum<?> role, java.lang.String subgroup)
      Constructs a user role with an enum value for name and a subgroup.
      AttivioRole​(java.lang.String name)
      Constructs a user role from a role name.
      AttivioRole​(java.lang.String name, java.lang.String subgroup)
      Constructs a user role from name and subgroup.

    • Field Detail

      • SUBGROUP_ANY

        public static final java.lang.String SUBGROUP_ANY
        Represents that all subroups match.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AttivioRole

        public AttivioRole()
        Constructor intended for use by serialization code.

      • AttivioRole

        public AttivioRole​(java.lang.String name,
                   java.lang.String subgroup)
        Constructs a user role from name and subgroup.
        Parameters:
        name - the name
        subgroup - the subgroup or resource

      • AttivioRole

        public AttivioRole​(java.lang.String name)
        Constructs a user role from a role name.
        Parameters:
        name - the name

      • AttivioRole

        public AttivioRole​(java.lang.Enum<?> role)
        Constructs a user role via an enum value for the role name.
        Parameters:
        role - any Enum which maps to role names.

      • AttivioRole

        public AttivioRole​(java.lang.Enum<?> role,
                   java.lang.String subgroup)
        Constructs a user role with an enum value for name and a subgroup.
        Parameters:
        role - any Enum which maps to role names.
        subgroup - Subgroup or resource.

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns:
        the role name

      • setName

        public void setName​(java.lang.String name)
        Sets the role name.
        Parameters:
        name - the role name

      • getSubgroup

        public java.lang.String getSubgroup()
        Returns:
        the subgroup

      • setSubgroup

        public void setSubgroup​(java.lang.String subgroup)
        Sets the subgroup
        Parameters:
        subgroup -

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • clone

        public AttivioRole clone()
                  throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException