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