From: Mathieu Baudier Date: Wed, 16 Sep 2015 11:23:34 +0000 (+0000) Subject: Improve documentation X-Git-Tag: argeo-commons-2.1.30~141 X-Git-Url: http://git.argeo.org/?a=commitdiff_plain;h=563ee18b53fa90f14dc3f443f29f6d020ffdee2b;p=lgpl%2Fargeo-commons.git 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 1d2e72759..d8a3f04ff 100644 --- 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 = new ThreadLocal(); private Xid editingTransactionXid = null; - public AbstractUserDirectory(Dictionary properties) { + AbstractUserDirectory(Dictionary 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 9653948ac..7f8046313 100644 --- 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 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 34988cf89..146b80578 100644 --- 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 23a31fc87..cce1a01c4 100644 --- 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 db549e30e..e06c42e1f 100644 --- 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 1f7bf3760..bd129119b 100644 --- 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 38f3eaca3..ba452ec94 100644 --- 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 d54964226..4f0a56a60 100644 --- 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 ee7128a45..a98422245 100644 --- 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 users = new TreeMap(); - SortedMap groups = new TreeMap(); + private SortedMap users = new TreeMap(); + private SortedMap groups = new TreeMap(); private Map> userIndexes = new LinkedHashMap>(); 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 001d78d8b..6dfd53995 100644 --- 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 e7d0e0d51..2ed7edd98 100644 --- 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(); }