View Javadoc

1   package org.apache.turbine.services.crypto.provider;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.turbine.services.crypto.CryptoAlgorithm;
23  
24  /***
25   * This is a dummy for "cleartext" encryption. It goes through
26   * the notions of the CryptoAlgorithm interface but actually does
27   * nothing. It can be used as a replacement for the "encrypt = no"
28   * setting in the TR.props.
29   *
30   * Can be used as the default crypto algorithm
31   *
32   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
33   * @version $Id: ClearCrypt.java 534527 2007-05-02 16:10:59Z tv $
34   */
35  public class ClearCrypt
36          implements CryptoAlgorithm
37  {
38      /***
39       * C'tor
40       */
41      public ClearCrypt()
42      {
43      }
44  
45      /***
46       * This class never uses an algorithm, so this is
47       * just a dummy.
48       *
49       * @param cipher    Cipher (ignored)
50       */
51      public void setCipher(String cipher)
52      {
53          /* dummy */
54      }
55  
56      /***
57       * This class never uses a seed, so this is
58       * just a dummy.
59       *
60       * @param seed        Seed (ignored)
61       */
62      public void setSeed(String seed)
63      {
64          /* dummy */
65      }
66  
67      /***
68       * encrypt the supplied string with the requested cipher
69       *
70       * @param value       The value to be encrypted
71       * @return The encrypted value
72       * @throws Exception An Exception of the underlying implementation.
73       */
74      public String encrypt(String value)
75              throws Exception
76      {
77          /*
78           * Ultra-clever implementation. ;-)
79           */
80  
81          return value;
82      }
83  
84  }