Added in API level 1

SSLSocketFactory

public abstract class SSLSocketFactory
extends SocketFactory

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


SSLSocketFactorys create SSLSockets.

See also:

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

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

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

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