null if none were found)
+ * @return the children (or null if none were found)
*/
ObjectIdentity[] findChildren(ObjectIdentity parentIdentity);
/**
* Same as {@link #readAclsById(ObjectIdentity[])} except it returns only a single Acl.This method
* should not be called as it does not leverage the underlaying implementation's potential ability to filter
- * Acl entries based on a {@link Sid} parameter.
Acls that apply for the passed Objects.The returned map is
- * keyed on the passed objects, with the values being the Acl instances. Any unknown objects will not
+ * Obtains all the Acls that apply for the passed Objects.
The returned map is + * keyed on the passed objects, with the values being the Acl instances. Any unknown objects will not * have a map key.
* - * @param objects the objects to find ACL information for + * @param objects the objects to find {@link Acl} information for * - * @return a map with zero or more elements (nevernull)
+ * @return a map with exactly one element for each {@link ObjectIdentity} passed as an argument (never null)
*
- * @throws NotFoundException DOCUMENT ME!
+ * @throws NotFoundException if an {@link Acl} was not found for each requested {@link ObjectIdentity}
*/
Map readAclsById(ObjectIdentity[] objects) throws NotFoundException;
/**
- * Obtains all the Acls that apply for the passed Objects, but only for the
+ * Obtains all the Acls that apply for the passed Objects, but only for the
* security identifies passed.Implementations MAY provide a subset of the ACLs via this method * although this is NOT a requirement. This is intended to allow performance optimisations within implementations. * Callers should therefore use this method in preference to the alternative overloaded version which does not * have performance optimisation opportunities.
- *The returned map is keyed on the passed objects, with the values being the Acl
- * instances. Any unknown objects (or objects for which the interested Sids do not have entries) will
+ *
The returned map is keyed on the passed objects, with the values being the Acl + * instances. Any unknown objects (or objects for which the interested Sids do not have entries) will * not have a map key.
* - * @param objects the objects to find ACL information for - * @param sids the security identities for which ACL information is required (may benull to denote
- * all entries)
+ * @param objects the objects to find {@link Acl} information for
+ * @param sids the security identities for which {@link Acl} information is required
+ * (may be null to denote all entries)
*
- * @return a map with zero or more elements (never null)
+ * @return a map with exactly one element for each {@link ObjectIdentity} passed as an argument (never null)
*
- * @throws NotFoundException DOCUMENT ME!
+ * @throws NotFoundException if an {@link Acl} was not found for each requested {@link ObjectIdentity}
*/
Map readAclsById(ObjectIdentity[] objects, Sid[] sids)
throws NotFoundException;
diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java b/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java
index 3b8c4b54a8..2c7a9c32ca 100644
--- a/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java
+++ b/acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java
@@ -14,6 +14,23 @@
*/
package org.springframework.security.acls.jdbc;
+import java.lang.reflect.Field;
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.sql.DataSource;
+
+import org.springframework.dao.DataAccessException;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.jdbc.core.PreparedStatementSetter;
+import org.springframework.jdbc.core.ResultSetExtractor;
import org.springframework.security.acls.AccessControlEntry;
import org.springframework.security.acls.Acl;
import org.springframework.security.acls.MutableAcl;
@@ -30,32 +47,9 @@ import org.springframework.security.acls.objectidentity.ObjectIdentityImpl;
import org.springframework.security.acls.sid.GrantedAuthoritySid;
import org.springframework.security.acls.sid.PrincipalSid;
import org.springframework.security.acls.sid.Sid;
-
import org.springframework.security.util.FieldUtils;
-
-import org.springframework.dao.DataAccessException;
-
-import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.jdbc.core.PreparedStatementSetter;
-import org.springframework.jdbc.core.ResultSetExtractor;
-
import org.springframework.util.Assert;
-import java.lang.reflect.Field;
-
-import java.sql.PreparedStatement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import javax.sql.DataSource;
-
/**
* Performs lookups in a manner that is compatible with ANSI SQL.NB: This implementation does attempt to provide @@ -346,22 +340,21 @@ public final class BasicLookupStrategy implements LookupStrategy { } /** - * The main method.
WARNING: This implementation completely disregards the "sids" parameter! Every item + * The main method.
WARNING: This implementation completely disregards the "sids" argument! Every item * in the cache is expected to contain all SIDs. If you have serious performance needs (eg a very large number of * SIDs per object identity), you'll probably want to develop a custom {@link LookupStrategy} implementation * instead.
*The implementation works in batch sizes specfied by {@link #batchSize}.
* - * @param objects DOCUMENT ME! - * @param sids DOCUMENT ME! + * @param objects the identities to lookup (required) + * @param sids the SIDs for which identities are required (ignored by this implementation) * - * @return DOCUMENT ME! - * - * @throws NotFoundException DOCUMENT ME! - * @throws IllegalStateException DOCUMENT ME! + * @return a Map where keys represent the {@link ObjectIdentity} of the located {@link Acl} and values + * are the located {@link Acl} (never null although some entries may be missing; this method + * should not throw {@link NotFoundException}, as a chain of {@link LookupStrategy}s may be used + * to automatically create entries if required) */ - public Map readAclsById(ObjectIdentity[] objects, Sid[] sids) - throws NotFoundException { + public Map readAclsById(ObjectIdentity[] objects, Sid[] sids) { Assert.isTrue(batchSize >= 1, "BatchSize must be >= 1"); Assert.notEmpty(objects, "Objects to lookup required"); @@ -416,14 +409,6 @@ public final class BasicLookupStrategy implements LookupStrategy { } } - // Now we're done, check every requested object identity was found (throw NotFoundException if needed) - for (int i = 0; i < objects.length; i++) { - if (!result.containsKey(objects[i])) { - throw new NotFoundException("Unable to find ACL information for object identity '" - + objects[i].toString() + "'"); - } - } - return result; } diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcAclService.java b/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcAclService.java index 3b9b60321f..f42cd6098a 100644 --- a/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcAclService.java +++ b/acl/src/main/java/org/springframework/security/acls/jdbc/JdbcAclService.java @@ -28,6 +28,7 @@ import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.jdbc.core.RowMapper; import org.springframework.util.Assert; +import org.springframework.util.StringUtils; import java.sql.ResultSet; import java.sql.SQLException; @@ -96,10 +97,7 @@ public class JdbcAclService implements AclService { public Acl readAclById(ObjectIdentity object, Sid[] sids) throws NotFoundException { Map map = readAclsById(new ObjectIdentity[] {object}, sids); - - if (map.size() == 0) { - throw new NotFoundException("Could not find ACL"); - } + Assert.isTrue(map.containsKey(object), "There should have been an Acl entry for ObjectIdentity " + object); return (Acl) map.get(object); } @@ -108,11 +106,21 @@ public class JdbcAclService implements AclService { return readAclById(object, null); } - public Map readAclsById(ObjectIdentity[] objects) { + public Map readAclsById(ObjectIdentity[] objects) throws NotFoundException { return readAclsById(objects, null); } public Map readAclsById(ObjectIdentity[] objects, Sid[] sids) throws NotFoundException { - return lookupStrategy.readAclsById(objects, sids); + Map result = lookupStrategy.readAclsById(objects, sids); + + // Check every requested object identity was found (throw NotFoundException if needed) + for (int i = 0; i < objects.length; i++) { + if (!result.containsKey(objects[i])) { + throw new NotFoundException("Unable to find ACL information for object identity '" + + objects[i].toString() + "'"); + } + } + + return result; } } diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/LookupStrategy.java b/acl/src/main/java/org/springframework/security/acls/jdbc/LookupStrategy.java index 1ea5b6bcfd..9d5fb8d150 100644 --- a/acl/src/main/java/org/springframework/security/acls/jdbc/LookupStrategy.java +++ b/acl/src/main/java/org/springframework/security/acls/jdbc/LookupStrategy.java @@ -14,6 +14,7 @@ */ package org.springframework.security.acls.jdbc; +import org.springframework.security.acls.NotFoundException; import org.springframework.security.acls.objectidentity.ObjectIdentity; import org.springframework.security.acls.sid.Sid; @@ -22,7 +23,7 @@ import java.util.Map; /** * Performs lookups for {@link org.springframework.security.acls.AclService}. - * + * * @author Ben Alex * @version $Id$ */ @@ -33,11 +34,13 @@ public interface LookupStrategy { * Perform database-specific optimized lookup. * * @param objects the identities to lookup (required) - * @param sids the SIDs for which identities are required (may benull - implementations may elect not
+ * @param sids the SIDs for which identities are required (may be null - implementations may elect not
* to provide SID optimisations)
*
- * @return the Map pursuant to the interface contract for {@link
- * org.springframework.security.acls.AclService#readAclsById(ObjectIdentity[], Sid[])}
+ * @return a Map where keys represent the {@link ObjectIdentity} of the located {@link Acl} and values
+ * are the located {@link Acl} (never null although some entries may be missing; this method
+ * should not throw {@link NotFoundException}, as a chain of {@link LookupStrategy}s may be used
+ * to automatically create entries if required)
*/
Map readAclsById(ObjectIdentity[] objects, Sid[] sids);
}