SSLContextSpi

AI-generated Key Takeaways

• SSLContextSpi defines the Service Provider Interface (SPI) for the SSLContext class, enabling cryptographic providers to implement specific SSL contexts.

• Each cryptographic service provider must implement all abstract methods within SSLContextSpi to provide SSL context implementations.

• SSLContextSpi provides methods for creating SSLEngine instances, obtaining session contexts, and managing SSL parameters and factories.

• It allows initialization of the SSL context with key managers, trust managers, and a secure random source.

public abstract class SSLContextSpi extends Object

This class defines the Service Provider Interface (SPI) for the SSLContext class.

All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a particular SSL context.

See Also

• SSLContext

Public Constructor Summary

SSLContextSpi()

Protected Method Summary

abstract SSLEngine	engineCreateSSLEngine() Creates a new SSLEngine using this context.
abstract SSLEngine	engineCreateSSLEngine(String host, int port) Creates a SSLEngine using this context.
abstract SSLSessionContext	engineGetClientSessionContext() Returns a client SSLSessionContext object for this context.
SSLParameters	engineGetDefaultSSLParameters() Returns a copy of the SSLParameters indicating the default settings for this SSL context.
abstract SSLSessionContext	engineGetServerSessionContext() Returns a server SSLSessionContext object for this context.
abstract SSLServerSocketFactory	engineGetServerSocketFactory() Returns a ServerSocketFactory object for this context.
abstract SSLSocketFactory	engineGetSocketFactory() Returns a SocketFactory object for this context.
SSLParameters	engineGetSupportedSSLParameters() Returns a copy of the SSLParameters indicating the maximum supported settings for this SSL context.
abstract void	engineInit(KeyManager[] km, TrustManager[] tm, SecureRandom sr) Initializes this context.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public SSLContextSpi ()

Protected Methods

protected abstract SSLEngine engineCreateSSLEngine ()

Creates a new SSLEngine using this context.

Applications using this factory method are providing no hints for an internal session reuse strategy. If hints are desired, engineCreateSSLEngine(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.

Returns

• the SSLEngine Object

Throws

IllegalStateException	if the SSLContextImpl requires initialization and the engineInit() has not been called

See Also

• SSLContext.createSSLEngine()

protected abstract SSLEngine engineCreateSSLEngine (String host, int port)

Creates a SSLEngine using this context.

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.

Parameters

host	the non-authoritative name of the host
port	the non-authoritative port

Returns

• the SSLEngine Object

Throws

IllegalStateException	if the SSLContextImpl requires initialization and the engineInit() has not been called

See Also

• SSLContext.createSSLEngine(String, int)

protected abstract SSLSessionContext engineGetClientSessionContext ()

Returns a client SSLSessionContext object for this context.

Returns

• the SSLSessionContext object

See Also

• SSLContext.getClientSessionContext()

protected SSLParameters engineGetDefaultSSLParameters ()

Returns a copy of the SSLParameters indicating the default settings for this SSL context.

The parameters will always have the ciphersuite and protocols arrays set to non-null values.

The default implementation obtains the parameters from an SSLSocket created by calling the {@linkplain javax.net.SocketFactory#createSocket SocketFactory.createSocket()} method of this context's SocketFactory.

Returns

• a copy of the SSLParameters object with the default settings

Throws

UnsupportedOperationException	if the default SSL parameters could not be obtained.

protected abstract SSLSessionContext engineGetServerSessionContext ()

Returns a server SSLSessionContext object for this context.

Returns

• the SSLSessionContext object

See Also

• SSLContext.getServerSessionContext()

protected abstract SSLServerSocketFactory engineGetServerSocketFactory ()

Returns a ServerSocketFactory object for this context.

Returns

• the ServerSocketFactory object

Throws

IllegalStateException	if the SSLContextImpl requires initialization and the engineInit() has not been called

See Also

• SSLContext.getServerSocketFactory()

protected abstract SSLSocketFactory engineGetSocketFactory ()

Returns a SocketFactory object for this context.

Returns

• the SocketFactory object

Throws

IllegalStateException	if the SSLContextImpl requires initialization and the engineInit() has not been called

See Also

• SSLContext.getSocketFactory()

protected SSLParameters engineGetSupportedSSLParameters ()

Returns a copy of the SSLParameters indicating the maximum supported settings for this SSL context.

The parameters will always have the ciphersuite and protocols arrays set to non-null values.

The default implementation obtains the parameters from an SSLSocket created by calling the {@linkplain javax.net.SocketFactory#createSocket SocketFactory.createSocket()} method of this context's SocketFactory.

Returns

• a copy of the SSLParameters object with the maximum supported settings

Throws

UnsupportedOperationException	if the supported SSL parameters could not be obtained.

protected abstract void engineInit (KeyManager[] km, TrustManager[] tm, SecureRandom sr)

Initializes this context.

Parameters

km	the sources of authentication keys
tm	the sources of peer authentication trust decisions
sr	the source of randomness

Throws

KeyManagementException	if this operation fails

See Also

• SSLContext.init(KeyManager[], TrustManager[], SecureRandom)