1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
/* * @(#)AlgorithmParametersSpi.java 1.14 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.security; import java.io.*; import java.security.spec.AlgorithmParameterSpec; import java.security.spec.InvalidParameterSpecException; /** * This class defines the <i>Service Provider Interface</i> (<b>SPI</b>) * for the <code>AlgorithmParameters</code> class, which is used to manage * algorithm parameters. * * <p> All the abstract methods in this class must be implemented by each * cryptographic service provider who wishes to supply parameter management * for a particular algorithm. * * @author Jan Luehe * * @version 1.14, 11/17/05 * * @see AlgorithmParameters * @see java.security.spec.AlgorithmParameterSpec * @see java.security.spec.DSAParameterSpec * * @since 1.2 */ public abstract class AlgorithmParametersSpi { /** * Initializes this parameters object using the parameters * specified in <code>paramSpec</code>. * * @param paramSpec the parameter specification. * * @exception InvalidParameterSpecException if the given parameter * specification is inappropriate for the initialization of this parameter * object. */ protected abstract void engineInit(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException; /** * Imports the specified parameters and decodes them * according to the primary decoding format for parameters. * The primary decoding format for parameters is ASN.1, if an ASN.1 * specification for this type of parameters exists. * * @param params the encoded parameters. * * @exception IOException on decoding errors */ protected abstract void engineInit(byte[] params) throws IOException; /** * Imports the parameters from <code>params</code> and * decodes them according to the specified decoding format. * If <code>format</code> is null, the * primary decoding format for parameters is used. The primary decoding * format is ASN.1, if an ASN.1 specification for these parameters * exists. * * @param params the encoded parameters. * * @param format the name of the decoding format. * * @exception IOException on decoding errors */ protected abstract void engineInit(byte[] params, String format) throws IOException; /** * Returns a (transparent) specification of this parameters * object. * <code>paramSpec</code> identifies the specification class in which * the parameters should be returned. It could, for example, be * <code>DSAParameterSpec.class</code>, to indicate that the * parameters should be returned in an instance of the * <code>DSAParameterSpec</code> class. * * @param paramSpec the the specification class in which * the parameters should be returned. * * @return the parameter specification. * * @exception InvalidParameterSpecException if the requested parameter * specification is inappropriate for this parameter object. */ protected abstract <T extends AlgorithmParameterSpec> T engineGetParameterSpec(Class<T> paramSpec) throws InvalidParameterSpecException; /** * Returns the parameters in their primary encoding format. * The primary encoding format for parameters is ASN.1, if an ASN.1 * specification for this type of parameters exists. * * @return the parameters encoded using their primary encoding format. * * @exception IOException on encoding errors. */ protected abstract byte[] engineGetEncoded() throws IOException; /** * Returns the parameters encoded in the specified format. * If <code>format</code> is null, the * primary encoding format for parameters is used. The primary encoding * format is ASN.1, if an ASN.1 specification for these parameters * exists. * * @param format the name of the encoding format. * * @return the parameters encoded using the specified encoding scheme. * * @exception IOException on encoding errors. */ protected abstract byte[] engineGetEncoded(String format) throws IOException; /** * Returns a formatted string describing the parameters. * * @return a formatted string describing the parameters. */ protected abstract String engineToString(); }