Source code: org/acegisecurity/acl/basic/AclObjectIdentityAware.java
1 /* Copyright 2004 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
16 package org.acegisecurity.acl.basic;
17
18 /**
19 * Indicates a domain object instance is able to provide {@link
20 * AclObjectIdentity} information.
21 *
22 * <P>
23 * Domain objects must implement this interface if they wish to provide an
24 * <code>AclObjectIdentity</code> rather than it being determined by relying
25 * classes. Specifically, the {@link BasicAclProvider} detects and uses this
26 * interface.
27 * </p>
28 *
29 * @author Ben Alex
30 * @version $Id: AclObjectIdentityAware.java,v 1.2 2005/11/17 00:55:47 benalex Exp $
31 */
32 public interface AclObjectIdentityAware {
33 //~ Methods ================================================================
34
35 /**
36 * Retrieves the <code>AclObjectIdentity</code> for this instance.
37 *
38 * @return the ACL object identity for this instance (can never be
39 * <code>null</code>)
40 */
41 public AclObjectIdentity getAclObjectIdentity();
42 }