com.groiss.accesscontrol

Class PermissionMapping

java.lang.Object

com.groiss.accesscontrol.PermissionMapping

public abstract class PermissionMapping
extends Object

Overwrite behaviour of Permission-check for classes.

Constructor Summary

Constructors

Constructor and Description
PermissionMapping()

Method Summary

Modifier and Type	Method and Description
boolean	canCacheResult(User user, Right right, Object target) check, if the permission-result should be cached to avoid repeated expensive calculations
abstract Class<?>[]	forClasses() Define the classes where this mapping applies to.
PermissionMapping	getParentMapping() Deprecated. use parentRewrite(PermissionQuery). this method is inherently broken, in case of heterogenous list of persistents need to be checked. in that case, the parent mapping for the first object in the list will be used.
void	init(Agent agent, Right right, List<? extends Persistent> wanted) The init method allows to read and cache some data.
DNF	parentRewrite(PermissionQuery query) passes the current permission-query to the next PermissionMapping implementation in the registration-hierarchy.
abstract DNF	rewrite(PermissionQuery q) The rewrite method defines the modified permission query as DNF object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionMapping

public PermissionMapping()

Method Detail

getParentMapping

@Deprecated
public final PermissionMapping getParentMapping()

Deprecated. use parentRewrite(PermissionQuery). this method is inherently broken, in case of heterogenous list of persistents need to be checked. in that case, the parent mapping for the first object in the list will be used.

Return the parent permission mapping, this is the mapping that would be used if the current mapping had not been added to the rules. If no mapping is defined, the NULL_MAPPER is returned. Its rewrite method returns always null.

Returns:

a permission mapper

parentRewrite

public final DNF parentRewrite(PermissionQuery query)

passes the current permission-query to the next PermissionMapping implementation in the registration-hierarchy. simmilar to calling super.rewrite() but since usually no explicit (type)hierarchy is available at implementation time, the runtime-hiearchy needs to be used.

Parameters:

query - the query

Returns:

the result

forClasses

public abstract Class<?>[] forClasses()

Define the classes where this mapping applies to.

init

public void init(Agent agent,
                 Right right,
                 List<? extends Persistent> wanted)

The init method allows to read and cache some data.

rewrite

public abstract DNF rewrite(PermissionQuery q)

The rewrite method defines the modified permission query as DNF object. Your implementation may return null in cases where the default behaviour shall not be changed.

Parameters:

q - the permission query

Returns:

null or a DNF object

canCacheResult

public boolean canCacheResult(User user,
                              Right right,
                              Object target)

check, if the permission-result should be cached to avoid repeated expensive calculations

Parameters:

user - the user

right - the checked right

target - the target

Returns:

true do cache the result, false do not cache the result. default: true