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.TurbineServices;
25  
26  /***
27   * This is a facade class for the CryptoService.
28   *
29   * Here are the static methods that call related methods of the
30   * various implementations of the Crypto Security Service, according
31   * to the settings in TurbineResources.
32   *
33   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
34   * @version $Id: TurbineCrypto.java 534527 2007-05-02 16:10:59Z tv $
35   */
36  public abstract class TurbineCrypto
37  {
38      /***
39       * Retrieves an implementation of the CryptoService, based on
40       * the settings in TurbineResources.
41       *
42       * @return an implementation of the CryptoService
43       */
44  
45      public static CryptoService getService()
46      {
47          return (CryptoService) TurbineServices.getInstance()
48                  .getService(CryptoService.SERVICE_NAME);
49      }
50  
51      /***
52       * Returns a CryptoAlgorithm Object which represents the requested
53       * crypto algorithm.
54       *
55       * @param algo      Name of the requested algorithm
56       * @return An Object representing the algorithm
57       * @throws NoSuchAlgorithmException  Requested algorithm is not available
58       */
59      public static CryptoAlgorithm getCryptoAlgorithm(String algo)
60              throws NoSuchAlgorithmException
61      {
62          return getService().getCryptoAlgorithm(algo);
63      }
64  
65  }