org.assistments.domain.core

Class Group

java.lang.Object

org.assistments.domain.core.XInfoImpl

org.assistments.domain.core.AssistmentsPrincipal

org.assistments.domain.core.Group

All Implemented Interfaces:

java.lang.Comparable<AssistmentsPrincipal>, java.security.Principal, HasExternalReference, XInfo

public class Group
extends AssistmentsPrincipal
implements XInfo, HasExternalReference

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.GroupChildDepth

Nested classes/interfaces inherited from class org.assistments.domain.core.XInfoImpl

XInfoImpl.XInfoState

Constructor Summary

Constructors

Constructor and Description
Group(Group g)
Group(java.lang.String name)
Group(java.lang.String name, User owner)

Method Summary

Modifier and Type	Method and Description
boolean	addMember(AssistmentsPrincipal member) Adds a principal to this group.
void	addMembers(java.util.Set<AssistmentsPrincipal> members)
java.util.Set<Group>	getGroups(Group.GroupChildDepth childDepth)
java.util.Set<Group>	getGroupsContaining(AssistmentsPrincipal member, boolean stopOnFirst) Returns the groups containing a principal (as a member), at any level, in this group's hierarchy.
int	getMemberCount(Group.GroupChildDepth childDepth) Returns number of child members in a group.
(package private) java.util.Set<AssistmentsPrincipal>	getMembers()
java.util.Set<AssistmentsPrincipal>	getMembers(Group.GroupChildDepth childDepth)
java.util.Set<AssistmentsPrincipal>	getMembers(PrincipalType pType, Group.GroupChildDepth childDepth) Returns the child members of this group which are of a particular Class type.
User	getOwner()
java.util.Set<User>	getUsers(Group.GroupChildDepth childDepth) Returns a set of User members of this group.
java.time.Instant	getWhen()
ExternalReferenceType	getXrefType()
boolean	isActive()
boolean	isMember(AssistmentsPrincipal member, Group.GroupChildDepth depth) Returns whether a principal is a child of this group.
boolean	removeMember(AssistmentsPrincipal member) Removes a principal from this group.
(package private) void	replaceMembers(Group g) Replaces this Group's members with those belonging to the provided Group.
void	setActive(boolean isActive)
void	setOwner(User owner)
void	setWhen(java.time.Instant when)
java.lang.String	toString()
java.lang.String	toString(java.lang.String indent) Returns a String representation of this group's members formatted somewhat pretty.

Methods inherited from class org.assistments.domain.core.AssistmentsPrincipal

asPrincipalString, compareTo, equals, getDbid, getName, getPrincipalType, isPrincipalType, setDbid, setName

Methods inherited from class org.assistments.domain.core.XInfoImpl

asXinfoString, clearXinfo, getState, getType, getXid, getXinfo, getXref, hashCode, setXid, setXidOverride, setXinfo, setXref

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assistments.domain.core.XInfo

asXinfoString, clearXinfo, equals, getPrincipalType, getType, getXid, getXinfo, getXref, hashCode, setXid, setXidOverride, setXinfo, setXref

Methods inherited from interface org.assistments.domain.core.HasExternalReference

getDbid

Methods inherited from interface java.security.Principal

hashCode, implies

Constructor Detail

Group

public Group(java.lang.String name,
             User owner)

Group

public Group(java.lang.String name)

Group

public Group(Group g)

Method Detail

getOwner

public User getOwner()

Returns:

the owner

setOwner

public void setOwner(User owner)

Parameters:

owner - the owner to set

isActive

public boolean isActive()

setActive

public void setActive(boolean isActive)

getWhen

public java.time.Instant getWhen()

setWhen

public void setWhen(java.time.Instant when)

getMembers

java.util.Set<AssistmentsPrincipal> getMembers()

addMember

public boolean addMember(AssistmentsPrincipal member)
                  throws CycleDetectedException

Adds a principal to this group. A given principal can be be a group member once. Note: You cannot add a group as a member of itself.

Parameters:

member - The ASSISTments principal to add

Returns:

true if the principal was added; otherwise if the group already contains member the member remains in the group and returns false.

Throws:

CycleDetectedException - When adding a group would create a cycle of groups so that attempting to return the members of this group would be an endless. For example: Say you have two groups A and B where A contains B as a member, and B contains A as a member. If you add both A and B to this group an endless cycle would be created resulting in an endless execution (or stack overflow) in #allMembers() and addMember(AssistmentsPrincipal).

replaceMembers

void replaceMembers(Group g)

Replaces this Group's members with those belonging to the provided Group. For use by GroupBuilder

Parameters:

g - The Group whose members become the members of this Group.

addMembers

public void addMembers(java.util.Set<AssistmentsPrincipal> members)
                throws CycleDetectedException

Throws:

CycleDetectedException

removeMember

public boolean removeMember(AssistmentsPrincipal member)

Removes a principal from this group.

Parameters:

member - ASSISTments principal to remove

Returns:

true if the principal was removed; otherwise false

isMember

public boolean isMember(AssistmentsPrincipal member,
                        Group.GroupChildDepth depth)

Returns whether a principal is a child of this group.

Parameters:

member - ASSISTments principal of interest

childDepth - Specifies to search only direct members or all descendant members.

Returns:

true if member is a direct child of the group; otherwise false

getUsers

public java.util.Set<User> getUsers(Group.GroupChildDepth childDepth)

Returns a set of User members of this group.

Parameters:

childDepth - Specifies to return direct User members or all descendant User members.

getGroups

public java.util.Set<Group> getGroups(Group.GroupChildDepth childDepth)

getMembers

public java.util.Set<AssistmentsPrincipal> getMembers(PrincipalType pType,
                                                      Group.GroupChildDepth childDepth)

Returns the child members of this group which are of a particular Class type. Note: The returned set contains only GroupMemberInfos - it does not contain subclass objects such as User or Group. From the set members you can obtain the member's name and persistence ID.

Parameters:

classType - Class of interest.

childDepth - Specifies to return direct members or all descendant members.

See Also:

GroupMemberInfo

getMemberCount

public int getMemberCount(Group.GroupChildDepth childDepth)

Returns number of child members in a group. When counting all descendant children, (@link Group.GroupChildDepth.ANY_CHILD, the same member appearing in more than one child group is counted multiple times.

If you are interested in unique members only, use getMembers(GroupChildDepth) or getMembers(PrincipalType, GroupChildDepth).

Parameters:

childDepth - Specifies whether to count direct children of this group or all descendant children.

Returns:

The member count

getMembers

public java.util.Set<AssistmentsPrincipal> getMembers(Group.GroupChildDepth childDepth)

getGroupsContaining

public java.util.Set<Group> getGroupsContaining(AssistmentsPrincipal member,
                                                boolean stopOnFirst)

Returns the groups containing a principal (as a member), at any level, in this group's hierarchy.

Parameters:

member - ASSISTments principal of interest

stopOnFirst - signals whether to stop and return the first group in which member was found, if any.

Returns:

A list of groups containing member. An empty list means member was not found anywhere in the group's hierarchy.

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Specified by:

toString in interface XInfo

Overrides:

toString in class AssistmentsPrincipal

toString

public java.lang.String toString(java.lang.String indent)

Description copied from class: AssistmentsPrincipal

Returns a String representation of this group's members formatted somewhat pretty.

Specified by:

toString in interface XInfo

Overrides:

toString in class AssistmentsPrincipal

Parameters:

indent - A String of one or more space characters to indent each level of nested groups and members.

getXrefType

public ExternalReferenceType getXrefType()

Specified by:

getXrefType in interface HasExternalReference