Update of /var/cvs/src/org/mmbase/security
In directory james.mmbase.org:/tmp/cvs-serv17652/src/org/mmbase/security
Modified Files:
Authentication.java Operation.java ActionChecker.java
Configurable.java AuthenticationData.java package.html
ActionRepository.java
Log Message:
Fixes un javadoc
See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/security
Index: Authentication.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/Authentication.java,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -b -r1.41 -r1.42
--- Authentication.java 21 Jan 2008 15:25:28 -0000 1.41
+++ Authentication.java 25 Mar 2008 21:00:24 -0000 1.42
@@ -24,7 +24,7 @@
*
* @author Eduard Witteveen
* @author Michiel Meeuwissen (javadocs)
- * @version $Id: Authentication.java,v 1.41 2008/01/21 15:25:28 michiel Exp $
+ * @version $Id: Authentication.java,v 1.42 2008/03/25 21:00:24 nklasens Exp $
*/
public abstract class Authentication extends Configurable implements
AuthenticationData {
private static final Logger log =
Logging.getLoggerInstance(Authentication.class);
@@ -63,7 +63,7 @@
*
* @return <code>null</code> if no valid credentials were supplied, a
(perhaps new) UserContext if login succeeded.
*
- * @exception SecurityException When something strange happened, or
authentication was unsucessfull.
+ * @exception SecurityException When something strange happened, or
authentication was unsuccessful.
*/
public abstract UserContext login(String application, Map<String, Object>
loginInfo, Object[] parameters) throws SecurityException;
@@ -193,11 +193,11 @@
long key = System.currentTimeMillis();
/**
- *<p> Some unique key associated with this security configuration. It can
be explicitely set with
+ *<p> Some unique key associated with this security configuration. It can
be explicitly set with
* the 'key' entry in security.xml. It falls back to the current time in
milliseconds at the time of
* initialization of authentication.</p>
*
- * <p>The advantage of explicitely configuring it, is that serialized
user-contextes remain valid
+ * <p>The advantage of explicitly configuring it, is that serialized
user-contextes remain valid
* after a restart of MMBase, and users need not to log in again then.</p>
*
* @since MMBase-1.8
Index: Operation.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/Operation.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- Operation.java 6 Dec 2007 08:08:13 -0000 1.13
+++ Operation.java 25 Mar 2008 21:00:24 -0000 1.14
@@ -13,7 +13,7 @@
* This class is a kind of enumeration (introduced before java 1.5
enumerations) of the operations
* possible within the security authorization.
* @author Eduard Witteveen
- * @version $Id: Operation.java,v 1.13 2007/12/06 08:08:13 michiel Exp $
+ * @version $Id: Operation.java,v 1.14 2008/03/25 21:00:24 nklasens Exp $
* @see Authorization
*/
public final class Operation {
@@ -51,7 +51,7 @@
public final static Operation READ = new Operation(READ_INT, "read");
/**
- * [EMAIL PROTECTED] Node#setValue} is an example of a write-operation.
+ * [EMAIL PROTECTED] org.mmbase.bridge.Node#setValue(String, Object)} is
an example of a write-operation.
*/
public final static Operation WRITE = new Operation(WRITE_INT, "write");
@@ -77,15 +77,10 @@
*/
public final static Operation CHANGE_CONTEXT = new
Operation(CHANGE_CONTEXT_INT, "change context");
-
- /**
- * Identifier for change context operation, which is used when changing
the context of a node
- * @deprecated Use CHANGE_CONTEXT
- */
- public final static Operation CHANGECONTEXT = CHANGE_CONTEXT;
-
/**
* Private constructor, to prevent creation of new Operations
+ * @param level operation identifier
+ * @param description operation description
*/
private Operation(int level, String description) {
this.level = level;
@@ -118,7 +113,10 @@
*/
private final String description;
- /** retrieve a Operation by a given string */
+ /** retrieve a Operation by a given string
+ * @param operationString the [EMAIL PROTECTED] Operation#toString()}
+ * @return Operation
+ */
public static Operation getOperation(String operationString) {
if(READ.toString().equals(operationString)) return READ;
if(WRITE.toString().equals(operationString)) return WRITE;
Index: ActionChecker.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/ActionChecker.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- ActionChecker.java 3 Feb 2008 17:33:57 -0000 1.5
+++ ActionChecker.java 25 Mar 2008 21:00:24 -0000 1.6
@@ -13,10 +13,10 @@
/**
* A piece of 'action check' functionality. Provided by actions themselves,
but security
* implementations can perhaps also use this interface to administer their
implementation of [EMAIL PROTECTED]
- * Authorization#check(UserContext, Action)}.
+ * Authorization#check(UserContext, Action, Parameters)}.
*
* @author Michiel Meeuwissen
- * @version $Id: ActionChecker.java,v 1.5 2008/02/03 17:33:57 nklasens Exp $
+ * @version $Id: ActionChecker.java,v 1.6 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public interface ActionChecker extends java.io.Serializable {
Index: Configurable.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/Configurable.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- Configurable.java 25 Jul 2007 06:47:11 -0000 1.13
+++ Configurable.java 25 Mar 2008 21:00:24 -0000 1.14
@@ -20,7 +20,7 @@
*
* @author Eduard Witteveen
* @author Michiel Meeuwissen
- * @version $Id: Configurable.java,v 1.13 2007/07/25 06:47:11 michiel Exp $
+ * @version $Id: Configurable.java,v 1.14 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.7
*/
public abstract class Configurable {
@@ -33,7 +33,7 @@
/**
* This specific security configuration file. The file is absolute. Might
be
- * null if the implementation does not have its own configuruation file.
+ * null if the implementation does not have its own configuration file.
* @since MMBase-1.8
*/
protected String configResource; // relative to securityLoader
@@ -47,13 +47,13 @@
/**
- * The method which initialized an instance of this class. This method
cannot be be overrided.
+ * The method which initialized an instance of this class. This method
cannot be overridden.
* This methods sets the member variables of this object and then
* calls the method load();
* @param manager The class that created this instance.
* @param configWatcher checks the files for changes
* @param configPath The url which contains the config information for the
authorization (e.g. context/config.xml). Or null (if configured to be "")
- * @see #load
+ * @see #load()
*/
public final void load(MMBaseCop manager, ResourceWatcher configWatcher,
String configPath) {
if (log.isDebugEnabled()) {
@@ -79,7 +79,7 @@
}
/**
- * This method should be overrided by an extending class. It should
further initialize the
+ * This method should be overridden by an extending class. It should
further initialize the
* class. It can optionally retrieve settings from the general security
configuration file
* (available as the 'configResource' member). Security implementations
with complicated
* configuration would typically retrieve a path to their own
configuration file only.
Index: AuthenticationData.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/AuthenticationData.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- AuthenticationData.java 18 Jun 2007 09:01:14 -0000 1.9
+++ AuthenticationData.java 25 Mar 2008 21:00:24 -0000 1.10
@@ -12,10 +12,10 @@
import org.mmbase.bridge.Node;
/**
- * This interface represents information about the authentication
implemtentation.
+ * This interface represents information about the authentication
implementation.
*
* @author Michiel Meeuwissen
- * @version $Id: AuthenticationData.java,v 1.9 2007/06/18 09:01:14 michiel Exp
$
+ * @version $Id: AuthenticationData.java,v 1.10 2008/03/25 21:00:24 nklasens
Exp $
* @since MMBase-1.8
*/
public interface AuthenticationData {
@@ -37,7 +37,7 @@
*/
static final int METHOD_DELEGATE = 1;
/**
- * Logon with given credentials (only Strings), and don't store this any
where (except for the current 'page').
+ * Login with given credentials (only Strings), and don't store this any
where (except for the current 'page').
*/
static final int METHOD_PAGELOGON = 2;
@@ -63,7 +63,7 @@
*/
static final int METHOD_LOGINPAGE = 103;
/**
- * Delegates authentication comletely to the authentication implementation
[EMAIL PROTECTED]
+ * Delegates authentication completely to the authentication
implementation [EMAIL PROTECTED]
* #METHOD_DELEGATE}, but stores the authenticated in the session then. A
second request with
* this method will simply use the session.
*/
@@ -87,7 +87,7 @@
static final String STRINGS =
"org.mmbase.security.resources.parameters";
/**
- * Common parameters for logon-info.
+ * Common parameters for login-info.
*/
static final Parameter<String> PARAMETER_USERNAME = new
Parameter<String>("username", String.class, true);
static final Parameter<String> PARAMETER_PASSWORD = new
Parameter<String>("password", String.class, true);
@@ -103,7 +103,7 @@
/**
- * The method returns wether the UserContext has become invalid for some
reason (change in security config?)
+ * The method returns whether the UserContext has become invalid for some
reason (change in security config?)
* @param userContext The UserContext of which we want to know the rights
* @return <code>true</code> when valid, otherwise <code>false</code>
* @exception SecurityException When something strange happened
@@ -118,7 +118,7 @@
/**
* This method returns the builder name of the nodes that will be returned
by the
- * [EMAIL PROTECTED] #getNode()} call.
+ * [EMAIL PROTECTED] #getNode(UserContext)} call.
* @since MMBase-1.9
*/
String getUserBuilder();
@@ -154,8 +154,8 @@
int getDefaultMethod(String protocol);
/**
- * <p>Gives all availabe authentication types. The first one can be used
as the default. Typically,
- * an implemention should at least support 'anonynmous' and 'class'.</p>
+ * <p>Gives all available authentication types. The first one can be used
as the default. Typically,
+ * an implementation should at least support 'anonynmous' and 'class'.</p>
* <p>
* Since most of the time we are using HTTP any way, types for the method
[EMAIL PROTECTED] #METHOD_HTTP}
* ('name/password' based) and method [EMAIL PROTECTED] #METHOD_LOGINPAGE}
([EMAIL PROTECTED] #createParameters} can
@@ -177,7 +177,7 @@
* For a given authentication type returns a parameters object to fill
with credentials. [EMAIL PROTECTED] Parameters#toMap} can be used as the second
argument
* for [EMAIL PROTECTED] org.mmbase.security.Authentication#login}
* Given a certain 'application' this will return a [EMAIL PROTECTED]
org.mmbase.util.functions.Parameters}
- * which tells you excactly which parameters you can and must supply to
[EMAIL PROTECTED] #login}.
+ * which tells you exactly which parameters you can and must supply to
[EMAIL PROTECTED] Authentication#login(String, java.util.Map, Object[])}.
*/
Parameters createParameters(String application);
}
Index: package.html
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/package.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- package.html 10 Dec 2005 14:21:15 -0000 1.4
+++ package.html 25 Mar 2008 21:00:24 -0000 1.5
@@ -33,11 +33,11 @@
more..?
</li>
</ul>
- <!-- version of package description $Id: package.html,v 1.4 2005/12/10
14:21:15 michiel Exp $ -->
+ <!-- version of package description $Id: package.html,v 1.5 2008/03/25
21:00:24 nklasens Exp $ -->
@since MMBase-1.4
@see org.mmbase.bridge.Cloud
- @see org.mmbase.security.implementation.context.ContextAuthentication
- @see org.mmbase.security.implementation.basic.AuthenticationHandler
- @see org.mmbase.security.implementation.cloud.Authenticate
+ See org.mmbase.security.implementation.context.ContextAuthentication
+ See org.mmbase.security.implementation.basic.AuthenticationHandler
+ See org.mmbase.security.implementation.cloud.Authenticate
</body>
</html>
Index: ActionRepository.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/security/ActionRepository.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- ActionRepository.java 21 Jan 2008 17:28:15 -0000 1.7
+++ ActionRepository.java 25 Mar 2008 21:00:24 -0000 1.8
@@ -12,11 +12,11 @@
/**
* The defined 'actions' are maintained by the 'action' repository. The
security implementation can
- * decide how to persistify actions and how to connect rights to it.
+ * decide how to persist actions and how to connect rights to it.
*
- * @see [EMAIL PROTECTED] Action}.
+ * @see Action
* @author Michiel Meeuwissen
- * @version $Id: ActionRepository.java,v 1.7 2008/01/21 17:28:15 michiel Exp $
+ * @version $Id: ActionRepository.java,v 1.8 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public abstract class ActionRepository extends Configurable {
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
