Added in API level 1

SSLSocketFactory

abstract class SSLSocketFactory : SocketFactory

kotlin.Any
↳	javax.net.SocketFactory
	↳	javax.net.ssl.SSLSocketFactory

Known Direct Subclasses SSLCertificateSocketFactory SSLCertificateSocketFactory SSLSocketFactory implementation with several extra features: Timeout specification for SSL handshake operations Hostname verification in most cases (see WARNINGs below) Optional SSL session caching with SSLSessionCache Optionally bypass all SSL certificate checks The handshake timeout does not apply to actual TCP socket connection.

SSLSocketFactorys create SSLSockets.

Summary

Public constructors
SSLSocketFactory() Constructor is used only by subclasses.

Public methods
abstract Socket!	createSocket(s: Socket!, host: String!, port: Int, autoClose: Boolean) Returns a socket layered over an existing socket connected to the named host, at the given port.
open static SocketFactory!	getDefault() Returns the default SSL socket factory.
abstract Array<String!>!	getDefaultCipherSuites() Returns the list of cipher suites which are enabled by default.
abstract Array<String!>!	getSupportedCipherSuites() Returns the names of the cipher suites which could be enabled for use on an SSL connection.

Inherited functions

From class SocketFactory Socket! createSocket() Creates an unconnected socket. Socket! createSocket(host: String!, port: Int) Creates a socket and connects it to the specified remote host at the specified remote port. This socket is configured using the socket options established for this factory. If there is a security manager, its checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException. Socket! createSocket(host: String!, port: Int, localHost: InetAddress!, localPort: Int) Creates a socket and connects it to the specified remote host on the specified remote port. The socket will also be bound to the local address and port supplied. This socket is configured using the socket options established for this factory. If there is a security manager, its checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException. Socket! createSocket(host: InetAddress!, port: Int) Creates a socket and connects it to the specified port number at the specified address. This socket is configured using the socket options established for this factory. If there is a security manager, its checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException. Socket! createSocket(address: InetAddress!, port: Int, localAddress: InetAddress!, localPort: Int) Creates a socket and connect it to the specified remote address on the specified remote port. The socket will also be bound to the local address and port suplied. The socket is configured using the socket options established for this factory. If there is a security manager, its checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException.

Public constructors

SSLSocketFactory

Added in API level 1

SSLSocketFactory()

Constructor is used only by subclasses.

Public methods

createSocket

Added in API level 1

abstract fun createSocket(
    s: Socket!, 
    host: String!, 
    port: Int, 
    autoClose: Boolean
): Socket!

Returns a socket layered over an existing socket connected to the named host, at the given port. This constructor can be used when tunneling SSL through a proxy or when negotiating the use of SSL over an existing socket. The host and port refer to the logical peer destination. This socket is configured using the socket options established for this factory.

Parameters
s	Socket!: the existing socket
host	String!: the server host
port	Int: the server port
autoClose	Boolean: close the underlying socket when this socket is closed

Return
Socket!	a socket connected to the specified host and port

Exceptions
java.io.IOException	if an I/O error occurs when creating the socket
java.lang.NullPointerException	if the parameter s is null

getDefault

Added in API level 1

open static fun getDefault(): SocketFactory!

Returns the default SSL socket factory.

The first time this method is called, the security property "ssl.SocketFactory.provider" is examined. If it is non-null, a class by that name is loaded and instantiated. If that is successful and the object is an instance of SSLSocketFactory, it is made the default SSL socket factory.

Otherwise, this method returns SSLContext.getDefault().getSocketFactory(). If that call fails, an inoperative factory is returned.

Return
SocketFactory!	the default SocketFactory

See Also

• javax.net.ssl.SSLContext#getDefault

getDefaultCipherSuites

Added in API level 1

abstract fun getDefaultCipherSuites(): Array<String!>!

Returns the list of cipher suites which are enabled by default. Unless a different list is enabled, handshaking on an SSL connection will use one of these cipher suites. The minimum quality of service for these defaults requires confidentiality protection and server authentication (that is, no anonymous cipher suites).

Return
Array<String!>!	array of the cipher suites enabled by default

See Also

• #getSupportedCipherSuites()

getSupportedCipherSuites

Added in API level 1

abstract fun getSupportedCipherSuites(): Array<String!>!

Returns the names of the cipher suites which could be enabled for use on an SSL connection. Normally, only a subset of these will actually be enabled by default, since this list may include cipher suites which do not meet quality of service requirements for those defaults. Such cipher suites are useful in specialized applications.

Applications should not blindly enable all supported cipher suites. The supported cipher suites can include signaling cipher suite values that can cause connection problems if enabled inappropriately.

The proper way to use this method is to either check if a specific cipher suite is supported via Arrays.asList(getSupportedCipherSuites()).contains(...) or to filter a desired list of cipher suites to only the supported ones via desiredSuiteSet.retainAll(Arrays.asList(getSupportedCipherSuites())).

Return
Array<String!>!	an array of cipher suite names

See Also

• #getDefaultCipherSuites()