Added in API level 1

Summary: Ctors | Methods | Inherited Methods

SSLSocketFactory

public abstract class SSLSocketFactory
extends SocketFactory

java.lang.Object
↳	javax.net.SocketFactory
	↳	javax.net.ssl.SSLSocketFactory

Known direct subclasses SSLCertificateSocketFactory SSLCertificateSocketFactory This class was deprecated in API level 29. This class has less error-prone replacements using standard APIs. To create an SSLSocket, obtain an SSLSocketFactory from SSLSocketFactory#getDefault() or SSLContext.getSocketFactory(). To verify hostnames, pass "HTTPS" to SSLParameters.setEndpointIdentificationAlgorithm(String). To enable ALPN, use SSLParameters.setApplicationProtocols(String[]). To enable SNI, use SSLParameters.setServerNames(java.util.List).

---

SSLSocketFactorys create SSLSockets.

See also:

• SSLSocket

Summary

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

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

Inherited methods
From class javax.net.SocketFactory abstract Socket createSocket(String host, int port) Creates a socket and connects it to the specified remote host at the specified remote port. abstract Socket createSocket(InetAddress host, int port) Creates a socket and connects it to the specified port number at the specified address. abstract Socket createSocket(InetAddress address, int port, InetAddress localAddress, int localPort) Creates a socket and connect it to the specified remote address on the specified remote port. abstract Socket createSocket(String host, int port, InetAddress localHost, int localPort) Creates a socket and connects it to the specified remote host on the specified remote port. Socket createSocket() Creates an unconnected socket. static SocketFactory getDefault() Returns a copy of the environment's default socket factory.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

SSLSocketFactory

Added in API level 1

public SSLSocketFactory ()

Constructor is used only by subclasses.

Public methods

createSocket

Added in API level 1

public abstract Socket createSocket (Socket s, 
                String host, 
                int port, 
                boolean autoClose)

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

Returns
Socket	a socket connected to the specified host and port

Throws
IOException	if an I/O error occurs when creating the socket
NullPointerException	if the parameter s is null

getDefault

Added in API level 1

public static SocketFactory getDefault ()

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.

Returns
SocketFactory	the default SocketFactory

See also:

• SSLContext.getDefault()

getDefaultCipherSuites

Added in API level 1

public abstract String[] getDefaultCipherSuites ()

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

Returns
String[]	array of the cipher suites enabled by default

See also:

• getSupportedCipherSuites()

getSupportedCipherSuites

Added in API level 1

public abstract String[] getSupportedCipherSuites ()

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

Returns
String[]	an array of cipher suite names

See also:

• getDefaultCipherSuites()