Package org.apache.karaf.jaas.boot.principal

Class GroupPrincipal

java.lang.Object

org.apache.karaf.jaas.boot.principal.GroupPrincipal

All Implemented Interfaces:

Serializable, Principal, Group

public class GroupPrincipal
extends Object
implements Group, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GroupPrincipal(String name)

Method Summary

Modifier and Type	Method	Description
boolean	addMember(Principal user)	Adds the specified member to the group.
boolean	equals(Object o)
String	getName()
int	hashCode()
boolean	isMember(Principal member)	Returns true if the passed principal is a member of the group.
Enumeration<? extends Principal>	members()	Returns an enumeration of the members in the group.
boolean	removeMember(Principal user)	Removes the specified member from the group.
String	toString()

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

GroupPrincipal

public GroupPrincipal(String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface Principal

equals

public boolean equals(Object o)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

addMember

public boolean addMember(Principal user)

Description copied from interface: Group

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)

Description copied from interface: Group

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)

Description copied from interface: Group

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<? extends Principal> members()

Description copied from interface: Group

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.