public class

JdbcAclService

extends Object
implements AclService
java.lang.Object
   ↳ org.springframework.security.acls.jdbc.JdbcAclService
Known Direct Subclasses

Class Overview

Simple JDBC-based implementation of AclService.

Requires the "dirty" flags in AclImpl and AccessControlEntryImpl to be set, so that the implementation can detect changed parameters easily.

Summary

Fields
protected final JdbcTemplate jdbcTemplate
protected static final Log log
Public Constructors
JdbcAclService(DataSource dataSource, LookupStrategy lookupStrategy)
Public Methods
List<ObjectIdentity> findChildren(ObjectIdentity parentIdentity)
Locates all object identities that use the specified parent.
Acl readAclById(ObjectIdentity object)
Same as readAclsById(List) except it returns only a single Acl.
Acl readAclById(ObjectIdentity object, List<Sid> sids)
Same as readAclsById(List, List) except it returns only a single Acl.
Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects)
Obtains all the Acls that apply for the passed Objects.
Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects, List<Sid> sids)
Obtains all the Acls that apply for the passed Objects, but only for the security identifies passed.
void setFindChildrenQuery(String findChildrenSql)
Allows customization of the SQL query used to find child object identities.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.security.acls.model.AclService

Fields

protected final JdbcTemplate jdbcTemplate

protected static final Log log

Public Constructors

public JdbcAclService (DataSource dataSource, LookupStrategy lookupStrategy)

Public Methods

public List<ObjectIdentity> findChildren (ObjectIdentity parentIdentity)

Locates all object identities that use the specified parent. This is useful for administration tools.

Parameters
parentIdentity to locate children of
Returns
  • the children (or null if none were found)

public Acl readAclById (ObjectIdentity object)

Same as readAclsById(List) except it returns only a single Acl.

This method should not be called as it does not leverage the underlying implementation's potential ability to filter Acl entries based on a Sid parameter.

Parameters
object to locate an Acl for
Returns
Throws
NotFoundException

public Acl readAclById (ObjectIdentity object, List<Sid> sids)

Same as readAclsById(List, List) except it returns only a single Acl.

Parameters
object to locate an Acl for
sids the security identities for which Acl information is required (may be null to denote all entries)
Returns
Throws
NotFoundException

public Map<ObjectIdentity, Acl> readAclsById (List<ObjectIdentity> objects)

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.

Parameters
objects the objects to find Acl information for
Returns
  • a map with exactly one element for each ObjectIdentity passed as an argument (never null)
Throws
NotFoundException

public Map<ObjectIdentity, Acl> readAclsById (List<ObjectIdentity> objects, List<Sid> sids)

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 not have a map key.

Parameters
objects the objects to find Acl information for
sids the security identities for which Acl information is required (may be null to denote all entries)
Returns
  • a map with exactly one element for each ObjectIdentity passed as an argument (never null)
Throws
NotFoundException

public void setFindChildrenQuery (String findChildrenSql)

Allows customization of the SQL query used to find child object identities.