View Javadoc

1   package org.apache.turbine.services.crypto;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * 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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import java.security.NoSuchAlgorithmException;
20  
21  import org.apache.turbine.services.Service;
22  
23  /***
24   * The Crypto Service manages the availability of various crypto
25   * sources. It provides a consistent interface to things like the
26   * various java.security Message Digest stuff or the Unix Crypt
27   * algorithm.
28   *
29   * It contains no actual crypto code so it should be fine to import/export
30   * everywhere.
31   *
32   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
33   * @version $Id: CryptoService.java 264148 2005-08-29 14:21:04Z henning $
34   */
35  public interface CryptoService
36          extends Service
37  {
38      /*** The name of the service */
39      String SERVICE_NAME = "CryptoService";
40  
41      /***
42       * Returns a CryptoAlgorithm Object which represents the requested
43       * crypto algorithm.
44       *
45       * @param algorithm      Name of the requested algorithm
46       * @return An Object representing the algorithm
47       * @throws NoSuchAlgorithmException  Requested algorithm is not available
48       */
49      CryptoAlgorithm getCryptoAlgorithm(String algorithm)
50              throws NoSuchAlgorithmException;
51  }