org.nuxeo.ecm.platform.login

Class GroupImpl

java.lang.Object

org.nuxeo.ecm.platform.login.GroupImpl

All Implemented Interfaces:

Group, Principal

public class GroupImpl
extends Object
implements Group

This class implements a group of principals.

Author:

Satish Dharmaraj

Constructor Summary

Constructors

Constructor and Description
GroupImpl(String groupName) Constructs a Group object with no members.

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Principal user) adds the specified member to the group.
boolean	equals(Group other)
boolean	equals(Object obj) This function returns true if the group passed matches the group represented in this interface.
String	getName() return the name of the principal.
int	hashCode() return a hashcode for the principal.
boolean	isMember(Principal member) returns true if the passed principal is a member of the group.
Enumeration<? extends Principal>	members() returns the enumeration of the members in the group.
boolean	removeMember(Principal user) Removes the specified member from the group.
String	toString() Prints a stringified version of the group.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Constructor Detail

GroupImpl

public GroupImpl(String groupName)

Constructs a Group object with no members.

Parameters:

groupName - the name of the group

Method Detail

addMember

public boolean addMember(Principal user)

adds the specified member to the group.

Specified by:

addMember in interface Group

Parameters:

user - The principal to add to the group.

Returns:

true if the member was added - false if the member could not be added.

removeMember

public boolean removeMember(Principal user)

Removes the specified member from the group.

Specified by:

removeMember in interface Group

Parameters:

user - The principal to remove from the group.

Returns:

true if the principal was removed false if the principal was not a member

members

public Enumeration<? extends Principal> members()

returns the enumeration of the members in the group.

Specified by:

members in interface Group

equals

public boolean equals(Object obj)

This function returns true if the group passed matches the group represented in this interface.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

obj - the group to compare this group to.

equals

public boolean equals(Group other)

toString

public String toString()

Prints a stringified version of the group.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

hashCode

public int hashCode()

return a hashcode for the principal.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

isMember

public boolean isMember(Principal member)

returns true if the passed principal is a member of the group.

Specified by:

isMember in interface Group

Parameters:

member - The principal whose membership must be checked for.

Returns:

true if the principal is a member of this group, false otherwise

getName

public String getName()

return the name of the principal.

Specified by:

getName in interface Principal