java.security

Class AlgorithmParametersSpi

Known Direct Subclasses:
BlockCipherParameters, DHParameters, DSSParameters

public abstract class AlgorithmParametersSpi
extends Object

AlgorithmParametersSpi is the Service Provider Interface for the Algorithm Parameters class. This class is used to manage the algorithm parameters.
Since:
1.2

Constructor Summary

AlgorithmParametersSpi()
Creates a new instance of AlgorithmParametersSpi

Method Summary

protected abstract byte[]
engineGetEncoded()
Returns the parameters in the default encoding format.
protected abstract byte[]
engineGetEncoded(String format)
Returns the parameters in the specified encoding format.
protected abstract void
engineInit(byte[] params)
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification.
protected abstract void
engineInit(byte[] params, String format)
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification.
protected abstract void
engineInit(AlgorithmParameterSpec paramSpec)
Initializes the engine with the specified AlgorithmParameterSpec class.
protected abstract String
engineToString()
Returns a string describing the parameters in the AlgorithmParametersSpi class.
protected abstract
extends AlgorithmParameterSpec> T engineGetParameterSpec(Class paramSpec)
Returns a specification of this AlgorithmParameters object.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AlgorithmParametersSpi

public AlgorithmParametersSpi()
Creates a new instance of AlgorithmParametersSpi

Method Details

engineGetEncoded

protected abstract byte[] engineGetEncoded()
            throws IOException
Returns the parameters in the default encoding format. The primary encoding format is ASN.1 format if it exists for the specified type.
Returns:
byte array representing the parameters

engineGetEncoded

protected abstract byte[] engineGetEncoded(String format)
            throws IOException
Returns the parameters in the specified encoding format. If format is null then the primary encoding format is used, the ASN.1 format, if it exists for the specified type.
Returns:
byte array representing the parameters

engineInit

protected abstract void engineInit(byte[] params)
            throws IOException
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification. If the ASN.1 specification exists then it succeeds or else it throws IOException.
Parameters:
params - Parameters to initialize with
Throws:
IOException - Decoding Error

engineInit

protected abstract void engineInit(byte[] params,
                                   String format)
            throws IOException
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification. If format is null, then it is decoded using the ASN.1 specification if it exists or else it throws IOException.
Parameters:
params - Parameters to initialize with
format - Name of decoding format to use
Throws:
IOException - Decoding Error

engineInit

protected abstract void engineInit(AlgorithmParameterSpec paramSpec)
            throws InvalidParameterSpecException
Initializes the engine with the specified AlgorithmParameterSpec class.
Parameters:
paramSpec - A AlgorithmParameterSpec to initialize with
Throws:
InvalidParameterSpecException - For an inapporiate ParameterSpec class

engineToString

protected abstract String engineToString()
Returns a string describing the parameters in the AlgorithmParametersSpi class.
Returns:
A string representing the format of the parameters.

extends AlgorithmParameterSpec> T engineGetParameterSpec

protected abstract extends AlgorithmParameterSpec>
  T engineGetParameterSpec(Class paramSpec)
            throws InvalidParameterSpecException
Returns a specification of this AlgorithmParameters object. paramSpec identifies the class to return the AlgortihmParameters in.
Parameters:
paramSpec - Class to return AlgorithmParameters in
Returns:
the parameter specification
Throws:
InvalidParameterSpecException - if the paramSpec is an invalid parameter class

AlgorithmParametersSpi.java --- Algorithm Parameters SPI Copyright (C) 1999, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.