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.adapters;
17:
18: import org.acegisecurity.Authentication;
19:
20: /**
21: * Indicates a specialized, immutable, server-side only {@link Authentication}
22: * class.
23: *
24: * <P>
25: * Automatically considered valid by the {@link AuthByAdapterProvider},
26: * provided the hash code presented by the implementation objects matches that
27: * expected by the <code>AuthByAdapterProvider</code>.
28: * </p>
29: *
30: * @author Ben Alex
31: * @version $Id: AuthByAdapter.java 1784 2007-02-24 21:00:24Z luke_t $
32: */
33: public interface AuthByAdapter extends Authentication {
34: //~ Methods ========================================================================================================
35:
36: /**
37: * Returns the hash code of the key that was passed to the constructor of the <code>AuthByAdapter</code>
38: * implementation. The implementation should convert the value to a hash code at construction time, rather than
39: * storing the key itself.
40: *
41: * @return the hash code of the key used when the object was created.
42: */
43: int getKeyHash();
44: }
|