Apache HttpClient 4.5.14 · org.apache.http.conn.scheme.SocketFactory

Method Summary

Modifier and Type	Method and Description
public Socket	Returns: the connected socket. The returned object may be different from the `sock` argument if this factory supports a layered protocol. connectSocket(Socket the socket to connect, as obtained from `createSocket`. `null` indicates that a new socket should be created and connected. sock, String the host to connect to host, int the port to connect to on the host port, InetAddress the local address to bind the socket to, or `null` for any localAddress, int the port on the local machine, 0 or a negative number for any localPort, HttpParams additional `parameters` for connecting params) Deprecated as a consequence of `HttpParams` being deprecated. Connects a socket to the given host.
public Socket	Returns: a new socket createSocket() Creates a new, unconnected socket.
public boolean	Returns: `true` if the connection of the socket should be considered secure, or `false` if it should not isSecure(Socket the connected socket to check sock) Checks whether a socket provides a secure connection.

Method Detail

connectSocket back to summary

connectSocket	back to summary
public Socket connectSocket(Socket sock, String host, int port, InetAddress localAddress, int localPort, HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException Deprecated as a consequence of `HttpParams` being deprecated. See corresponding docs for further information. 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 Returns:Socket the connected socket. The returned object may be different from the `sock` argument if this factory supports a layered protocol. Exceptions IOException: if an I/O error occurs UnknownHostException: if the IP address of the target host can not be determined ConnectTimeoutException: if the socket cannot be connected within the time limit defined in the `params`

public Socket connectSocket(Socket sock, String host, int port, InetAddress localAddress, int localPort, HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

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

Returns:Socket

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

Exceptions

IOException:: if an I/O error occurs
UnknownHostException:: if the IP address of the target host can not be determined
ConnectTimeoutException:: if the socket cannot be connected within the time limit defined in the params

createSocket back to summary

createSocket	back to summary
public Socket createSocket() throws IOException Creates a new, unconnected socket. The socket should subsequently be passed to `connectSocket`. Returns:Socket a new socket Exceptions IOException: if an I/O error occurs while creating the socket

public Socket createSocket() throws IOException

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

Returns:Socket

a new socket

Exceptions

IOException:: if an I/O error occurs while creating the socket

isSecure back to summary

isSecure	back to summary
public boolean isSecure(Socket sock) throws IllegalArgumentException 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 cipher suite chosen for the connection. Parameters sock:Socket the connected socket to check Returns:boolean `true` if the connection of the socket should be considered secure, or `false` if it should not Exceptions 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.

public boolean isSecure(Socket sock) throws IllegalArgumentException

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 cipher suite chosen for the connection.

Parameters

sock:Socket: the connected socket to check

Returns:boolean

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

Exceptions

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.

public Interface SocketFactory

Method Summary

Method Detail