KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > de > webman > acl > resolver > Checker


1 package de.webman.acl.resolver;
2
3 import com.teamkonzept.lib.TKException;
4
5 /**
6  * Interface for access right checkers.
7  *
8  * @version 1.0
9  * @since 1.0
10  * @author © 2001 Webman AG
11  */

12 public interface Checker
13     extends Resolver
14 {
15
16     // $Header: /cvsroot/webman-cms/source/webman/de/webman/acl/resolver/Checker.java,v 1.1 2001/08/20 08:25:09 mischa Exp $
17

18     // Method signatures
19

20     /**
21      * This method is provided to check if a particular event is permitted
22      * for a login (user or group) in the current application state. The
23      * application state is determined by the context, an object type and an
24      * object reference.
25      * <P>
26      * If the optional arguments are omitted, only the context-wide
27      * access rights are checked, otherwise the context-wide as well
28      * as the object-specific access rights are checked. If no applicable
29      * access rights were found, the event is considered to be not permitted.
30      *
31      * @param event the ID if the event to be checked (<I>required</I>).
32      * @param context the ID if the current context (<I>required</I>).
33      * @param type the current object type (<I>optional</I>).
34      * @param reference the current object reference (<I>optional</I>).
35      * @return <CODE>true</CODE> if the event is permitted explicitely,
36      * otherwise <CODE>false</CODE>.
37      * @exception com.teamkonzept.lib.TKException if an error occured during
38      * access right checking.
39      */

40     boolean check (Integer JavaDoc event,
41                                    Integer JavaDoc context,
42                                    Integer JavaDoc type,
43                                    Integer JavaDoc reference)
44         throws TKException;
45
46 }
47
Popular Tags