org.ow2.jonas.lib.security.auth
Class JGroup

java.lang.Object
  org.ow2.jonas.lib.security.auth.JGroup

All Implemented Interfaces:

Serializable, Group, Principal

Direct Known Subclasses:

JSigned

public class JGroup
extends Object
implements Group, Serializable

This class represents all the roles of a principal (group of principals). These roles are added to the Subject

Author:

Florent Benoit

See Also:

Serialized Form

Constructor Summary

JGroup(String name)
Build a new group with the following name

Method Summary

boolean	addMember(Principal user) Adds the specified member to the group.
boolean	equals(Object another) Compares this principal to the specified object.
String	getName() Returns the name of this principal.
int	hashCode() Returns a hashcode for this principal.
boolean	isMember(Principal member) Returns true if the passed principal is a member of the group.
Enumeration	members() Returns an enumeration of the members in the group.
boolean	removeMember(Principal user) Removes the specified member from the group.
String	toString() Returns a string representation of this principal.

Methods inherited from class java.lang.Object

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

Constructor Detail

JGroup

public JGroup(String name)

Build a new group with the following name

Parameters:

name - name of the group

Method Detail

equals

public boolean equals(Object another)

Compares this principal to the specified object. Returns true if the object passed in matches the principal represented by the implementation of this interface.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

another - principal to compare with.

Returns:

true if the principal passed in is the same as that encapsulated by this principal, and false otherwise.

toString

public String toString()

Returns a string representation of this principal.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

a string representation of this principal.

hashCode

public int hashCode()

Returns a hashcode for this principal.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

a hashcode for this principal.

getName

public String getName()

Returns the name of this principal.

Specified by:

getName in interface Principal

Returns:

the name of this principal.

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 this group.

Returns:

true if the member was successfully added, false if the principal was already a member.

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 this group.

Returns:

true if the principal was removed, or false if the principal was not a member.

isMember

public boolean isMember(Principal member)

Returns true if the passed principal is a member of the group. This method does a recursive search, so if a principal belongs to a group which is a member of this group, true is returned.

Specified by:

isMember in interface Group

Parameters:

member - the principal whose membership is to be checked.

Returns:

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

members

public Enumeration members()

Returns an enumeration of the members in the group. The returned objects can be instances of either Principal or Group (which is a subclass of Principal).

Specified by:

members in interface Group

Returns:

an enumeration of the group members.