PasswordEncoding


1   /*****************************************************************
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   ****************************************************************/
19  
20  
21  package org.apache.cayenne.conf;
22  
23  /**
24   * Password encoders are used to translate the text of the database password,
25   * on loading and on saving, from one form to another.  It can facilitate
26   * the obscuring of the password text to make database connection information
27   * less obvious to someone who stumbles onto the password.
28   * 
29   * Cayenne only includes facilities to obscure, not encrypt, the database
30   * password.  The mechanism is user-extensible, though, so should stronger
31   * security features be required, they can be added and integrated into
32   * both the modeler and framework.
33   * 
34   * @since 3.0
35   * @author Michael Gentry
36   */
37  public interface PasswordEncoding
38  {
39    final String  [] standardEncoders =
40      new String  [] { PlainTextPasswordEncoder.class.getName(),
41                     Rot13PasswordEncoder.class.getName(),
42                     Rot47PasswordEncoder.class.getName() };
43  
44    /**
45     * Decodes an encoded database password.
46     * 
47     * @param encodedPassword - The encoded password to be decoded
48     * @param salt - An optional data element which can be used to salt the algorithm.
49     * @return The decoded normal/plain plassword.
50     */
51    public String   decodePassword(String   encodedPassword, String   salt);
52  
53    /**
54     * Encodes a normal/plain database password.
55     * 
56     * @param normalPassword - The normal/plain password to be encoded
57     * @param salt - An optional data element which can be used to salt the algorithm.
58     * @return The encoded password.
59     */
60    public String   encodePassword(String   normalPassword, String   salt);
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags