|
Spring Security Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AclService
Provides retrieval of Acl
instances.
Method Summary | |
---|---|
ObjectIdentity[] |
findChildren(ObjectIdentity parentIdentity)
Locates all object identities that use the specified parent. |
Acl |
readAclById(ObjectIdentity object)
Same as readAclsById(ObjectIdentity[]) except it returns only a single Acl. |
Acl |
readAclById(ObjectIdentity object,
Sid[] sids)
Same as readAclsById(ObjectIdentity[], Sid[]) except it returns only a single Acl. |
Map |
readAclsById(ObjectIdentity[] objects)
Obtains all the Acls that apply for the passed Objects. |
Map |
readAclsById(ObjectIdentity[] objects,
Sid[] sids)
Obtains all the Acls that apply for the passed Objects, but only for the security identifies passed. |
Method Detail |
---|
ObjectIdentity[] findChildren(ObjectIdentity parentIdentity)
parentIdentity
- to locate children of
Acl readAclById(ObjectIdentity object) throws NotFoundException
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 Sid
parameter.
object
- to locate an Acl
for
Acl
for the requested ObjectIdentity
(never null)
NotFoundException
- if an Acl
was not found for the requested ObjectIdentity
Acl readAclById(ObjectIdentity object, Sid[] sids) throws NotFoundException
readAclsById(ObjectIdentity[], Sid[])
except it returns only a single Acl.
object
- to locate an Acl
forsids
- the security identities for which Acl
information is required
(may be null to denote all entries)
Acl
for the requested ObjectIdentity
(never null)
NotFoundException
- if an Acl
was not found for the requested ObjectIdentity
Map readAclsById(ObjectIdentity[] objects) throws NotFoundException
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.
objects
- the objects to find Acl
information for
ObjectIdentity
passed as an argument (never null)
NotFoundException
- if an Acl
was not found for each requested ObjectIdentity
Map readAclsById(ObjectIdentity[] objects, Sid[] sids) throws NotFoundException
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.
objects
- the objects to find Acl
information forsids
- the security identities for which Acl
information is required
(may be null to denote all entries)
ObjectIdentity
passed as an argument (never null)
NotFoundException
- if an Acl
was not found for each requested ObjectIdentity
|
Spring Security Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |