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

Modifier and Type	Field and Description
private final SchemeSocketFactory	factory Deprecated as a consequence of `SchemeSocketFactory` being deprecated.

Access	Constructor and Description
pack-priv	SocketFactoryAdaptor(final SchemeSocketFactory factory) Deprecated as a consequence of `SchemeSocketFactory` being deprecated.

Method Summary

Modifier and Type	Method and Description
public Socket	connectSocket(final Socket the socket to connect, as obtained from `createSocket`. `null` indicates that a new socket should be created and connected. socket, final String the host to connect to host, final int the port to connect to on the host port, final InetAddress the local address to bind the socket to, or `null` for any localAddress, final int the port on the local machine, 0 or a negative number for any localPort, final HttpParams additional `parameters` for connecting params) Implements org.apache.http.conn.scheme.SocketFactory.connectSocket. Deprecated as a consequence of `HttpParams` being deprecated. Connects a socket to the given host.
public Socket	createSocket() Implements org.apache.http.conn.scheme.SocketFactory.createSocket. Creates a new, unconnected socket.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public SchemeSocketFactory	getFactory() Deprecated as a consequence of `SchemeSocketFactory` being deprecated.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isSecure(final Socket the connected socket to check socket) Implements org.apache.http.conn.scheme.SocketFactory.isSecure. Checks whether a socket provides a secure connection.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

factory	back to summary
private final SchemeSocketFactory factory Deprecated as a consequence of `SchemeSocketFactory` being deprecated. See corresponding docs for further information.

SocketFactoryAdaptor	back to summary
pack-priv SocketFactoryAdaptor(final SchemeSocketFactory factory) Deprecated as a consequence of `SchemeSocketFactory` being deprecated. See corresponding docs for further information.

Method Detail

connectSocket back to summary

connectSocket	back to summary
public Socket connectSocket(final Socket socket, final String host, final int port, final InetAddress localAddress, final int localPort, final HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException Implements org.apache.http.conn.scheme.SocketFactory.connectSocket. Doc from org.apache.http.conn.scheme.SocketFactory.connectSocket. Deprecated as a consequence of `HttpParams` being deprecated. See corresponding docs for further information. Connects a socket to the given host. Parameters socket: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. Annotations @Override 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(final Socket socket, final String host, final int port, final InetAddress localAddress, final int localPort, final HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException

Implements org.apache.http.conn.scheme.SocketFactory.connectSocket.

Doc from org.apache.http.conn.scheme.SocketFactory.connectSocket.

Deprecated

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

Connects a socket to the given host.

Parameters

socket: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.

Annotations

@Override

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 Implements org.apache.http.conn.scheme.SocketFactory.createSocket. Doc from org.apache.http.conn.scheme.SocketFactory.createSocket. Creates a new, unconnected socket. The socket should subsequently be passed to `connectSocket`. Returns:Socket a new socket Annotations @Override Exceptions IOException: if an I/O error occurs while creating the socket

public Socket createSocket() throws IOException

Implements org.apache.http.conn.scheme.SocketFactory.createSocket.

Doc from org.apache.http.conn.scheme.SocketFactory.createSocket.

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

Returns:Socket

a new socket

Annotations

@Override

Exceptions

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

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getFactory	back to summary
public SchemeSocketFactory getFactory() Deprecated as a consequence of `SchemeSocketFactory` being deprecated. See corresponding docs for further information.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isSecure back to summary

isSecure	back to summary
public boolean isSecure(final Socket socket) throws IllegalArgumentException Implements org.apache.http.conn.scheme.SocketFactory.isSecure. Doc from org.apache.http.conn.scheme.SocketFactory.isSecure. 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 socket: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 Annotations @Override 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(final Socket socket) throws IllegalArgumentException

Implements org.apache.http.conn.scheme.SocketFactory.isSecure.

Doc from org.apache.http.conn.scheme.SocketFactory.isSecure.

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

socket: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

Annotations

@Override

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.

pack-priv Class SocketFactoryAdaptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail