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.acegisecurity.providers.encoding;
17  
18  /**
19   * <p>Convenience base for digest password encoders.</p>
20   *
21   * @author colin sampaleanu
22   * @version $Id: BaseDigestPasswordEncoder.java 1496 2006-05-23 13:38:33Z benalex $
23   */
24  public abstract class BaseDigestPasswordEncoder extends BasePasswordEncoder {
25      //~ Instance fields ================================================================================================
26  
27      private boolean encodeHashAsBase64 = false;
28  
29      //~ Methods ========================================================================================================
30  
31      public boolean getEncodeHashAsBase64() {
32          return encodeHashAsBase64;
33      }
34  
35      /**
36       * The encoded password is normally returned as Hex (32 char) version of the hash bytes. Setting this
37       * property to true will cause the encoded pass to be returned as Base64 text, which will consume 24 characters.
38       *
39       * @param encodeHashAsBase64 set to true for Base64 output
40       */
41      public void setEncodeHashAsBase64(boolean encodeHashAsBase64) {
42          this.encodeHashAsBase64 = encodeHashAsBase64;
43      }
44  }