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: package org.acegisecurity.acls.sid;
16:
17: /**
18: * A security identity recognised by the ACL system.
19: *
20: * <p>
21: * This interface provides indirection between actual security objects (eg
22: * principals, roles, groups etc) and what is stored inside an
23: * <code>Acl</code>. This is because an <code>Acl</code> will not store an
24: * entire security object, but only an abstraction of it. This interface
25: * therefore provides a simple way to compare these abstracted security
26: * identities with other security identities and actual security objects.
27: * </p>
28: *
29: * @author Ben Alex
30: * @version $Id: Sid.java 1784 2007-02-24 21:00:24Z luke_t $
31: */
32: public interface Sid {
33: //~ Methods ========================================================================================================
34:
35: /**
36: * Refer to the <code>java.lang.Object</code> documentation for the interface contract.
37: *
38: * @param obj to be compared
39: *
40: * @return <code>true</code> if the objects are equal, <code>false</code> otherwise
41: */
42: boolean equals(Object obj);
43:
44: /**
45: * Refer to the <code>java.lang.Object</code> documentation for the interface contract.
46: *
47: * @return a hash code representation of this object
48: */
49: int hashCode();
50: }
|