Coverage Report

Coverage Report - org.acegisecurity.acls.AclService

Classes in this File

 /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.acegisecurity.acls;
 
 import org.acegisecurity.acls.objectidentity.ObjectIdentity;
 import org.acegisecurity.acls.sid.Sid;
 
 import java.util.Map;
 
 
 /**
  * Provides retrieval of {@link Acl} instances.
  *
  * @author Ben Alex
  * @version $Id: AclService.java 1784 2007-02-24 21:00:24Z luke_t $
  */
 public interface AclService {
     //~ Methods ========================================================================================================
 
     /**
      * Locates all object identities that use the specified parent.  This is useful for administration tools.
      *
      * @param parentIdentity to locate children of
      *
      * @return the children (or <code>null</code> if none were found)
      */
     ObjectIdentity[] findChildren(ObjectIdentity parentIdentity);
 
     /**
      * Same as {@link #readAclsById(ObjectIdentity[])} except it returns only a single Acl.<p>This method
      * should not be called as it does not leverage the underlaying implementation's potential ability to filter
      * <code>Acl</code> entries based on a {@link Sid} parameter.</p>
      *
      * @param object DOCUMENT ME!
      *
      * @return DOCUMENT ME!
      *
      * @throws NotFoundException DOCUMENT ME!
      */
     Acl readAclById(ObjectIdentity object) throws NotFoundException;
 
     /**
      * Same as {@link #readAclsById(ObjectIdentity[], Sid[])} except it returns only a single Acl.
      *
      * @param object DOCUMENT ME!
      * @param sids DOCUMENT ME!
      *
      * @return DOCUMENT ME!
      *
      * @throws NotFoundException DOCUMENT ME!
      */
     Acl readAclById(ObjectIdentity object, Sid[] sids)
         throws NotFoundException;
 
     /**
      * Obtains all the <code>Acl</code>s that apply for the passed <code>Object</code>s.<p>The returned map is
      * keyed on the passed objects, with the values being the <code>Acl</code> instances. Any unknown objects will not
      * have a map key.</p>
      *
      * @param objects the objects to find ACL information for
      *
      * @return a map with zero or more elements (never <code>null</code>)
      *
      * @throws NotFoundException DOCUMENT ME!
      */
     Map readAclsById(ObjectIdentity[] objects) throws NotFoundException;
 
     /**
      * Obtains all the <code>Acl</code>s that apply for the passed <code>Object</code>s, but only for the
      * security identifies passed.<p>Implementations <em>MAY</em> 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.</p>
      *  <p>The returned map is keyed on the passed objects, with the values being the <code>Acl</code>
      * instances. Any unknown objects (or objects for which the interested <code>Sid</code>s do not have entries) will
      * not have a map key.</p>
      *
      * @param objects the objects to find ACL information for
      * @param sids the security identities for which ACL information is required (may be <code>null</code> to denote
      *        all entries)
      *
      * @return a map with zero or more elements (never <code>null</code>)
      *
      * @throws NotFoundException DOCUMENT ME!
      */
     Map readAclsById(ObjectIdentity[] objects, Sid[] sids)
         throws NotFoundException;
 }

1		/* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
2		*
3		* Licensed under the Apache License, Version 2.0 (the "License");
4		* you may not use this file except in compliance with the License.
5		* You may obtain a copy of the License at
6		*
7		* http://www.apache.org/licenses/LICENSE-2.0
8		*
9		* Unless required by applicable law or agreed to in writing, software
10		* distributed under the License is distributed on an "AS IS" BASIS,
11		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12		* See the License for the specific language governing permissions and
13		* limitations under the License.
14		*/
15		package org.acegisecurity.acls;
16
17		import org.acegisecurity.acls.objectidentity.ObjectIdentity;
18		import org.acegisecurity.acls.sid.Sid;
19
20		import java.util.Map;
21
22
23		/**
24		* Provides retrieval of {@link Acl} instances.
25		*
26		* @author Ben Alex
27		* @version $Id: AclService.java 1784 2007-02-24 21:00:24Z luke_t $
28		*/
29		public interface AclService {
30		//~ Methods ========================================================================================================
31
32		/**
33		* Locates all object identities that use the specified parent. This is useful for administration tools.
34		*
35		* @param parentIdentity to locate children of
36		*
37		* @return the children (or <code>null</code> if none were found)
38		*/
39		ObjectIdentity[] findChildren(ObjectIdentity parentIdentity);
40
41		/**
42		* Same as {@link #readAclsById(ObjectIdentity[])} except it returns only a single Acl.<p>This method
43		* should not be called as it does not leverage the underlaying implementation's potential ability to filter
44		* <code>Acl</code> entries based on a {@link Sid} parameter.</p>
45		*
46		* @param object DOCUMENT ME!
47		*
48		* @return DOCUMENT ME!
49		*
50		* @throws NotFoundException DOCUMENT ME!
51		*/
52		Acl readAclById(ObjectIdentity object) throws NotFoundException;
53
54		/**
55		* Same as {@link #readAclsById(ObjectIdentity[], Sid[])} except it returns only a single Acl.
56		*
57		* @param object DOCUMENT ME!
58		* @param sids DOCUMENT ME!
59		*
60		* @return DOCUMENT ME!
61		*
62		* @throws NotFoundException DOCUMENT ME!
63		*/
64		Acl readAclById(ObjectIdentity object, Sid[] sids)
65		throws NotFoundException;
66
67		/**
68		* Obtains all the <code>Acl</code>s that apply for the passed <code>Object</code>s.<p>The returned map is
69		* keyed on the passed objects, with the values being the <code>Acl</code> instances. Any unknown objects will not
70		* have a map key.</p>
71		*
72		* @param objects the objects to find ACL information for
73		*
74		* @return a map with zero or more elements (never <code>null</code>)
75		*
76		* @throws NotFoundException DOCUMENT ME!
77		*/
78		Map readAclsById(ObjectIdentity[] objects) throws NotFoundException;
79
80		/**
81		* Obtains all the <code>Acl</code>s that apply for the passed <code>Object</code>s, but only for the
82		* security identifies passed.<p>Implementations <em>MAY</em> provide a subset of the ACLs via this method
83		* although this is NOT a requirement. This is intended to allow performance optimisations within implementations.
84		* Callers should therefore use this method in preference to the alternative overloaded version which does not
85		* have performance optimisation opportunities.</p>
86		* <p>The returned map is keyed on the passed objects, with the values being the <code>Acl</code>
87		* instances. Any unknown objects (or objects for which the interested <code>Sid</code>s do not have entries) will
88		* not have a map key.</p>
89		*
90		* @param objects the objects to find ACL information for
91		* @param sids the security identities for which ACL information is required (may be <code>null</code> to denote
92		* all entries)
93		*
94		* @return a map with zero or more elements (never <code>null</code>)
95		*
96		* @throws NotFoundException DOCUMENT ME!
97		*/
98		Map readAclsById(ObjectIdentity[] objects, Sid[] sids)
99		throws NotFoundException;
100		}