001package org.apache.fulcrum.crypto; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import java.security.NoSuchAlgorithmException; 023 024/** 025 * An implementation of CryptoService that uses either supplied crypto 026 * Algorithms (provided in Fulcrum.properties) or tries to get them via 027 * the normal java mechanisms if this fails. 028 * 029 * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a> 030 * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a> 031 * @version $Id: CryptoService.java 1852158 2019-01-25 18:19:46Z painter $ 032 */ 033public interface CryptoService 034{ 035 String ROLE = CryptoService.class.getName(); 036 037 /** 038 * Returns a CryptoAlgorithm Object which represents the requested 039 * crypto algorithm. 040 * 041 * @param algo Name of the requested algorithm 042 * @return An Object representing the algorithm 043 * @throws NoSuchAlgorithmException Requested algorithm is not available 044 * 045 */ 046 public CryptoAlgorithm getCryptoAlgorithm(String algo) throws NoSuchAlgorithmException; 047}