Package org.apache.fulcrum.security.model.basic

Class BasicAccessControlListImpl

java.lang.Object

org.apache.fulcrum.security.model.basic.BasicAccessControlListImpl

All Implemented Interfaces:

Serializable, AccessControlList, BasicAccessControlList

public class BasicAccessControlListImpl
extends Object
implements BasicAccessControlList

This is a control class that makes it easy to find out if a particular User has a given Permission. It also determines if a User has a a particular Role.

Version:

$Id: BasicAccessControlListImpl.java 535465 2007-05-05 06:58:06Z tv

Author:

Eric Pugh

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BasicAccessControlListImpl(GroupSet groupSet)	Constructs a new AccessControlList.

Method Summary

Modifier and Type	Method	Description
GroupSet	getGroups()	Retrieves a set of Groups an user is assigned
boolean	hasGroup(String group)	Checks if the user is assigned a specific Group
boolean	hasGroup(Group group)	Checks if the user is assigned a specific Group

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicAccessControlListImpl

public BasicAccessControlListImpl(GroupSet groupSet)

Constructs a new AccessControlList. This class follows 'immutable' pattern - it's objects can't be modified once they are created. This means that the permissions the users have are in effect form the moment they log in to the moment they log out, and changes made to the security settings in that time are not reflected in the state of this object. If you need to reset an user's permissions you need to invalidate his session.
The objects that constructs an AccessControlList must supply hashtables of role/permission sets keyed with group objects.

Parameters:

groupSet - a hashtable containing GroupSet objects

Method Detail

getGroups

public GroupSet getGroups()

Retrieves a set of Groups an user is assigned

Specified by:

getGroups in interface BasicAccessControlList

Returns:

the set of Groups

hasGroup

public boolean hasGroup(Group group)

Checks if the user is assigned a specific Group

Specified by:

hasGroup in interface BasicAccessControlList

Parameters:

group - the Group

Returns:

true if the user is assigned the Group

hasGroup

public boolean hasGroup(String group)

Checks if the user is assigned a specific Group

Specified by:

hasGroup in interface BasicAccessControlList

Parameters:

group - the Group name

Returns:

true if the user is assigned the Group