SSLContext

SSLContext

protected SSLContext(
    contextSpi: SSLContextSpi!, 
    provider: Provider!, 
    protocol: String!)

Creates an SSLContext object.

createSSLEngine

fun createSSLEngine(): SSLEngine!

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, createSSLEngine(java.lang.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.

createSSLEngine

fun createSSLEngine(
    peerHost: String!, 
    peerPort: Int
): SSLEngine!

Creates a new 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.

getClientSessionContext

fun getClientSessionContext(): SSLSessionContext!

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.

getDefault

open static fun getDefault(): SSLContext!

Returns the default SSL context.

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.

getDefaultSSLParameters

fun getDefaultSSLParameters(): SSLParameters!

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

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

getInstance

open static fun getInstance(protocol: String!): SSLContext!

Returns a 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.

getInstance

open static fun getInstance(
    protocol: String!, 
    provider: String!
): SSLContext!

Returns a 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.

getInstance

open static fun getInstance(
    protocol: String!, 
    provider: Provider!
): SSLContext!

Returns a 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.

getProtocol

fun getProtocol(): String!

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.

getProvider

fun getProvider(): Provider!

Returns the provider of this SSLContext object.

getServerSessionContext

fun getServerSessionContext(): SSLSessionContext!

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.

getServerSocketFactory

fun getServerSocketFactory(): SSLServerSocketFactory!

Returns a ServerSocketFactory object for this context.

getSocketFactory

fun getSocketFactory(): SSLSocketFactory!

Returns a SocketFactory object for this context.

getSupportedSSLParameters

fun getSupportedSSLParameters(): SSLParameters!

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

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

init

fun init(
    km: Array<KeyManager!>!, 
    tm: Array<TrustManager!>!, 
    random: SecureRandom!
): Unit

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.)

setDefault

open static fun setDefault(context: SSLContext!): Unit

Sets the default SSL context. It will be returned by subsequent calls to getDefault. The default context must be immediately usable and not require initialization.

Developers are strongly discouraged from changing the default SSLContext as it is used as the Android default for secure communication by APIs like SSLSocketFactory#getDefault(), SSLServerSocketFactory#getDefault() and HttpsURLConnection.