1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.evaluators;
import com.netscape.certsrv.authentication.IAuthToken;
/**
* A class represents an evaluator. An evaluator is used to evaluate an
* expression. For example, one can write an evaluator to evaluate if a user
* belongs to a certain group. An evaluator is generally used for access control
* expression evaluation, however, it can be used for other evaluation-related
* operations.
* <P>
*
* @version $Revision$, $Date$
*/
public interface IAccessEvaluator {
/**
* Initialize the evaluator
*/
public void init();
/**
* Gets the type of the evaluator. Type is defined by each evaluator plugin.
* Each evaluator plugin should have a unique type.
*
* @return type of the evaluator
*/
public String getType();
/**
* Gets the description of the evaluator
*
* @return a text description for this evaluator
*/
public String getDescription();
/**
* Evaluates if the given value satisfies the access control in current
* context.
*
* @param type Type of the evaluator, eg, user, group etc
* @param op Operator of the evaluator, eg, =, !=
* @param value Part of the expression that can be used to evaluate, e.g,
* value can be the name of the group if the purpose of the
* evaluator is to evaluate if the user is a member of the group.
* @return true if the evaluation expression is matched; false otherwise.
*/
public boolean evaluate(String type, String op, String value);
/**
* Evaluates if the given value satisfies the access control in authToken
* obtained from Authentication.
*
* @param authToken Authentication token
* @param type Type of the evaluator, eg, user, group etc
* @param op Operator of the evaluator, eg, =, !=
* @param value Part of the expression that can be used to evaluate, e.g,
* value can be the name of the group if the purpose of the
* evaluator is to evaluate if the user is a member of the group.
* @return true if the evaluation expression is matched; false otherwise.
*/
public boolean evaluate(IAuthToken authToken, String type, String op,
String value);
/**
* Get the supported operators for this evaluator
*
* @return Supported operators in string array
*/
public String[] getSupportedOperators();
}
|
