Added in API level 1
Deprecated in API level 22

SocketFactory

interface SocketFactory

org.apache.http.conn.scheme.SocketFactory

Known Direct Subclasses

LayeredSocketFactory

A SocketFactory for layered sockets (SSL/TLS).

Known Indirect Subclasses

SSLSocketFactory

Layered socket factory for TLS/SSL connections, based on JSSE.

A factory for creating and connecting sockets. The factory encapsulates the logic for establishing a socket connection.
Both Object.equals() and Object.hashCode() must be overridden for the correct operation of some connection managers.

Summary

Public methods
abstract Socket!	`connectSocket(sock: Socket!, host: String!, port: Int, localAddress: InetAddress!, localPort: Int, params: HttpParams!)` Connects a socket to the given host.
abstract Socket!	`createSocket()` Creates a new, unconnected socket.
abstract Boolean	`isSecure(sock: Socket!)` Checks whether a socket provides a secure connection.

Public methods

connectSocket

Added in API level 1

abstract fun connectSocket(
    sock: Socket!, 
    host: String!, 
    port: Int, 
    localAddress: InetAddress!, 
    localPort: Int, 
    params: HttpParams!
): Socket!

Deprecated: Deprecated in Java.

Connects a socket to the given host.

Parameters
`sock`	Socket!: the socket to connect, as obtained from `createSocket`. `null` indicates that a new socket should be created and connected.
`host`	String!: the host to connect to
`port`	Int: the port to connect to on the host
`localAddress`	InetAddress!: the local address to bind the socket to, or `null` for any
`localPort`	Int: the port on the local machine, 0 or a negative number for any
`params`	HttpParams!: additional `parameters` for connecting

Return
`Socket!`	the connected socket. The returned object may be different from the `sock` argument if this factory supports a layered protocol.

Exceptions
`java.io.IOException`	if an I/O error occurs
`java.net.UnknownHostException`	if the IP address of the target host can not be determined
`org.apache.http.conn.ConnectTimeoutException`	if the socket cannot be connected within the time limit defined in the `params`

createSocket

Added in API level 1

abstract fun createSocket(): Socket!

Deprecated: Deprecated in Java.

Creates a new, unconnected socket. The socket should subsequently be passed to connectSocket.

Return
`Socket!`	a new socket

Exceptions
`java.io.IOException`	if an I/O error occurs while creating the socket

isSecure

Added in API level 1

abstract fun isSecure(sock: Socket!): Boolean

Deprecated: Deprecated in Java.

Checks whether a socket provides a secure connection. The socket must be connected by this factory. The factory will not perform I/O operations in this method.
As a rule of thumb, plain sockets are not secure and TLS/SSL sockets are secure. However, there may be application specific deviations. For example, a plain socket to a host in the same intranet ("trusted zone") could be considered secure. On the other hand, a TLS/SSL socket could be considered insecure based on the cypher suite chosen for the connection.

Parameters
`sock`	Socket!: the connected socket to check

Return
`Boolean`	`true` if the connection of the socket should be considered secure, or `false` if it should not

Exceptions
`java.lang.IllegalArgumentException`	if the argument is invalid, for example because it is not a connected socket or was created by a different socket factory. Note that socket factories are not required to check these conditions, they may simply return a default value when called with an invalid socket argument.