You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2004/08/16 18:21:25 UTC
cvs commit: cocoon-lenya/src/java/org/apache/lenya/ac PolicyManager.java GroupManager.java Password.java Group.java AccessController.java ItemManager.java Groupable.java Policy.java World.java RoleManager.java AccreditableManager.java Authenticator.java User.java Role.java Machine.java UserManager.java AccessControlException.java Authorizer.java
andreas 2004/08/16 09:21:25
Modified: src/java/org/apache/lenya/ac PolicyManager.java
GroupManager.java Password.java Group.java
AccessController.java ItemManager.java
Groupable.java Policy.java World.java
RoleManager.java AccreditableManager.java
Authenticator.java User.java Role.java Machine.java
UserManager.java AccessControlException.java
Authorizer.java
Log:
fixed javadocs
Revision Changes Path
1.4 +7 -2 cocoon-lenya/src/java/org/apache/lenya/ac/PolicyManager.java
Index: PolicyManager.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/PolicyManager.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PolicyManager.java 28 Apr 2004 12:47:00 -0000 1.3
+++ PolicyManager.java 16 Aug 2004 16:21:21 -0000 1.4
@@ -15,14 +15,19 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import org.apache.avalon.framework.component.Component;
+/**
+ * A policy manager.
+ * @version $Id$
+ */
public interface PolicyManager extends Component {
+ /**
+ * The Avalon role.
+ */
String ROLE = PolicyManager.class.getName();
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/GroupManager.java
Index: GroupManager.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/GroupManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- GroupManager.java 3 Mar 2004 12:56:31 -0000 1.2
+++ GroupManager.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * A group manager.
+ * @version $Id$
+ */
public interface GroupManager extends ItemManager {
/**
1.4 +7 -5 cocoon-lenya/src/java/org/apache/lenya/ac/Password.java
Index: Password.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Password.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Password.java 3 Mar 2004 12:56:31 -0000 1.3
+++ Password.java 16 Aug 2004 16:21:22 -0000 1.4
@@ -53,16 +53,16 @@
* Encrypt plain text password
*
* @param plain plain text password
- *
* @return encrypted password
- *
*/
public static String encrypt(String plain) {
return getMD5(plain);
}
/**
- *
+ * Returns the MD5 representation of a string.
+ * @param plain The plain string.
+ * @return A string.
*/
public static String getMD5(String plain) {
MessageDigest md = null;
@@ -75,7 +75,9 @@
}
/**
- *
+ * Converts a byte buffer to a string.
+ * @param buf The buffer.
+ * @return A string.
*/
private static String stringify(byte[] buf) {
StringBuffer sb = new StringBuffer(2 * buf.length);
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/Group.java
Index: Group.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Group.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Group.java 3 Mar 2004 12:56:31 -0000 1.2
+++ Group.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * A group.
+ * @version $Id$
+ */
public interface Group extends Identifiable, Item {
/**
1.3 +1 -2 cocoon-lenya/src/java/org/apache/lenya/ac/AccessController.java
Index: AccessController.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/AccessController.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AccessController.java 3 Mar 2004 12:56:31 -0000 1.2
+++ AccessController.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,8 +15,6 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import org.apache.avalon.framework.component.Component;
@@ -24,6 +22,7 @@
/**
* An access controller allows authenticating and authorizing identities.
+ * @version $Id$
*/
public interface AccessController extends Component {
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/ItemManager.java
Index: ItemManager.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/ItemManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ItemManager.java 3 Mar 2004 12:56:31 -0000 1.2
+++ ItemManager.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * Item manager.
+ * @version $Id$
+ */
public interface ItemManager {
/**
1.4 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/Groupable.java
Index: Groupable.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Groupable.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Groupable.java 28 Apr 2004 12:47:23 -0000 1.3
+++ Groupable.java 16 Aug 2004 16:21:22 -0000 1.4
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * Generalized interface of group member objects.
+ * @version $Id$
+ */
public interface Groupable {
/**
1.3 +6 -2 cocoon-lenya/src/java/org/apache/lenya/ac/Policy.java
Index: Policy.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Policy.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Policy.java 3 Mar 2004 12:56:31 -0000 1.2
+++ Policy.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,14 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * A policy assigns roles to accreditables using credentials.
+ * Additionally, SSL protection is defined.
+ *
+ * @version $Id$
+ */
public interface Policy {
/**
* Returns all roles of a certain identity.
1.4 +5 -2 cocoon-lenya/src/java/org/apache/lenya/ac/World.java
Index: World.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/World.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- World.java 8 Mar 2004 16:48:21 -0000 1.3
+++ World.java 16 Aug 2004 16:21:22 -0000 1.4
@@ -15,13 +15,16 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import java.util.Collections;
+/**
+ * The world.
+ * @version $Id$
+ */
public final class World implements Identifiable {
+
/**
* Creates a new World object.
*/
1.3 +5 -1 cocoon-lenya/src/java/org/apache/lenya/ac/RoleManager.java
Index: RoleManager.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/RoleManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RoleManager.java 3 Mar 2004 12:56:31 -0000 1.2
+++ RoleManager.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -19,6 +19,10 @@
package org.apache.lenya.ac;
+/**
+ * Role manager.
+ * @version $Id$
+ */
public interface RoleManager extends ItemManager {
/**
1.3 +13 -7 cocoon-lenya/src/java/org/apache/lenya/ac/AccreditableManager.java
Index: AccreditableManager.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/AccreditableManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AccreditableManager.java 3 Mar 2004 12:56:31 -0000 1.2
+++ AccreditableManager.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,16 +15,22 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import org.apache.avalon.framework.component.Component;
+/**
+ * An AccreditableManager combines a UserManager, a GroupManager, an IPRangeManager and a
+ * RoleManager.
+ * @verison $Id$
+ */
public interface AccreditableManager extends Component {
-
+
+ /**
+ * Avalon role.
+ */
String ROLE = AccreditableManager.class.getName();
-
+
/**
* Returns the user manager of this access controller.
* @return A user manager.
@@ -58,11 +64,11 @@
* @param listener An item manager listener.
*/
void addItemManagerListener(ItemManagerListener listener);
-
+
/**
* Removes an item manager listener from this accreditable manager.
* @param listener An item manager listener.
*/
void removeItemManagerListener(ItemManagerListener listener);
-
-}
+
+}
\ No newline at end of file
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/Authenticator.java
Index: Authenticator.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Authenticator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Authenticator.java 3 Mar 2004 12:56:31 -0000 1.2
+++ Authenticator.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,8 +15,6 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import org.apache.avalon.framework.component.Component;
@@ -24,9 +22,13 @@
/**
* An authenticator.
+ * @version $Id$
*/
public interface Authenticator extends Component {
+ /**
+ * Avalon role.
+ */
String ROLE = Authenticator.class.getName();
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/User.java
Index: User.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/User.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- User.java 3 Mar 2004 12:56:31 -0000 1.2
+++ User.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * A user.
+ * @version $Id$
+ */
public interface User extends Identifiable, Item, Groupable {
/**
1.3 +5 -1 cocoon-lenya/src/java/org/apache/lenya/ac/Role.java
Index: Role.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Role.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Role.java 3 Mar 2004 12:56:31 -0000 1.2
+++ Role.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -19,5 +19,9 @@
package org.apache.lenya.ac;
+/**
+ * The role interface.
+ * @version $Id$
+ */
public interface Role extends Item {
}
1.5 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/Machine.java
Index: Machine.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Machine.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Machine.java 28 Jun 2004 08:52:33 -0000 1.4
+++ Machine.java 16 Aug 2004 16:21:22 -0000 1.5
@@ -15,8 +15,6 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import java.net.InetAddress;
@@ -24,6 +22,10 @@
import java.util.ArrayList;
import java.util.List;
+/**
+ * A machine (representing an IP address).
+ * @version $Id$
+ */
public class Machine implements Identifiable {
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/UserManager.java
Index: UserManager.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/UserManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- UserManager.java 3 Mar 2004 12:56:31 -0000 1.2
+++ UserManager.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * User manager.
+ * @version $Id$
+ */
public interface UserManager extends ItemManager {
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/AccessControlException.java
Index: AccessControlException.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/AccessControlException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AccessControlException.java 3 Mar 2004 12:56:31 -0000 1.2
+++ AccessControlException.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
+/**
+ * Access control exception.
+ * @version $Id$
+ */
public class AccessControlException extends Exception {
/**
* Create an AccessControlException
1.3 +7 -2 cocoon-lenya/src/java/org/apache/lenya/ac/Authorizer.java
Index: Authorizer.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/Authorizer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Authorizer.java 3 Mar 2004 12:56:31 -0000 1.2
+++ Authorizer.java 16 Aug 2004 16:21:22 -0000 1.3
@@ -15,15 +15,20 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac;
import org.apache.avalon.framework.component.Component;
import org.apache.cocoon.environment.Request;
+/**
+ * An Authorizer checks if an Identity is authorized to invoke a certain request.
+ * @version $Id$
+ */
public interface Authorizer extends Component {
+ /**
+ * The Avalon role.
+ */
String ROLE = Authorizer.class.getName();
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: lenya-cvs-unsubscribe@cocoon.apache.org
For additional commands, e-mail: lenya-cvs-help@cocoon.apache.org