public class SSLContext extends Object
SSLEngine
s. This class is initialized with an optional set of key and trust managers and source of secure random bytes. Every implementation of the Java platform is required to support the following standard SSLContext
protocol:
TLSv1.2
Modifier | Constructor | Description |
---|---|---|
protected |
Creates an SSLContext object. |
Modifier and Type | Method | Description |
---|---|---|
final SSLEngine |
createSSLEngine() |
Creates a new SSLEngine using this context. |
final SSLEngine |
createSSLEngine |
Creates a new SSLEngine using this context using advisory peer information. |
final SSLSessionContext |
getClientSessionContext() |
Returns the client session context, which represents the set of SSL sessions available for use during the handshake phase of client-side SSL sockets. |
static SSLContext |
getDefault() |
Returns the default SSL context. |
final SSLParameters |
getDefaultSSLParameters() |
Returns a copy of the SSLParameters indicating the default settings for this SSL context. |
static SSLContext |
getInstance |
Returns a SSLContext object that implements the specified secure socket protocol. |
static SSLContext |
getInstance |
Returns a SSLContext object that implements the specified secure socket protocol. |
static SSLContext |
getInstance |
Returns a SSLContext object that implements the specified secure socket protocol. |
final String |
getProtocol() |
Returns the protocol name of this SSLContext object. |
final Provider |
getProvider() |
Returns the provider of this SSLContext object. |
final SSLSessionContext |
getServerSessionContext() |
Returns the server session context, which represents the set of SSL sessions available for use during the handshake phase of server-side SSL sockets. |
final SSLServerSocketFactory |
getServerSocketFactory() |
Returns a ServerSocketFactory object for this context. |
final SSLSocketFactory |
getSocketFactory() |
Returns a SocketFactory object for this context. |
final SSLParameters |
getSupportedSSLParameters() |
Returns a copy of the SSLParameters indicating the supported settings for this SSL context. |
final void |
init |
Initializes this context. |
static void |
setDefault |
Sets the default SSL context. |
protected SSLContext(SSLContextSpi contextSpi, Provider provider, String protocol)
contextSpi
- the delegateprovider
- the providerprotocol
- the protocolpublic static SSLContext getDefault() throws NoSuchAlgorithmException
If a default context was set using the SSLContext.setDefault()
method, it is returned. Otherwise, the first call of this method triggers the call SSLContext.getInstance("Default")
. If successful, that object is made the default SSL context and returned.
The default context is immediately usable and does not require initialization.
NoSuchAlgorithmException
- if the SSLContext.getInstance()
call failspublic static void setDefault(SSLContext context)
getDefault()
. The default context must be immediately usable and not require initialization.context
- the SSLContextNullPointerException
- if context is nullSecurityException
- if a security manager exists and its checkPermission
method does not allow SSLPermission("setDefaultSSLContext")
public static SSLContext getInstance(String protocol) throws NoSuchAlgorithmException
SSLContext
object that implements the specified secure socket protocol. This method traverses the list of registered security Providers, starting with the most preferred Provider. A new SSLContext object encapsulating the SSLContextSpi implementation from the first Provider that supports the specified protocol is returned.
Note that the list of registered providers may be retrieved via the Security.getProviders()
method.
jdk.security.provider.preferred
Security
property to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned by Security.getProviders()
.protocol
- the standard name of the requested protocol. See the SSLContext section in the Java Security Standard Algorithm Names Specification for information about standard protocol names.SSLContext
objectNoSuchAlgorithmException
- if no Provider
supports a SSLContextSpi
implementation for the specified protocolNullPointerException
- if protocol
is null
public static SSLContext getInstance(String protocol, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
SSLContext
object that implements the specified secure socket protocol. A new SSLContext object encapsulating the SSLContextSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the Security.getProviders()
method.
protocol
- the standard name of the requested protocol. See the SSLContext section in the Java Security Standard Algorithm Names Specification for information about standard protocol names.provider
- the name of the provider.SSLContext
objectIllegalArgumentException
- if the provider name is null
or emptyNoSuchAlgorithmException
- if a SSLContextSpi
implementation for the specified protocol is not available from the specified providerNoSuchProviderException
- if the specified provider is not registered in the security provider listNullPointerException
- if protocol
is null
public static SSLContext getInstance(String protocol, Provider provider) throws NoSuchAlgorithmException
SSLContext
object that implements the specified secure socket protocol. A new SSLContext object encapsulating the SSLContextSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
protocol
- the standard name of the requested protocol. See the SSLContext section in the Java Security Standard Algorithm Names Specification for information about standard protocol names.provider
- an instance of the provider.SSLContext
objectIllegalArgumentException
- if the provider is null
NoSuchAlgorithmException
- if a SSLContextSpi
implementation for the specified protocol is not available from the specified Provider
objectNullPointerException
- if protocol
is null
public final String getProtocol()
SSLContext
object. This is the same name that was specified in one of the getInstance
calls that created this SSLContext
object.
SSLContext
object.public final Provider getProvider()
SSLContext
object.SSLContext
objectpublic final void init(KeyManager[] km, TrustManager[] tm, SecureRandom random) throws KeyManagementException
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.)
km
- the sources of authentication keys or nulltm
- the sources of peer authentication trust decisions or nullrandom
- the source of randomness for this generator or nullKeyManagementException
- if this operation failspublic final SSLSocketFactory getSocketFactory()
SocketFactory
object for this context.SocketFactory
objectUnsupportedOperationException
- if the underlying provider does not implement the operation.IllegalStateException
- if the SSLContextImpl requires initialization and the init()
has not been calledpublic final SSLServerSocketFactory getServerSocketFactory()
ServerSocketFactory
object for this context.ServerSocketFactory
objectUnsupportedOperationException
- if the underlying provider does not implement the operation.IllegalStateException
- if the SSLContextImpl requires initialization and the init()
has not been calledpublic final SSLEngine createSSLEngine()
SSLEngine
using this context. Applications using this factory method are providing no hints for an internal session reuse strategy. If hints are desired, createSSLEngine(String, int)
should be used instead.
Some cipher suites (such as Kerberos) require remote hostname information, in which case this factory method should not be used.
SSLEngine.setUseClientMode()
before invoking other methods of the SSLEngine.SSLEngine
objectUnsupportedOperationException
- if the underlying provider does not implement the operation.IllegalStateException
- if the SSLContextImpl requires initialization and the init()
has not been calledpublic final SSLEngine createSSLEngine(String peerHost, int peerPort)
SSLEngine
using this context using advisory peer information. Applications using this factory method are providing hints for an internal session reuse strategy.
Some cipher suites (such as Kerberos) require remote hostname information, in which case peerHost needs to be specified.
SSLEngine.setUseClientMode()
before invoking other methods of the SSLEngine.peerHost
- the non-authoritative name of the hostpeerPort
- the non-authoritative portSSLEngine
objectUnsupportedOperationException
- if the underlying provider does not implement the operation.IllegalStateException
- if the SSLContextImpl requires initialization and the init()
has not been calledpublic final SSLSessionContext getServerSessionContext()
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.
public final SSLSessionContext getClientSessionContext()
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.
public final SSLParameters getDefaultSSLParameters()
The parameters will always have the ciphersuites and protocols arrays set to non-null values.
UnsupportedOperationException
- if the default SSL parameters could not be obtained.public final SSLParameters getSupportedSSLParameters()
The parameters will always have the ciphersuites and protocols arrays set to non-null values.
UnsupportedOperationException
- if the supported SSL parameters could not be obtained.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/net/ssl/SSLContext.html