View Javadoc

1   package org.apache.fulcrum.crypto;
2   
3   
4   /*
5    * Licensed to the Apache Software Foundation (ASF) under one
6    * or more contributor license agreements.  See the NOTICE file
7    * distributed with this work for additional information
8    * regarding copyright ownership.  The ASF licenses this file
9    * to you under the Apache License, Version 2.0 (the
10   * "License"); you may not use this file except in compliance
11   * with the License.  You may obtain a copy of the License at
12   *
13   *   http://www.apache.org/licenses/LICENSE-2.0
14   *
15   * Unless required by applicable law or agreed to in writing,
16   * software distributed under the License is distributed on an
17   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18   * KIND, either express or implied.  See the License for the
19   * specific language governing permissions and limitations
20   * under the License.
21   */
22  
23  
24  import java.security.NoSuchAlgorithmException;
25  
26  /**
27   * An implementation of CryptoService that uses either supplied crypto
28   * Algorithms (provided in Fulcrum.properties) or tries to get them via
29   * the normal java mechanisms if this fails.
30   *
31   * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a>
32   * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
33   */
34  public interface CryptoService
35  {
36      String ROLE = CryptoService.class.getName();
37  
38    /**
39     * Returns a CryptoAlgorithm Object which represents the requested
40     * crypto algorithm.
41     *
42     * @param algo      Name of the requested algorithm
43     *
44     * @return An Object representing the algorithm
45     *
46     * @throws NoSuchAlgorithmException  Requested algorithm is not available
47     *
48     */
49    public CryptoAlgorithm getCryptoAlgorithm(String algo) throws NoSuchAlgorithmException;
50  }