Package com.atlassian.crowd.integration.rest.entity

Class GroupEntity

java.lang.Object
com.atlassian.crowd.integration.rest.entity.GroupEntity
All Implemented Interfaces:
Attributes, DirectoryEntity, Group, GroupWithAttributes, GroupWithMembers, Comparable<Group>
public class GroupEntity extends Object implements GroupWithAttributes, Comparable<Group>
Represents a Group entity.
Since:
v2.1

  • Constructor Details

  • Method Details

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface Group
      Returns:
      description of the group or null if there is no description.

    • getType

      public GroupType getType()
      Specified by:
      getType in interface Group
      Returns:
      the type of the group.

    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface Group
      Returns:
      true if and only if the user is allowed to authenticate.

    • getDirectoryId

      public long getDirectoryId()
      Specified by:
      getDirectoryId in interface DirectoryEntity
      Returns:
      id of the directory in which the DirectoryEntity is stored.

    • getName

      public String getName()
      Specified by:
      getName in interface DirectoryEntity
      Returns:
      name of the entity.

    • setAttributes

      public void setAttributes(MultiValuedAttributeEntityList attributes)

    • getAttributes

      @Nullable public MultiValuedAttributeEntityList getAttributes()

    • getExternalId

      @Nullable public String getExternalId()
      Description copied from interface: Group
      This will return null for directories which do not support external ids
      Specified by:
      getExternalId in interface Group
      Returns:
      external id of the group or null it there is no external id

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getValues

      @Nullable public Set<String> getValues(String key)
      Description copied from interface: Attributes
      Get all the values associated with a given key. Duplicate values are not allowed, and this should be enforced case-insensitively to match the behaviour of LDAP servers. Will return null if the key does not exist.
      Specified by:
      getValues in interface Attributes
      Parameters:
      key - the key to retrieve the values for
      Returns:
      the values associated with the given key. It may return null or empty set if the key does not exist.

    • getValue

      @Nullable public String getValue(String key)
      Description copied from interface: Attributes
      Returns any value associated with the given key, returns null if there is no value.
      Specified by:
      getValue in interface Attributes
      Parameters:
      key - the key to retrieve the value for
      Returns:
      any value associated with the given key, or null if there is no value

    • getKeys

      public Set<String> getKeys()
      Description copied from interface: Attributes
      Gets all the keys of the attributes. Warning: case-insensitive keys are currently no enforced, however this is the case for LDAP, so this may be implemented in the future.
      Specified by:
      getKeys in interface Attributes
      Returns:
      a set of all the keys.

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Attributes
      Returns:
      true if there are no attributes

    • compareTo

      public int compareTo(Group o)
      Specified by:
      compareTo in interface Comparable<Group>

    • equals

      public boolean equals(Object o)
      Description copied from interface: DirectoryEntity
      Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
      Specified by:
      equals in interface DirectoryEntity
      Overrides:
      equals in class Object
      Parameters:
      o - object to compare to.
      Returns:
      true if and only if the directoryId and the lowercase names of the directory entities match.

    • hashCode

      public int hashCode()
      Description copied from interface: DirectoryEntity
      Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
      Specified by:
      hashCode in interface DirectoryEntity
      Overrides:
      hashCode in class Object
      Returns:
      hashcode.

    • newMinimalInstance

      public static GroupEntity newMinimalInstance(String groupName)
      Creates a new minimal group instance.
      Parameters:
      groupName - group name
      Returns:
      minimal group instance