summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java46
1 files changed, 24 insertions, 22 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java b/pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java
index 8c291447..9019410a 100644
--- a/pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java
+++ b/pki/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java
@@ -17,16 +17,14 @@
// --- 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.
+ * 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$
@@ -39,47 +37,51 @@ public interface IAccessEvaluator {
public void init();
/**
- * Gets the type of the evaluator. Type is defined by each
- * evaluator plugin. Each evaluator plugin should have a unique type.
+ * 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.
+ * 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.
+ * @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.
+ * 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.
+ * @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);
+ 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();