01: /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
02: *
03: * Licensed under the Apache License, Version 2.0 (the "License");
04: * you may not use this file except in compliance with the License.
05: * You may obtain a copy of the License at
06: *
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * 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:
16: package org.acegisecurity.acl;
17:
18: import org.acegisecurity.Authentication;
19:
20: /**
21: * Obtains the <code>AclEntry</code> instances that apply to a particular
22: * domain object instance.
23: *
24: * @author Ben Alex
25: * @version $Id: AclManager.java 1784 2007-02-24 21:00:24Z luke_t $
26: */
27: public interface AclManager {
28: //~ Methods ========================================================================================================
29:
30: /**
31: * Obtains the ACLs that apply to the specified domain instance.
32: *
33: * @param domainInstance the instance for which ACL information is required (never <code>null</code>)
34: *
35: * @return the ACLs that apply, or <code>null</code> if no ACLs apply to the specified domain instance
36: */
37: AclEntry[] getAcls(Object domainInstance);
38:
39: /**
40: * Obtains the ACLs that apply to the specified domain instance, but only including those ACLs which have
41: * been granted to the presented <code>Authentication</code> object
42: *
43: * @param domainInstance the instance for which ACL information is required (never <code>null</code>)
44: * @param authentication the prncipal for which ACL information should be filtered (never <code>null</code>)
45: *
46: * @return only those ACLs applying to the domain instance that have been granted to the principal (or
47: * <code>null</code>) if no such ACLs are found
48: */
49: AclEntry[] getAcls(Object domainInstance,
50: Authentication authentication);
51: }
|