org.apache.fulcrum.crypto.CryptoService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fulcrum-crypto Show documentation

Fulcrum Crypto Service

The newest version!

package org.apache.fulcrum.crypto;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.security.NoSuchAlgorithmException;

/**
 * An implementation of CryptoService that uses either supplied crypto
 * Algorithms (provided in Fulcrum.properties) or tries to get them via
 * the normal java mechanisms if this fails.
 *
 * @author Eric Pugh
 * @author Stephen McConnell
 * @version $Id: CryptoService.java 1852158 2019-01-25 18:19:46Z painter $ 
 */
public interface CryptoService
{
    String ROLE = CryptoService.class.getName();

  /**
   * Returns a CryptoAlgorithm Object which represents the requested
   * crypto algorithm.
   *
   * @param algo Name of the requested algorithm
   * @return An Object representing the algorithm
   * @throws NoSuchAlgorithmException  Requested algorithm is not available
   *
   */
  public CryptoAlgorithm getCryptoAlgorithm(String algo) throws NoSuchAlgorithmException;
}