View Javadoc

1   package org.apache.turbine.services.crypto;
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 java.security.NoSuchAlgorithmException;
23  
24  import org.apache.turbine.services.Service;
25  
26  /***
27   * The Crypto Service manages the availability of various crypto
28   * sources. It provides a consistent interface to things like the
29   * various java.security Message Digest stuff or the Unix Crypt
30   * algorithm.
31   *
32   * It contains no actual crypto code so it should be fine to import/export
33   * everywhere.
34   *
35   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
36   * @version $Id: CryptoService.java 534527 2007-05-02 16:10:59Z tv $
37   */
38  public interface CryptoService
39          extends Service
40  {
41      /*** The name of the service */
42      String SERVICE_NAME = "CryptoService";
43  
44      /***
45       * Returns a CryptoAlgorithm Object which represents the requested
46       * crypto algorithm.
47       *
48       * @param algorithm      Name of the requested algorithm
49       * @return An Object representing the algorithm
50       * @throws NoSuchAlgorithmException  Requested algorithm is not available
51       */
52      CryptoAlgorithm getCryptoAlgorithm(String algorithm)
53              throws NoSuchAlgorithmException;
54  }