summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/authorization
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/authorization')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/AuthzManagerProxy.java11
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/AuthzMgrPlugin.java12
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/AuthzResources.java4
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/AuthzToken.java69
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzAccessDenied.java3
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzException.java9
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzInternalError.java1
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrNotFound.java1
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrPluginNotFound.java1
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownOperation.java4
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownProtectedRes.java4
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/IAuthzManager.java70
-rw-r--r--pki/base/common/src/com/netscape/certsrv/authorization/IAuthzSubsystem.java33
13 files changed, 134 insertions, 88 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzManagerProxy.java b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzManagerProxy.java
index 0960311e..ed0df89a 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzManagerProxy.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzManagerProxy.java
@@ -17,10 +17,10 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authorization;
-
/**
- * A class represents an authorization manager. It contains an
- * authorization manager instance and its state (enable or not).
+ * A class represents an authorization manager. It contains an authorization
+ * manager instance and its state (enable or not).
+ *
* @version $Revision$, $Date$
*/
public class AuthzManagerProxy {
@@ -29,9 +29,10 @@ public class AuthzManagerProxy {
/**
* Constructor
+ *
* @param enable true if the authzMgr is enabled; false otherwise
* @param mgr authorization manager instance
- */
+ */
public AuthzManagerProxy(boolean enable, IAuthzManager mgr) {
mEnable = enable;
mMgr = mgr;
@@ -39,6 +40,7 @@ public class AuthzManagerProxy {
/**
* Returns the state of the authorization manager instance
+ *
* @return true if the state of the authorization manager instance is
* enabled; false otherwise.
*/
@@ -48,6 +50,7 @@ public class AuthzManagerProxy {
/**
* Returns an authorization manager instance.
+ *
* @return an authorization manager instance
*/
public IAuthzManager getAuthzManager() {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzMgrPlugin.java b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzMgrPlugin.java
index aebe9170..e47e5817 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzMgrPlugin.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzMgrPlugin.java
@@ -17,13 +17,10 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authorization;
-
-
-
/**
* This class represents a registered authorization manager plugin.
* <P>
- *
+ *
* @version $Revision$, $Date$
*/
public class AuthzMgrPlugin {
@@ -33,6 +30,7 @@ public class AuthzMgrPlugin {
/**
* Constructs a AuthzManager plugin.
+ *
* @param id authz manager implementation name
* @param classPath class path
*/
@@ -40,9 +38,10 @@ public class AuthzMgrPlugin {
mId = id;
mClassPath = classPath;
}
-
+
/**
* Returns an authorization manager implementation name
+ *
* @return an authorization manager implementation name
*/
public String getId() {
@@ -51,6 +50,7 @@ public class AuthzMgrPlugin {
/**
* Returns a classpath of a AuthzManager plugin
+ *
* @return a classpath of a AuthzManager plugin
*/
public String getClassPath() {
@@ -59,6 +59,7 @@ public class AuthzMgrPlugin {
/**
* Returns a visibility of the plugin
+ *
* @return a visibility of the plugin
*/
public boolean isVisible() {
@@ -67,6 +68,7 @@ public class AuthzMgrPlugin {
/**
* Sets visibility of the plugin
+ *
* @param visibility visibility of the plugin
*/
public void setVisible(boolean visibility) {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzResources.java b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzResources.java
index 7cb5240a..13d33c21 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzResources.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzResources.java
@@ -17,13 +17,12 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authorization;
-
import java.util.ListResourceBundle;
-
/**
* A class represents a resource bundle for the authorization subsystem
* <P>
+ *
* @deprecated
* @version $Revision$, $Date$
*/
@@ -31,6 +30,7 @@ public class AuthzResources extends ListResourceBundle {
/**
* Returns the content of this resource.
+ *
* @return the content of this resource
*/
public Object[][] getContents() {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzToken.java b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzToken.java
index 0b5db00a..2ef87742 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/AuthzToken.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/AuthzToken.java
@@ -17,21 +17,19 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authorization;
-
import java.util.Date;
import java.util.Enumeration;
import java.util.Hashtable;
import com.netscape.certsrv.base.IAttrSet;
-
/**
- * Authorization token returned by Authorization Managers.
- * Upon return, it contains the name of the authorization manager that create
- * the AuthzToken, the plugin name of the authorization manager, time of
- * authorization happened, name of the resource, type of operation performed
- * on the resource.
+ * Authorization token returned by Authorization Managers. Upon return, it
+ * contains the name of the authorization manager that create the AuthzToken,
+ * the plugin name of the authorization manager, time of authorization happened,
+ * name of the resource, type of operation performed on the resource.
* <p>
+ *
* @version $Revision$, $Date$
*/
public class AuthzToken implements IAttrSet {
@@ -39,19 +37,19 @@ public class AuthzToken implements IAttrSet {
private Hashtable<String, Object> mAttrs = null;
/**
- * Plugin name of the authorization manager that created the
- * AuthzToken as a string.
+ * Plugin name of the authorization manager that created the AuthzToken as a
+ * string.
*/
public static final String TOKEN_AUTHZMGR_IMPL_NAME = "authzMgrImplName";
/**
- * Name of the authorization manager that created the AuthzToken
- * as a string.
+ * Name of the authorization manager that created the AuthzToken as a
+ * string.
*/
public static final String TOKEN_AUTHZMGR_INST_NAME = "authzMgrInstName";
/**
- * Time of authorization as a java.util.Date
+ * Time of authorization as a java.util.Date
*/
public static final String TOKEN_AUTHZTIME = "authzTime";
@@ -61,7 +59,7 @@ public class AuthzToken implements IAttrSet {
public static final String TOKEN_AUTHZ_RESOURCE = "authzRes";
/**
- * name of the operation
+ * name of the operation
*/
public static final String TOKEN_AUTHZ_OPERATION = "authzOp";
@@ -69,41 +67,45 @@ public class AuthzToken implements IAttrSet {
* Status of the authorization evaluation
*/
public static final String TOKEN_AUTHZ_STATUS = "status";
-
+
/**
- * Constant for the success status of the authorization evaluation.
+ * Constant for the success status of the authorization evaluation.
*/
public static final String AUTHZ_STATUS_SUCCESS = "statusSuccess";
/**
- * Constructs an instance of a authorization token.
- * The token by default contains the following attributes: <br>
+ * Constructs an instance of a authorization token. The token by default
+ * contains the following attributes: <br>
+ *
* <pre>
- * "authzMgrInstName" - The authorization manager instance name.
- * "authzMgrImplName" - The authorization manager plugin name.
- * "authzTime" - The - The time of authorization.
+ * "authzMgrInstName" - The authorization manager instance name.
+ * "authzMgrImplName" - The authorization manager plugin name.
+ * "authzTime" - The - The time of authorization.
* </pre>
+ *
* @param authzMgr The authorization manager that created this Token.
*/
public AuthzToken(IAuthzManager authzMgr) {
mAttrs = new Hashtable<String, Object>();
- mAttrs.put(TOKEN_AUTHZMGR_INST_NAME, authzMgr.getName());
- mAttrs.put(TOKEN_AUTHZMGR_IMPL_NAME, authzMgr.getImplName());
+ mAttrs.put(TOKEN_AUTHZMGR_INST_NAME, authzMgr.getName());
+ mAttrs.put(TOKEN_AUTHZMGR_IMPL_NAME, authzMgr.getImplName());
mAttrs.put(TOKEN_AUTHZTIME, new Date());
}
/**
* Get the value of an attribute in the AuthzToken
+ *
* @param attrName The attribute name
- * @return The value of attrName if any.
+ * @return The value of attrName if any.
*/
public Object get(String attrName) {
return mAttrs.get(attrName);
}
/**
- * Used by an Authorization manager to set an attribute and value
- * in the AuthzToken.
+ * Used by an Authorization manager to set an attribute and value in the
+ * AuthzToken.
+ *
* @param attrName The name of the attribute
* @param value The value of the attribute to set.
*/
@@ -113,6 +115,7 @@ public class AuthzToken implements IAttrSet {
/**
* Removes an attribute in the AuthzToken
+ *
* @param attrName The name of the attribute to remove.
*/
public void delete(String attrName) {
@@ -121,6 +124,7 @@ public class AuthzToken implements IAttrSet {
/**
* Enumerate all attribute names in the AuthzToken.
+ *
* @return Enumeration of all attribute names in this AuthzToken.
*/
public Enumeration<String> getElements() {
@@ -129,6 +133,7 @@ public class AuthzToken implements IAttrSet {
/**
* Enumerate all attribute values in the AuthzToken.
+ *
* @return Enumeration of all attribute names in this AuthzToken.
*/
public Enumeration<Object> getVals() {
@@ -136,10 +141,11 @@ public class AuthzToken implements IAttrSet {
}
/**
- * Gets the name of the authorization manager instance that created
- * this token.
- * @return The name of the authorization manager instance that created
- * this token.
+ * Gets the name of the authorization manager instance that created this
+ * token.
+ *
+ * @return The name of the authorization manager instance that created this
+ * token.
*/
public String getAuthzManagerInstName() {
return ((String) mAttrs.get(TOKEN_AUTHZMGR_INST_NAME));
@@ -148,8 +154,9 @@ public class AuthzToken implements IAttrSet {
/**
* Gets the plugin name of the authorization manager that created this
* token.
+ *
* @return The plugin name of the authorization manager that created this
- * token.
+ * token.
*/
public String getAuthzManagerImplName() {
return ((String) mAttrs.get(TOKEN_AUTHZMGR_IMPL_NAME));
@@ -157,10 +164,10 @@ public class AuthzToken implements IAttrSet {
/**
* Gets the time of authorization.
+ *
* @return The time of authorization
*/
public Date getAuthzTime() {
return ((Date) mAttrs.get(TOKEN_AUTHZTIME));
}
}
-
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzAccessDenied.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzAccessDenied.java
index 18429c98..9fc7777c 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzAccessDenied.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzAccessDenied.java
@@ -29,9 +29,10 @@ public class EAuthzAccessDenied extends EAuthzException {
/**
* Constructs a exception for access denied by Authz manager
+ *
* @param errorString Detailed error message.
*/
public EAuthzAccessDenied(String errorString) {
- super(errorString);
+ super(errorString);
}
}
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzException.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzException.java
index 869a021c..65d95a57 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzException.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzException.java
@@ -17,12 +17,12 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authorization;
-
import com.netscape.certsrv.base.EBaseException;
/**
* This class represents authorization exceptions.
* <P>
+ *
* @version $Revision$, $Date$
*/
public class EAuthzException extends EBaseException {
@@ -39,6 +39,7 @@ public class EAuthzException extends EBaseException {
/**
* Constructs a authz exception
* <P>
+ *
* @param msgFormat exception details
*/
public EAuthzException(String msgFormat) {
@@ -46,8 +47,9 @@ public class EAuthzException extends EBaseException {
}
/**
- * Constructs a authz exception with a parameter.
+ * Constructs a authz exception with a parameter.
* <p>
+ *
* @param msgFormat exception details in message string format
* @param param message string parameter
*/
@@ -58,6 +60,7 @@ public class EAuthzException extends EBaseException {
/**
* Constructs a authz exception with a exception parameter.
* <P>
+ *
* @param msgFormat exception details in message string format
* @param param system exception
*/
@@ -68,6 +71,7 @@ public class EAuthzException extends EBaseException {
/**
* Constructs a authz exception with a list of parameters.
* <P>
+ *
* @param msgFormat the message format.
* @param params list of message format parameters
*/
@@ -77,6 +81,7 @@ public class EAuthzException extends EBaseException {
/**
* Returns the resource bundle name
+ *
* @return resource bundle name
*/
protected String getBundleName() {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzInternalError.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzInternalError.java
index ff7da13d..2afe2c74 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzInternalError.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzInternalError.java
@@ -29,6 +29,7 @@ public class EAuthzInternalError extends EAuthzException {
/**
* Constructs an authorization internal error exception
+ *
* @param errorString error with a detailed message.
*/
public EAuthzInternalError(String errorString) {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrNotFound.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrNotFound.java
index 944b9854..a920d37a 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrNotFound.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrNotFound.java
@@ -29,6 +29,7 @@ public class EAuthzMgrNotFound extends EAuthzException {
/**
* Constructs a exception for a missing required authorization manager
+ *
* @param errorString Detailed error message.
*/
public EAuthzMgrNotFound(String errorString) {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrPluginNotFound.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrPluginNotFound.java
index b44e4711..43ae6edc 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrPluginNotFound.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzMgrPluginNotFound.java
@@ -29,6 +29,7 @@ public class EAuthzMgrPluginNotFound extends EAuthzException {
/**
* Constructs a exception for a missing authorization plugin
+ *
* @param errorString Detailed error message.
*/
public EAuthzMgrPluginNotFound(String errorString) {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownOperation.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownOperation.java
index 025306cb..9bbfa0c9 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownOperation.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownOperation.java
@@ -28,7 +28,9 @@ public class EAuthzUnknownOperation extends EAuthzException {
private static final long serialVersionUID = 4344508835702220953L;
/**
- * Constructs a exception for an operation unknown to the authorization manager
+ * Constructs a exception for an operation unknown to the authorization
+ * manager
+ *
* @param errorString Detailed error message.
*/
public EAuthzUnknownOperation(String errorString) {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownProtectedRes.java b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownProtectedRes.java
index 4d7695a8..0bc5a0ba 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownProtectedRes.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/EAuthzUnknownProtectedRes.java
@@ -28,7 +28,9 @@ public class EAuthzUnknownProtectedRes extends EAuthzException {
private static final long serialVersionUID = 444663701711532889L;
/**
- * Constructs a exception for a protected resource unknown to the authorization manager
+ * Constructs a exception for a protected resource unknown to the
+ * authorization manager
+ *
* @param errorString Detailed error message.
*/
public EAuthzUnknownProtectedRes(String errorString) {
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzManager.java b/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzManager.java
index 25a66505..60c512c8 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzManager.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzManager.java
@@ -17,7 +17,6 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authorization;
-
import java.util.Enumeration;
import java.util.Hashtable;
@@ -29,12 +28,11 @@ import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.evaluators.IAccessEvaluator;
-
/**
- * Authorization Manager interface needs to be implemented by all
- * authorization managers.
+ * Authorization Manager interface needs to be implemented by all authorization
+ * managers.
* <P>
- *
+ *
* @version $Revision$, $Date$
*/
public interface IAuthzManager {
@@ -42,6 +40,7 @@ public interface IAuthzManager {
/**
* Get the name of this authorization manager instance.
* <p>
+ *
* @return String the name of this authorization manager.
*/
public String getName();
@@ -50,30 +49,34 @@ public interface IAuthzManager {
* Get implementation name of authorization manager plugin.
* <p>
* An example of an implementation name will be:
+ *
* <PRE>
* com.netscape.cms.BasicAclAuthz
* </PRE>
* <p>
+ *
* @return The name of the authorization manager plugin.
- */
+ */
public String getImplName();
/**
- * <code>accessInit</code> is for servlets who want to initialize their
- * own authorization information before full operation. It is supposed
- * to be called from the authzMgrAccessInit() method of the AuthzSubsystem.
+ * <code>accessInit</code> is for servlets who want to initialize their own
+ * authorization information before full operation. It is supposed to be
+ * called from the authzMgrAccessInit() method of the AuthzSubsystem.
* <p>
- * The accessInfo format is determined by each individual
- * authzmgr. For example, for BasicAclAuthz,
- * The accessInfo is the resACLs, whose format should conform
- * to the following:
+ * The accessInfo format is determined by each individual authzmgr. For
+ * example, for BasicAclAuthz, The accessInfo is the resACLs, whose format
+ * should conform to the following:
+ *
* <pre>
* <resource ID>:right-1[,right-n]:[allow,deny](right(s))<evaluatorType>=<value>:<comment for this resource acl
* </pre>
* <P>
- * Example:
- * resTurnKnob:left,right:allow(left) group="lefties":door knobs for lefties
- * @param accessInfo the access info string in the format specified in the authorization manager
+ * Example: resTurnKnob:left,right:allow(left) group="lefties":door knobs
+ * for lefties
+ *
+ * @param accessInfo the access info string in the format specified in the
+ * authorization manager
* @exception EBaseException error parsing the accessInfo
*/
public void accessInit(String accessInfo) throws EBaseException;
@@ -81,6 +84,7 @@ public interface IAuthzManager {
/**
* Check if the user is authorized to perform the given operation on the
* given resource.
+ *
* @param authToken the authToken associated with a user.
* @param resource - the protected resource name
* @param operation - the protected resource operation name
@@ -89,53 +93,56 @@ public interface IAuthzManager {
* @exception EAuthzAccessDenied if access denied
*/
public AuthzToken authorize(IAuthToken authToken, String resource, String operation)
- throws EAuthzInternalError, EAuthzAccessDenied;
+ throws EAuthzInternalError, EAuthzAccessDenied;
public AuthzToken authorize(IAuthToken authToken, String expression)
- throws EAuthzInternalError, EAuthzAccessDenied;
+ throws EAuthzInternalError, EAuthzAccessDenied;
/**
* Initialize this authorization manager.
+ *
* @param name The name of this authorization manager instance.
* @param implName The name of the authorization manager plugin.
* @param config The configuration store for this authorization manager.
* @exception EBaseException If an initialization error occurred.
*/
public void init(String name, String implName, IConfigStore config)
- throws EBaseException;
+ throws EBaseException;
/**
- * Prepare this authorization manager for a graceful shutdown.
- * Called when the server is exiting for any cleanup needed.
+ * Prepare this authorization manager for a graceful shutdown. Called when
+ * the server is exiting for any cleanup needed.
*/
public void shutdown();
/**
- * Get configuration parameters for this implementation.
- * The configuration parameters returned is passed to the
- * console so configuration for instances of this
- * implementation can be made through the console.
+ * Get configuration parameters for this implementation. The configuration
+ * parameters returned is passed to the console so configuration for
+ * instances of this implementation can be made through the console.
*
* @return a list of names for configuration parameters.
* @exception EBaseException If an internal error occurred
*/
public String[] getConfigParams()
- throws EBaseException;
+ throws EBaseException;
/**
* Get the configuration store for this authorization manager.
+ *
* @return The configuration store of this authorization manager.
*/
public IConfigStore getConfigStore();
/**
* Get ACL entries
+ *
* @return enumeration of ACL entries.
*/
public Enumeration<ACL> getACLs();
/**
* Get individual ACL entry for the given name of entry.
+ *
* @param target The name of the ACL entry
* @return The ACL entry.
*/
@@ -143,23 +150,26 @@ public interface IAuthzManager {
/**
* Update ACLs in the database
+ *
* @param id The name of the ACL entry (ie, resource id)
* @param rights The allowable rights for this resource
* @param strACLs The value of the ACL entry
* @param desc The description for this resource
* @exception EACLsException when update fails.
*/
- public void updateACLs(String id, String rights, String strACLs,
- String desc) throws EACLsException;
+ public void updateACLs(String id, String rights, String strACLs,
+ String desc) throws EACLsException;
/**
* Get all registered evaluators.
+ *
* @return All registered evaluators.
*/
public Enumeration<IAccessEvaluator> aclEvaluatorElements();
/**
* Register new evaluator
+ *
* @param type Type of evaluator
* @param evaluator Value of evaluator
*/
@@ -167,8 +177,8 @@ public interface IAuthzManager {
/**
* Return a table of evaluators
+ *
* @return A table of evaluators
*/
- public Hashtable<String, IAccessEvaluator> getAccessEvaluators();
+ public Hashtable<String, IAccessEvaluator> getAccessEvaluators();
}
-
diff --git a/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzSubsystem.java b/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzSubsystem.java
index 281a11a2..49c3570c 100644
--- a/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzSubsystem.java
+++ b/pki/base/common/src/com/netscape/certsrv/authorization/IAuthzSubsystem.java
@@ -27,11 +27,11 @@ import com.netscape.certsrv.base.ISubsystem;
/**
* An interface that represents an authorization component
* <P>
- *
+ *
* @version $Revision$, $Date$
*/
public interface IAuthzSubsystem extends ISubsystem {
-
+
/**
* Constant for auths.
*/
@@ -40,17 +40,17 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* Constant for class.
*/
- public static final String PROP_CLASS = "class";
+ public static final String PROP_CLASS = "class";
/**
* Constant for impl
*/
- public static final String PROP_IMPL = "impl";
+ public static final String PROP_IMPL = "impl";
/**
* Constant for pluginName.
*/
- public static final String PROP_PLUGIN = "pluginName";
+ public static final String PROP_PLUGIN = "pluginName";
/**
* Constant for instance.
@@ -60,22 +60,25 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* authorize the user associated with the given authToken for a given
* operation with the given authorization manager name
+ *
* @param authzMgrName The authorization manager name
* @param authToken the authenticaton token associated with a user
* @param resource the resource protected by the authorization system
- * @param operation the operation for resource protected by the authorization system
+ * @param operation the operation for resource protected by the
+ * authorization system
* @return a authorization token.
* @exception EBaseException If an error occurs during authorization.
*/
public AuthzToken authorize(String authzMgrName, IAuthToken authToken,
- String resource, String operation)
- throws EBaseException;
+ String resource, String operation)
+ throws EBaseException;
public AuthzToken authorize(String authzMgrName, IAuthToken authToken,
- String exp) throws EBaseException;
+ String exp) throws EBaseException;
/**
* Adds (registers) the given authorization manager.
+ *
* @param name The authorization manager name
* @param authzMgr The authorization manager instance.
*/
@@ -83,12 +86,14 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* Deletes (deregisters) the given authorization manager.
+ *
* @param name The authorization manager name to delete.
*/
public void delete(String name);
/**
* Gets the Authorization manager instance of the specified name.
+ *
* @param name The authorization manager's name.
* @return an authorization manager interface
*/
@@ -97,6 +102,7 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* Gets an enumeration of authorization managers registered to the
* authorization component.
+ *
* @return a list of authorization managers
*/
public Enumeration<IAuthzManager> getAuthzManagers();
@@ -112,12 +118,14 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* Gets an enumeration of authorization manager plugins.
+ *
* @return list of authorization manager plugins
*/
- public Enumeration<AuthzMgrPlugin> getAuthzManagerPlugins();
+ public Enumeration<AuthzMgrPlugin> getAuthzManagerPlugins();
/**
* Gets a single authorization manager plugin implementation
+ *
* @param name given authorization plugin name
* @return authorization manager plugin
*/
@@ -125,6 +133,7 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* Log error message.
+ *
* @param level log level
* @param msg error message
*/
@@ -132,21 +141,23 @@ public interface IAuthzSubsystem extends ISubsystem {
/**
* Get a hashtable containing all authentication plugins.
+ *
* @return all authentication plugins.
*/
public Hashtable<String, AuthzMgrPlugin> getPlugins();
/**
* Get a hashtable containing all authentication instances.
+ *
* @return all authentication instances.
*/
public Hashtable<String, AuthzManagerProxy> getInstances();
/**
* Get an authorization manager interface for the given name.
+ *
* @param name given authorization manager name.
* @return an authorization manager interface
*/
public IAuthzManager get(String name);
}
-