Package org.wicketstuff.security.hive

Class BasicHive

java.lang.Object

org.wicketstuff.security.hive.BasicHive

All Implemented Interfaces:

Hive

Direct Known Subclasses:

SimpleCachingHive

public class BasicHive
extends Object
implements Hive

Basic implementation of a Hive. It contains basic add methods to facilitate factories. It also might be locked after which no changes can be made to the hive.

Author:

marrink

Constructor Summary

Constructors

Constructor	Description
BasicHive()	Construct.

Method Summary

Modifier and Type	Method	Description
void	addPermission(Principal principal, Permission permission)	Adds a new permission to a principal.
void	addPrincipal(Principal principal, Collection<Permission> permissions)	Adds a new Principal to the hive.
protected Boolean	cacheLookUp(Subject subject, Permission permission)	Allows subclasses to retrieve previously cached results and thus speed up the check.
protected void	cacheResult(Subject subject, Permission permission, boolean result)	Allows subclasses to cache the result of a check and thus speed up this check the next time.
boolean	containsPermission(Permission permission)	Checks if this hive contains exactly the permission.
boolean	containsPrincipal(Principal principal)	Checks if this hive contains an exact match for this principal.
Set<Permission>	getPermissions(Principal principal)	Returns a set of Permissions, contained within the principal.
Set<Principal>	getPrincipals(Permission permission)	Returns a set of Principals, each containing this permission.
boolean	hasPermission(Subject subject, Permission permission)	Checks if the subject has the exact permission, or if the permission is implied by any of the subjects principals.
boolean	isLocked()	Check if the hive is locked.
void	lock()	Locks this hive.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHive

public BasicHive()

Construct.

Method Detail

lock

public final void lock()

Locks this hive. No changes are allowed anymore. After this isLocked() will return true;

isLocked

public final boolean isLocked()

Check if the hive is locked. If the hive is locked no changes can be made.

Returns:

true if the hive is locked, false otherwise.

addPrincipal

public final void addPrincipal(Principal principal,
                               Collection<Permission> permissions)

Adds a new Principal to the hive.

Parameters:

principal - the principal

permissions - a required collection of granted permissions for the principal

Throws:

IllegalStateException - if the hive is locked

IllegalArgumentException - if either parameter is null

addPermission

public final void addPermission(Principal principal,
                                Permission permission)

Adds a new permission to a principal.

Parameters:

principal - the principal

permission - the permission granted

Throws:

IllegalStateException - if the hive is locked

IllegalArgumentException - if either parameter is null

containsPrincipal

public final boolean containsPrincipal(Principal principal)

Description copied from interface: Hive

Checks if this hive contains an exact match for this principal.

Specified by:

containsPrincipal in interface Hive

Returns:

true if the hive contains the principal, false otherwise.

See Also:

Hive.containsPrincipal(org.wicketstuff.security.hive.authorization.Principal)

cacheLookUp

protected Boolean cacheLookUp(Subject subject,
                              Permission permission)

Allows subclasses to retrieve previously cached results and thus speed up the check. By default null is returned, meaning no cached value

Parameters:

subject - (optional) subject

permission - the permission to check

Returns:

null if there is no cached value, true if the permission is granted, false if the permission is denied

cacheResult

protected void cacheResult(Subject subject,
                           Permission permission,
                           boolean result)

Allows subclasses to cache the result of a check and thus speed up this check the next time. By default this method does not have an implementation.

Parameters:

subject - (optional) subject

permission - the permission to check

result - the result of the permission

hasPermission

public final boolean hasPermission(Subject subject,
                                   Permission permission)

Description copied from interface: Hive

Checks if the subject has the exact permission, or if the permission is implied by any of the subjects principals.

Specified by:

hasPermission in interface Hive

Parameters:

subject - the (optional) subject

permission - the permission to check.

Returns:

true if the subject has or implies the permission, false otherwise.

See Also:

Hive.hasPermission(org.wicketstuff.security.hive.authentication.Subject, org.wicketstuff.security.hive.authorization.Permission)

containsPermission

public final boolean containsPermission(Permission permission)

Description copied from interface: Hive

Checks if this hive contains exactly the permission.

Specified by:

containsPermission in interface Hive

Returns:

true if the hive contains the permission.

See Also:

Hive.containsPermission(org.wicketstuff.security.hive.authorization.Permission)

getPermissions

public final Set<Permission> getPermissions(Principal principal)

Description copied from interface: Hive

Returns a set of Permissions, contained within the principal. Implementors must not allow modifications to the set change the internal state of the hive.

Specified by:

getPermissions in interface Hive

Returns:

set, never null

See Also:

Hive.getPermissions(org.wicketstuff.security.hive.authorization.Principal)

getPrincipals

public final Set<Principal> getPrincipals(Permission permission)

Description copied from interface: Hive

Returns a set of Principals, each containing this permission. Implementors must not allow modifications to the set change the internal state of the hive.

Specified by:

getPrincipals in interface Hive

Returns:

set, never null

See Also:

Hive.getPrincipals(org.wicketstuff.security.hive.authorization.Permission)