001/* AlgorithmParametersSpi.java --- Algorithm Parameters SPI 002 Copyright (C) 1999, 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package java.security; 040 041import java.io.IOException; 042import java.security.spec.AlgorithmParameterSpec; 043import java.security.spec.InvalidParameterSpecException; 044 045/** 046 * AlgorithmParametersSpi is the Service Provider Interface 047 * for the Algorithm Parameters class. This class is used 048 * to manage the algorithm parameters. 049 * 050 * @since 1.2 051 * @author Mark Benvenuto 052 */ 053public abstract class AlgorithmParametersSpi 054{ 055 /** 056 * Creates a new instance of AlgorithmParametersSpi 057 */ 058 public AlgorithmParametersSpi() 059 { 060 } 061 062 /** 063 * Initializes the engine with the specified 064 * AlgorithmParameterSpec class. 065 * 066 * @param paramSpec A AlgorithmParameterSpec to initialize with 067 * 068 * @throws InvalidParameterSpecException For an inapporiate 069 * ParameterSpec class 070 */ 071 protected abstract void engineInit(AlgorithmParameterSpec paramSpec) 072 throws InvalidParameterSpecException; 073 074 /** 075 * Initializes the engine with the specified 076 * parameters stored in the byte array and decodes them 077 * according to the ASN.1 specification. If the ASN.1 078 * specification exists then it succeeds or else it throws 079 * IOException. 080 * 081 * @param params Parameters to initialize with 082 * 083 * @throws IOException Decoding Error 084 */ 085 protected abstract void engineInit(byte[]params) throws IOException; 086 087 /** 088 * Initializes the engine with the specified 089 * parameters stored in the byte array and decodes them 090 * according to the specified decoding specification. 091 * If format is null, then it is decoded using the ASN.1 092 * specification if it exists or else it throws 093 * IOException. 094 * 095 * @param params Parameters to initialize with 096 * @param format Name of decoding format to use 097 * 098 * @throws IOException Decoding Error 099 */ 100 protected abstract void engineInit(byte[]params, String format) 101 throws IOException; 102 103 104 /** 105 * Returns a specification of this AlgorithmParameters object. 106 * paramSpec identifies the class to return the AlgortihmParameters 107 * in. 108 * 109 * @param paramSpec Class to return AlgorithmParameters in 110 * 111 * @return the parameter specification 112 * 113 * @throws InvalidParameterSpecException if the paramSpec is an 114 * invalid parameter class 115 */ 116 protected abstract <T extends AlgorithmParameterSpec> 117 T engineGetParameterSpec(Class<T> paramSpec) 118 throws InvalidParameterSpecException; 119 120 121 /** 122 * Returns the parameters in the default encoding format. 123 * The primary encoding format is ASN.1 format if it exists 124 * for the specified type. 125 * 126 * @return byte array representing the parameters 127 */ 128 protected abstract byte[] engineGetEncoded() throws IOException; 129 130 131 /** 132 * Returns the parameters in the specified encoding format. 133 * If <code>format</code> is <code>null</code> then the 134 * primary encoding format is used, the ASN.1 format, 135 * if it exists for the specified type. 136 * 137 * @return byte array representing the parameters 138 */ 139 protected abstract byte[] engineGetEncoded(String format) 140 throws IOException; 141 142 /** 143 * Returns a string describing the parameters in the 144 * AlgorithmParametersSpi class. 145 * 146 * @return A string representing the format of the parameters. 147 */ 148 protected abstract String engineToString(); 149}