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, java.lang.Comparable<Group>

public class GroupEntity
extends java.lang.Object
implements GroupWithAttributes, java.lang.Comparable<Group>

Represents a Group entity.

Since:

v2.1

Constructor Summary

GroupEntity(java.lang.String name, java.lang.String description, GroupType type, boolean active)

Method Summary

int	compareTo(Group o)
boolean	equals(java.lang.Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
AttributeEntityList	getAttributes()
java.lang.String	getDescription()
long	getDirectoryId()
java.util.Set<java.lang.String>	getKeys() Gets all the keys of the attributes.
java.lang.String	getName()
GroupType	getType()
java.lang.String	getValue(java.lang.String key) Returns the value associated with the given key, returns null if there is no value, or throws an exception if there is more than one value.
java.util.Set<java.lang.String>	getValues(java.lang.String key) Get all the values associated with a given key.
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()
boolean	isEmpty()
static GroupEntity	newMinimalInstance(java.lang.String groupName) Creates a new minimal group instance.
void	setAttributes(AttributeEntityList attributes)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupEntity

public GroupEntity(java.lang.String name,
                   java.lang.String description,
                   GroupType type,
                   boolean active)

Method Detail

getDescription

public java.lang.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 java.lang.String getName()

Specified by:

getName in interface DirectoryEntity

Returns:

name of the entity.

setAttributes

public void setAttributes(AttributeEntityList attributes)

getAttributes

public AttributeEntityList getAttributes()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getValues

public java.util.Set<java.lang.String> getValues(java.lang.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, or null if the key does not exist.

getValue

public java.lang.String getValue(java.lang.String key)
                          throws DuplicateAttributeValueException

Description copied from interface: Attributes

Returns the value associated with the given key, returns null if there is no value, or throws an exception if there is more than one value.

Specified by:

getValue in interface Attributes

Parameters:

key - the key to retrieve the value for

Returns:

the value associated with the given key, or null if there is no value

Throws:

DuplicateAttributeValueException - if the attribute has more than one value stored against it

getKeys

public java.util.Set<java.lang.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 java.lang.Comparable<Group>

equals

public boolean equals(java.lang.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 java.lang.Object

Parameters:

o - object to compare to.

Returns:

true if and only if the directoryId and name.toLowerCase() 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 java.lang.Object

Returns:

hashcode.

newMinimalInstance

public static GroupEntity newMinimalInstance(java.lang.String groupName)

Creates a new minimal group instance.

Parameters:

groupName - group name

Returns:

minimal group instance