View Javadoc

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.adapters;
17  
18  import org.acegisecurity.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,v 1.4 2005/11/17 00:55:49 benalex Exp $
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
39       * the <code>AuthByAdapter</code> implementation. The implementation
40       * should convert the value to a hash code at construction time, rather
41       * than storing the key itself.
42       *
43       * @return the hash code of the key used when the object was created.
44       */
45      public int getKeyHash();
46  }