1 /* AlgorithmParametersSpi.java --- Algorithm Parameters SPI
2 Copyright (C) 1999 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
38 package java
.security
;
39 import java
.security
.spec
.InvalidParameterSpecException
;
40 import java
.security
.spec
.AlgorithmParameterSpec
;
41 import java
.io
.IOException
;
44 AlgorithmParametersSpi is the Service Provider Interface
45 for the Algorithm Parameters class. This class is used
46 to manage the algorithm parameters.
49 @author Mark Benvenuto
51 public abstract class AlgorithmParametersSpi
54 Creates a new instance of AlgorithmParametersSpi
56 public AlgorithmParametersSpi()
61 Initializes the engine with the specified
62 AlgorithmParameterSpec class.
64 @param paramSpec A AlgorithmParameterSpec to initialize with
66 @throws InvalidParameterSpecException For an inapporiate ParameterSpec class
68 protected abstract void engineInit(AlgorithmParameterSpec paramSpec
) throws
69 InvalidParameterSpecException
;
72 Initializes the engine with the specified
73 parameters stored in the byte array and decodes them
74 according to the ASN.1 specification. If the ASN.1
75 specification exists then it succeeds or else it throws
78 @param params Parameters to initialize with
80 @throws IOException Decoding Error
82 protected abstract void engineInit(byte[]params
) throws IOException
;
85 Initializes the engine with the specified
86 parameters stored in the byte array and decodes them
87 according to the specified decoding specification.
88 If format is null, then it is decoded using the ASN.1
89 specification if it exists or else it throws
92 @param params Parameters to initialize with
93 @param format Name of decoding format to use
95 @throws IOException Decoding Error
97 protected abstract void engineInit(byte[]params
,
98 String format
) throws IOException
;
102 Returns a specification of this AlgorithmParameters object.
103 paramSpec identifies the class to return the AlgortihmParameters
106 @param paramSpec Class to return AlgorithmParameters in
108 @return the parameter specification
110 @throws InvalidParameterSpecException if the paramSpec is an invalid parameter class
112 protected abstract AlgorithmParameterSpec
engineGetParameterSpec(Class
114 throws InvalidParameterSpecException
;
118 Returns the parameters in the default encoding format.
119 The primary encoding format is ASN.1 format if it exists
120 for the specified type.
122 @return byte array representing the parameters
124 protected abstract byte[] engineGetEncoded() throws IOException
;
128 Returns the parameters in the specified encoding format.
129 If <code>format</code> is <code>null</code> then the
130 primary encoding format is used, the ASN.1 format,
131 if it exists for the specified type.
133 @return byte array representing the parameters
135 protected abstract byte[] engineGetEncoded(String format
) throws
139 Returns a string describing the parameters in the
140 AlgorithmParametersSpi class.
142 @return A string representing the format of the parameters.
144 protected abstract String
engineToString();