Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.security
Class AlgorithmParameters  view AlgorithmParameters download AlgorithmParameters.java

java.lang.Object
  extended byjava.security.AlgorithmParameters

public class AlgorithmParameters
extends java.lang.Object

AlgorithmParameters is an Algorithm Parameters class which provides an interface through which the user can manage the parameters of an Algorithm.

Since:
1.2

Field Summary
private  java.lang.String algorithm
           
private static java.lang.String ALGORITHM_PARAMETERS
          Service name for algorithm parameters.
private  AlgorithmParametersSpi paramSpi
           
private  Provider provider
           
 
Constructor Summary
protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, java.lang.String algorithm)
          Constructs a new instance of AlgorithmParameters.
 
Method Summary
 java.lang.String getAlgorithm()
           
 byte[] getEncoded()
          Returns the parameters in the default encoding format.
 byte[] getEncoded(java.lang.String format)
          Returns the parameters in the specified encoding format.
static AlgorithmParameters getInstance(java.lang.String algorithm)
          Returns a new instance of AlgorithmParameters representing the specified algorithm parameters.
static AlgorithmParameters getInstance(java.lang.String algorithm, Provider provider)
          Returns a new instance of AlgorithmParameters representing the specified algorithm parameters from the specified Provider.
static AlgorithmParameters getInstance(java.lang.String algorithm, java.lang.String provider)
          Returns a new instance of AlgorithmParameters representing the specified algorithm parameters from a named provider.
 java.security.spec.AlgorithmParameterSpec getParameterSpec(java.lang.Class paramSpec)
          Returns a new instance of AlgorithmParameters as a designated parameter specification java.lang.Class.
 Provider getProvider()
           
 void init(java.security.spec.AlgorithmParameterSpec paramSpec)
          Initializes the engine with the specified java.security.spec.AlgorithmParameterSpec.
 void init(byte[] params)
          Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification.
 void init(byte[] params, java.lang.String format)
          Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification.
 java.lang.String toString()
          Returns a string representation of the encoded form.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALGORITHM_PARAMETERS

private static final java.lang.String ALGORITHM_PARAMETERS
Service name for algorithm parameters.

See Also:
Constant Field Values

paramSpi

private AlgorithmParametersSpi paramSpi

provider

private Provider provider

algorithm

private java.lang.String algorithm
Constructor Detail

AlgorithmParameters

protected AlgorithmParameters(AlgorithmParametersSpi paramSpi,
                              Provider provider,
                              java.lang.String algorithm)
Constructs a new instance of AlgorithmParameters.

Method Detail

getAlgorithm

public final java.lang.String getAlgorithm()

getInstance

public static AlgorithmParameters getInstance(java.lang.String algorithm)
                                       throws NoSuchAlgorithmException
Returns a new instance of AlgorithmParameters representing the specified algorithm parameters.

The returned AlgorithmParameters must still be initialized with an init() method.


getInstance

public static AlgorithmParameters getInstance(java.lang.String algorithm,
                                              java.lang.String provider)
                                       throws NoSuchAlgorithmException,
                                              NoSuchProviderException
Returns a new instance of AlgorithmParameters representing the specified algorithm parameters from a named provider.

The returned AlgorithmParameters must still be intialized with an init() method.


getInstance

public static AlgorithmParameters getInstance(java.lang.String algorithm,
                                              Provider provider)
                                       throws NoSuchAlgorithmException
Returns a new instance of AlgorithmParameters representing the specified algorithm parameters from the specified Provider.

The returned AlgorithmParameters must still be intialized with an init() method.

Since:
1.4

getProvider

public final Provider getProvider()

init

public final void init(java.security.spec.AlgorithmParameterSpec paramSpec)
                throws java.security.spec.InvalidParameterSpecException
Initializes the engine with the specified java.security.spec.AlgorithmParameterSpec.


init

public final void init(byte[] params)
                throws java.io.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 otherwise an java.io.IOException is thrown.


init

public final void init(byte[] params,
                       java.lang.String format)
                throws java.io.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 this method decodes the byte array using the ASN.1 specification if it exists, otherwise it throws an java.io.IOException.


getParameterSpec

public final java.security.spec.AlgorithmParameterSpec getParameterSpec(java.lang.Class paramSpec)
                                                                 throws java.security.spec.InvalidParameterSpecException
Returns a new instance of AlgorithmParameters as a designated parameter specification java.lang.Class.


getEncoded

public final byte[] getEncoded()
                        throws java.io.IOException
Returns the parameters in the default encoding format. The primary encoding format is ASN.1 if it exists for the specified type.


getEncoded

public final byte[] getEncoded(java.lang.String format)
                        throws java.io.IOException
Returns the parameters in the specified encoding format. If format is null then the ASN.1 encoding format is used if it exists for the specified type.


toString

public final java.lang.String toString()
Returns a string representation of the encoded form.