View Javadoc

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.providers.dao;
17  
18  import org.springframework.security.userdetails.UserDetails;
19  
20  
21  /**
22   * Provides alternative sources of the salt to use for encoding passwords.
23   *
24   * @author Ben Alex
25   * @version $Id: SaltSource.java 2217 2007-10-27 00:45:30Z luke_t $
26   */
27  public interface SaltSource {
28      //~ Methods ========================================================================================================
29  
30      /**
31       * Returns the salt to use for the indicated user.
32       *
33       * @param user from the <code>AuthenticationDao</code>
34       *
35       * @return the salt to use for this <code>UserDetails</code>
36       */
37      Object getSalt(UserDetails user);
38  }