javax.net.ssl

Class SSLContextSpi

  1. java.lang.Object
  2. extended byjavax.net.ssl.SSLContextSpi

  1. public abstract class SSLContextSpi
  2. 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.

Since:
1.4
See Also:
SSLContext

Constructor Summary

Constructor and Description
SSLContextSpi()

Method Summary

Modifier and Type Method and Description
  1. protected abstract
  2. SSLEngine
engineCreateSSLEngine()
Creates a new SSLEngine using this context.
  1. protected abstract
  2. SSLEngine
engineCreateSSLEngine(String host,int port)
Creates a SSLEngine using this context.
  1. protected abstract
  2. SSLSessionContext
engineGetClientSessionContext()
Returns a client SSLSessionContext object for this context.
  1. protected
  2. SSLParameters
engineGetDefaultSSLParameters()
Returns a copy of the SSLParameters indicating the default settings for this SSL context.
  1. protected abstract
  2. SSLSessionContext
engineGetServerSessionContext()
Returns a server SSLSessionContext object for this context.
  1. protected abstract
  2. SSLServerSocketFactory
engineGetServerSocketFactory()
Returns a ServerSocketFactory object for this context.
  1. protected abstract
  2. SSLSocketFactory
engineGetSocketFactory()
Returns a SocketFactory object for this context.
  1. protected
  2. SSLParameters
engineGetSupportedSSLParameters()
Returns a copy of the SSLParameters indicating the maximum supported settings for this SSL context.
  1. protected abstract
  2. void
engineInit(KeyManager[] km,TrustManager[] tm,SecureRandom sr)
Initializes this context.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SSLContextSpi

  1. public SSLContextSpi()

Method Detail

engineInit

  1. protected abstract void engineInit( KeyManager[] km,
  2. TrustManager[] tm,
  3. SecureRandom sr)
  4. throws KeyManagementException
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:

engineGetSocketFactory

  1. 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:

engineGetServerSocketFactory

  1. 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:

engineCreateSSLEngine

  1. 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
Since:
1.5
See Also:

engineCreateSSLEngine

  1. protected abstract SSLEngine engineCreateSSLEngine( String host,
  2. 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
Since:
1.5
See Also:

engineGetServerSessionContext

  1. protected abstract SSLSessionContext engineGetServerSessionContext( )
Returns a server SSLSessionContext object for this context.
Returns:
the SSLSessionContext object
See Also:

engineGetClientSessionContext

  1. protected abstract SSLSessionContext engineGetClientSessionContext( )
Returns a client SSLSessionContext object for this context.
Returns:
the SSLSessionContext object
See Also:

engineGetDefaultSSLParameters

  1. 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 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.
Since:
1.6

engineGetSupportedSSLParameters

  1. 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 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.
Since:
1.6