Improve documentation

git-svn-id: https://svn.argeo.org/commons/trunk@8412 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/AbstractUserDirectory.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/AbstractUserDirectory.java
index 1d2e72759b479151ddf032d8a8f9a1ac19ef5bd2..d8a3f04ff06350b9a6a73e2f266c7002b85315d3 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/AbstractUserDirectory.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/AbstractUserDirectory.java
@@ -68,7 +68,7 @@ abstract class AbstractUserDirectory implements UserAdmin, UserDirectory {
        private ThreadLocal<WorkingCopy> workingCopy = new ThreadLocal<AbstractUserDirectory.WorkingCopy>();
        private Xid editingTransactionXid = null;
 
-       public AbstractUserDirectory(Dictionary<String, ?> properties) {
+       AbstractUserDirectory(Dictionary<String, ?> properties) {
                // TODO make a copy?
                this.properties = properties;
 

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryGroup.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryGroup.java
index 9653948ac169aa8ab00788082b6b649504a80ff2..7f8046313fae7b3ba9987cf3fa940732ebe2e053 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryGroup.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryGroup.java
@@ -6,6 +6,7 @@ import javax.naming.ldap.LdapName;
 
 import org.osgi.service.useradmin.Group;
 
+/** A group in a user directroy. */
 interface DirectoryGroup extends Group, DirectoryUser {
        List<LdapName> getMemberNames();
 }

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryUser.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryUser.java
index 34988cf893cc55f99436d87111d2876b7201007a..146b8057805d122157abe15babd275869e275cd4 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryUser.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/DirectoryUser.java
@@ -5,6 +5,7 @@ import javax.naming.ldap.LdapName;
 
 import org.osgi.service.useradmin.User;
 
+/** A user in a user directory. */
 interface DirectoryUser extends User {
        LdapName getDn();
 

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdapUserAdmin.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdapUserAdmin.java
index 23a31fc87f18fc0452b78f993361bc849d7f4fc0..cce1a01c4ec35cabd1b5e268c06c6cd6d38e9776 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdapUserAdmin.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdapUserAdmin.java
@@ -18,6 +18,7 @@ import javax.naming.directory.SearchControls;
 import javax.naming.directory.SearchResult;
 import javax.naming.ldap.InitialLdapContext;
 import javax.naming.ldap.LdapName;
+import javax.transaction.TransactionManager;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -25,6 +26,10 @@ import org.argeo.ArgeoException;
 import org.osgi.framework.Filter;
 import org.osgi.service.useradmin.User;
 
+/**
+ * A user admin based on a LDAP server. Requires a {@link TransactionManager}
+ * and an open transaction for write access.
+ */
 public class LdapUserAdmin extends AbstractUserDirectory {
        private final static Log log = LogFactory.getLog(LdapUserAdmin.class);
 

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifAuthorization.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifAuthorization.java
index db549e30ec4064f274385821097f6cf2fecaec6b..e06c42e1ffb213c501ce23b2bc2edd90498b74c0 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifAuthorization.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifAuthorization.java
@@ -9,6 +9,7 @@ import org.osgi.service.useradmin.Authorization;
 import org.osgi.service.useradmin.Role;
 import org.osgi.service.useradmin.User;
 
+/** Basic authorization. */
 class LdifAuthorization implements Authorization {
        private final String name;
        private final String displayName;

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifGroup.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifGroup.java
index 1f7bf3760b46534df0e3c9239521029c20fbc8a7..bd129119b2592366a49fdba8582fa892d9795e0c 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifGroup.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifGroup.java
@@ -10,10 +10,11 @@ import javax.naming.ldap.LdapName;
 
 import org.osgi.service.useradmin.Role;
 
+/** Directory group implementation */
 class LdifGroup extends LdifUser implements DirectoryGroup {
        private final String memberAttributeId;
 
-       public LdifGroup(AbstractUserDirectory userAdmin, LdapName dn,
+       LdifGroup(AbstractUserDirectory userAdmin, LdapName dn,
                        Attributes attributes) {
                super(userAdmin, dn, attributes);
                memberAttributeId = userAdmin.getMemberAttributeId();

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifName.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifName.java
index 38f3eaca3f8c1d44a31af40d7c5bce16afc4d935..ba452ec9400136530d7ade9790904d8f34c107d0 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifName.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifName.java
@@ -15,6 +15,7 @@ public enum LdifName {
 
        public final static String PREFIX = "ldap:";
 
+       /** For use as XML name. */
        public String property() {
                return PREFIX + name();
        }

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUser.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUser.java
index d54964226103703bc6b71e1a45c11a8b5afd6481..4f0a56a6075ac7e3b6dbfb120984bc49c61b1e22 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUser.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUser.java
@@ -22,6 +22,7 @@ import org.apache.commons.codec.binary.Base64;
 import org.apache.commons.codec.digest.DigestUtils;
 import org.argeo.osgi.useradmin.AbstractUserDirectory.WorkingCopy;
 
+/** Directory user implementation */
 class LdifUser implements DirectoryUser {
        private final AbstractUserDirectory userAdmin;
 

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUserAdmin.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUserAdmin.java
index ee7128a45108e879530f880b92f8453b9a583853..a98422245d3a4b9d8c6034217a934325c68f8a03 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUserAdmin.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUserAdmin.java
@@ -18,16 +18,20 @@ import javax.naming.InvalidNameException;
 import javax.naming.NamingEnumeration;
 import javax.naming.directory.Attributes;
 import javax.naming.ldap.LdapName;
+import javax.transaction.TransactionManager;
 
 import org.apache.commons.io.IOUtils;
 import org.osgi.framework.Filter;
 import org.osgi.service.useradmin.Role;
 import org.osgi.service.useradmin.User;
 
-/** User admin implementation using LDIF file(s) as backend. */
+/**
+ * A user admin based on a LDIF files. Requires a {@link TransactionManager} and
+ * an open transaction for write access.
+ */
 public class LdifUserAdmin extends AbstractUserDirectory {
-       SortedMap<LdapName, DirectoryUser> users = new TreeMap<LdapName, DirectoryUser>();
-       SortedMap<LdapName, DirectoryGroup> groups = new TreeMap<LdapName, DirectoryGroup>();
+       private SortedMap<LdapName, DirectoryUser> users = new TreeMap<LdapName, DirectoryUser>();
+       private SortedMap<LdapName, DirectoryGroup> groups = new TreeMap<LdapName, DirectoryGroup>();
 
        private Map<String, Map<String, DirectoryUser>> userIndexes = new LinkedHashMap<String, Map<String, DirectoryUser>>();
 

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifWriter.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifWriter.java
index 001d78d8b13a97e2f86a905dac9828a1fcc67679..6dfd539956d89e233e7108ad4dfc1e1910f80e53 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifWriter.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifWriter.java
@@ -17,7 +17,7 @@ import org.apache.commons.codec.binary.Base64;
 class LdifWriter {
        private final Writer writer;
 
-       public LdifWriter(OutputStream out) {
+       LdifWriter(OutputStream out) {
                this.writer = new OutputStreamWriter(out);
        }
 

diff --git a/org.argeo.security.core/src/org/argeo/osgi/useradmin/UserAdminConf.java b/org.argeo.security.core/src/org/argeo/osgi/useradmin/UserAdminConf.java
index e7d0e0d5117862e12bce2acd6f366a96e7e02121..2ed7edd98e1dd55aba1703bf8341bce095fc96c3 100644 (file)
--- a/org.argeo.security.core/src/org/argeo/osgi/useradmin/UserAdminConf.java
+++ b/org.argeo.security.core/src/org/argeo/osgi/useradmin/UserAdminConf.java
@@ -14,6 +14,7 @@ import java.util.Map;
 
 import javax.naming.Context;
 
+/** Properties used to configure user admins. */
 public enum UserAdminConf {
        /** Base DN */
        baseDn("dc=example,dc=com"),
@@ -49,6 +50,7 @@ public enum UserAdminConf {
                return def;
        }
 
+       /** For use as Java property. */
        public String property() {
                return getPrefix() + name();
        }