javax.net.ssl.KeyManagerFactory Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of CDC Security
(Java Secure Socket Extension - JSSE) Optional Package interfaces and modules.
*/
/*
* @(#)KeyManagerFactory.java 1.7 05/03/12
*/
/*
* NOTE:
* Because of various external restrictions (i.e. US export
* regulations, etc.), the actual source code can not be provided
* at this time. This file represents the skeleton of the source
* file, so that javadocs of the API can be created.
*/
package javax.net.ssl;
import java.security.*;
import java.security.Security;
/**
* This class acts as a factory for key managers based on a
* source of key material. Each key manager manages a specific
* type of key material for use by secure sockets. The key
* material is based on a KeyStore and/or provider specific sources.
*
* @since 1.4
* @see KeyManager
* @version 1.14
*/
public class KeyManagerFactory
{
/**
* Creates a KeyManagerFactory object.
*
* @param factorySpi the delegate
* @param provider the provider
* @param algorithm the algorithm
*/
protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider
provider, String algorithm)
{ }
/**
* Obtains the default KeyManagerFactory algorithm name.
*
*
The default algorithm can be changed at runtime by setting
* the value of the "ssl.KeyManagerFactory.algorithm" security
* property (set in the Java security properties file or by calling
* {@link java.security.Security#setProperty(java.lang.String,
* java.lang.String)})
* to the desired algorithm name.
*
* @see java.security.Security#setProperty(java.lang.String,
* java.lang.String)
* @return the default algorithm name as specified in the
* Java security properties, or an implementation-specific
* default if no such property exists.
*/
public static final String getDefaultAlgorithm() { return null; }
/**
* Returns the algorithm name of this KeyManagerFactory object.
*
*
This is the same name that was specified in one of the
* getInstance calls that created this
* KeyManagerFactory object.
*
* @return the algorithm name of this KeyManagerFactory object.
*/
public final String getAlgorithm() { return null; }
/**
* Generates a KeyManagerFactory object that implements the
* specified key management algorithm.
*
* If the default provider package provides an implementation of the
* requested key management algorithm, an instance of
* KeyManagerFactory containing that implementation is
* returned. If the algorithm is not available in the default provider
* package, other provider packages are searched.
*
* @param algorithm the standard name of the requested algorithm.
* @return the new KeyManagerFactory object
* @exception NoSuchAlgorithmException if the specified algorithm is not
* available in the default provider package or any of the other
* provider packages that were searched.
*/
public static final KeyManagerFactory getInstance(String algorithm)
throws NoSuchAlgorithmException
{ return null; }
/**
* Generates a KeyManagerFactory object for the specified
* key management algorithm from the specified provider.
*
* @param algorithm the standard name of the requested algorithm.
* @param provider the name of the provider
* @return the new KeyManagerFactory object
* @throws NoSuchAlgorithmException if the specified algorithm is not
* available from the specified provider.
* @throws NoSuchProviderException if the specified provider has not
* been configured.
* @throws IllegalArgumentException if provider is not specified
*/
public static final KeyManagerFactory getInstance(String algorithm, String
provider) throws NoSuchAlgorithmException, NoSuchProviderException
{ return null; }
/**
* Generates a KeyManagerFactory object for the specified
* key management algorithm from the specified provider.
*
* @param algorithm the standard name of the requested algorithm.
* @param provider an instance of the provider
* @return the new KeyManagerFactory object
* @throws NoSuchAlgorithmException if the specified algorithm is not
* available from the specified provider.
* @throws IllegalArgumentException if provider is not specified
*/
public static final KeyManagerFactory getInstance(String algorithm,
Provider provider) throws NoSuchAlgorithmException
{ return null; }
/**
* Returns the provider of this KeyManagerFactory object.
*
* @return the provider of this KeyManagerFactory object
*/
public final Provider getProvider() { return null; }
/**
* Initializes this factory with a source of key material.
*
* The provider typically uses a KeyStore for obtaining
* key material for use during secure socket negotiations.
* The KeyStore is generally password-protected.
*
* For more flexible initialization, please see
* {@link #init(ManagerFactoryParameters)}.
*
*
* @param ks the key store or null
* @param password the password for recovering keys in the KeyStore
* @throws KeyStoreException if this operation fails
* @throws NoSuchAlgorithmException if the specified algorithm is not
* available from the specified provider.
* @throws UnrecoverableKeyException if the key cannot be recovered
* (e.g. the given password is wrong).
*/
public final void init(KeyStore ks, char[] password)
throws KeyStoreException, NoSuchAlgorithmException,
UnrecoverableKeyException
{ }
/**
* Initializes this factory with a source of provider-specific
* key material.
*
* In some cases, initialization parameters other than a keystore
* and password may be needed by a provider. Users of that
* particular provider are expected to pass an implementation of
* the appropriate ManagerFactoryParameters as
* defined by the provider. The provider can then call the
* specified methods in the ManagerFactoryParameters
* implementation to obtain the needed information.
*
* @param spec an implementation of a provider-specific parameter
* specification
* @throws InvalidAlgorithmParameterException if an error is encountered
*/
public final void init(ManagerFactoryParameters spec)
throws InvalidAlgorithmParameterException
{ }
/**
* Returns one key manager for each type of key material.
*
* @return the key managers
*/
public final KeyManager[] getKeyManagers() { return null; }
}