javax.net.ssl.SSLContext 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.
*/
/*
* @(#)SSLContext.java 1.11 06/05/23
*/
/*
* 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.util.*;
/**
* Instances of this class represent a secure socket protocol
* implementation which acts as a factory for secure socket
* factories. This class is initialized with an optional set of
* key and trust managers and source of secure random bytes.
*
* @since 1.4
* @version 1.18
*/
public class SSLContext
{
/**
* Creates an SSLContext object.
*
* @param contextSpi the delegate
* @param provider the provider
* @param protocol the protocol
*/
protected SSLContext(SSLContextSpi contextSpi, Provider provider, String
protocol)
{ }
/**
* Generates a SSLContext object that implements the
* specified secure socket protocol.
*
* If the default provider package provides an implementation of the
* requested key management algorithm, an instance of
* SSLContext containing that implementation is
* returned. If the algorithm is not available in the default provider
* package, other provider packages are searched.
*
* @param protocol the standard name of the requested protocol.
* @return the new SSLContext object
* @exception NoSuchAlgorithmException if the specified protocol is not
* available in the default provider package or any of the
* other provider packages that were searched.
*/
public static SSLContext getInstance(String protocol)
throws NoSuchAlgorithmException
{ return null; }
/**
* Generates a SSLContext object that implements the
* specified secure socket protocol from the specified provider.
*
* @param protocol the standard name of the requested protocol.
* @param provider the name of the provider
* @return the new SSLContext object
* @throws NoSuchAlgorithmException if the specified protocol 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 SSLContext getInstance(String protocol, String provider)
throws NoSuchAlgorithmException, NoSuchProviderException
{ return null; }
/**
* Generates a SSLContext object that implements the
* specified secure socket protocol from the specified provider.
*
* @param protocol the standard name of the requested protocol.
* @param provider an instance of the provider
* @return the new SSLContext object
* @throws NoSuchAlgorithmException if the specified protocol is not
* available from the specified provider.
* @throws IllegalArgumentException if provider is not specified
*/
public static SSLContext getInstance(String protocol, Provider provider)
throws NoSuchAlgorithmException
{ return null; }
/**
* Returns the protocol name of this SSLContext object.
*
*
This is the same name that was specified in one of the
* getInstance calls that created this
* SSLContext object.
*
* @return the protocol name of this SSLContext object.
*/
public final String getProtocol() { return null; }
/**
* Returns the provider of this SSLContext object.
*
* @return the provider of this SSLContext object
*/
public final Provider getProvider() { return null; }
/**
* Initializes this context. Either of the first two parameters
* may be null in which case the installed security providers will
* be searched for the highest priority implementation of the
* appropriate factory. Likewise, the secure random parameter may
* be null in which case the default implementation will be used.
*
* Only the first instance of a particular key and/or trust manager
* implementation type in the array is used. (For example, only
* the first javax.net.ssl.X509KeyManager in the array will be used.)
*
* @param km the sources of authentication keys or null
* @param tm the sources of peer authentication trust decisions or null
* @param random the source of randomness for this generator or null
* @throws KeyManagementException if this operation fails
*/
public final void init(KeyManager[] km, TrustManager[] tm, SecureRandom
random) throws KeyManagementException
{ }
/**
* Returns a SocketFactory object for this
* context.
*
* @return the SocketFactory object
* @throws IllegalStateException if the SSLContextImpl requires
* initialization and the init() has not been called
*/
public final SSLSocketFactory getSocketFactory() { return null; }
/**
* Returns a ServerSocketFactory object for
* this context.
*
* @return the ServerSocketFactory object
* @throws IllegalStateException if the SSLContextImpl requires
* initialization and the init() has not been called
* @throws UnsupportedOperationException if the underlying
* implementation does not support SSLServerSocket
* funcationality.
*/
public final SSLServerSocketFactory getServerSocketFactory() throws
UnsupportedOperationException
{ return null; }
/**
* Returns the server session context, which represents the set of
* SSL sessions available for use during the handshake phase of
* server-side SSL sockets.
*
* This context may be unavailable in some environments, in which
* case this method returns null. For example, when the underlying
* SSL provider does not provide an implementation of SSLSessionContext
* interface, this method returns null. A non-null session context
* is returned otherwise.
*
* @return server session context bound to this SSL context
*/
public final SSLSessionContext getServerSessionContext() { return null; }
/**
* Returns the client session context, which represents the set of
* SSL sessions available for use during the handshake phase of
* client-side SSL sockets.
*
* This context may be unavailable in some environments, in which
* case this method returns null. For example, when the underlying
* SSL provider does not provide an implementation of SSLSessionContext
* interface, this method returns null. A non-null session context
* is returned otherwise.
*
* @return client session context bound to this SSL context
*/
public final SSLSessionContext getClientSessionContext() { return null; }
}