summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/certsrv/evaluators
diff options
context:
space:
mode:
authorEndi Sukma Dewata <edewata@redhat.com>2012-03-24 02:27:47 -0500
committerEndi Sukma Dewata <edewata@redhat.com>2012-03-26 11:43:54 -0500
commit621d9e5c413e561293d7484b93882d985b3fe15f (patch)
tree638f3d75761c121d9a8fb50b52a12a6686c5ac5c /base/common/src/com/netscape/certsrv/evaluators
parent40d3643b8d91886bf210aa27f711731c81a11e49 (diff)
downloadpki-621d9e5c413e561293d7484b93882d985b3fe15f.tar.gz
pki-621d9e5c413e561293d7484b93882d985b3fe15f.tar.xz
pki-621d9e5c413e561293d7484b93882d985b3fe15f.zip
Removed unnecessary pki folder.
Previously the source code was located inside a pki folder. This folder was created during svn migration and is no longer needed. This folder has now been removed and the contents have been moved up one level. Ticket #131
Diffstat (limited to 'base/common/src/com/netscape/certsrv/evaluators')
-rw-r--r--base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java89
1 files changed, 89 insertions, 0 deletions
diff --git a/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java b/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java
new file mode 100644
index 000000000..31f8b8c2f
--- /dev/null
+++ b/base/common/src/com/netscape/certsrv/evaluators/IAccessEvaluator.java
@@ -0,0 +1,89 @@
+// --- 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();
+}