org.apache.http.conn.ManagedClientConnection |
![]() |
A client-side connection with advanced connection logic. Instances are typically obtained from a connection manager.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Obtains the current route of this connection.
| |||||||||||
Obtains the SSL session of the underlying connection, if any.
| |||||||||||
Returns the state object associated with this connection.
| |||||||||||
Indicates whether this connection is in a reusable communication state.
| |||||||||||
Indicates whether this connection is secure.
| |||||||||||
Layers a new protocol on top of a
tunnelled
connection.
| |||||||||||
Marks this connection as being in a reusable communication state.
| |||||||||||
Opens this connection according to the given route.
| |||||||||||
Sets the duration that this connection can remain idle before it is
reused.
| |||||||||||
Assigns a state object to this connection.
| |||||||||||
Indicates that a tunnel to an intermediate proxy has been established.
| |||||||||||
Indicates that a tunnel to the target has been established.
| |||||||||||
Marks this connection as not being in a reusable state.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Obtains the current route of this connection.
null
if not connected
Obtains the SSL session of the underlying connection, if any.
If this connection is open, and the underlying socket is an
SSLSocket
, the SSL session of
that socket is obtained. This is a potentially blocking operation.
Note: Whether the underlying socket is an SSL socket
can not necessarily be determined via isSecure()
.
Plain sockets may be considered secure, for example if they are
connected to a known host in the same network segment.
On the other hand, SSL sockets may be considered insecure,
for example depending on the chosen cipher suite.
null
otherwise
Returns the state object associated with this connection.
Indicates whether this connection is in a reusable communication state.
See markReusable
and
unmarkReusable
for details.
true
if this connection is marked as being in
a reusable communication state,
false
otherwise
Indicates whether this connection is secure. The return value is well-defined only while the connection is open. It may change even while the connection is open.
true
if this connection is secure,
false
otherwise
Layers a new protocol on top of a tunnelled
connection. This is typically used to create a TLS/SSL connection
through a proxy.
The route is the one previously passed to open
.
It is not guaranteed that the layered connection is
secure
.
context | the context for layering on top of this connection |
---|---|
params | the parameters for layering on top of this connection |
IOException | in case of a problem |
---|
Marks this connection as being in a reusable communication state.
The checkpoints for reuseable communication states (in the absence
of pipelining) are before sending a request and after receiving
the response in it's entirety.
The connection will automatically clear the checkpoint when
used for communication. A call to this method indicates that
the next checkpoint has been reached.
A reusable communication state is necessary but not sufficient
for the connection to be reused.
A route
mismatch, the connection being closed,
or other circumstances might prevent reuse.
Opens this connection according to the given route.
route | the route along which to open. It will be opened to the first proxy if present, or directly to the target. |
---|---|
context | the context for opening this connection |
params | the parameters for opening this connection |
IOException | in case of a problem |
---|
Sets the duration that this connection can remain idle before it is reused. The connection should not be used again if this time elapses. The idle duration must be reset after each request sent over this connection. The elapsed time starts counting when the connection is released, which is typically after the headers (and any response body, if present) is fully consumed.
Assigns a state object to this connection. Connection managers may make use of the connection state when allocating persistent connections.
state | The state object |
---|
Indicates that a tunnel to an intermediate proxy has been established.
This is used exclusively for so-called proxy chains, where
a request has to pass through multiple proxies before reaching the
target. In that case, all proxies but the last need to be tunnelled
when establishing the connection. Tunnelling of the last proxy to the
target is optional and would be indicated via tunnelTarget(boolean, HttpParams)
.
next | the proxy to which the tunnel was established.
This is not the proxy through which
the tunnel was established, but the new end point
of the tunnel. The tunnel does not yet
reach to the target, use tunnelTarget(boolean, HttpParams)
to indicate an end-to-end tunnel. |
---|---|
secure | true if the connection should be
considered secure, false otherwise |
params | the parameters for tunnelling this connection |
IOException | in case of a problem |
---|
Indicates that a tunnel to the target has been established.
The route is the one previously passed to open
.
Subsequently, layerProtocol
can be called
to layer the TLS/SSL protocol on top of the tunnelled connection.
Note: In HttpClient 3, a call to the corresponding method
would automatically trigger the layering of the TLS/SSL protocol.
This is not the case anymore, you can establish a tunnel without
layering a new protocol over the connection.
secure | true if the tunnel should be considered
secure, false otherwise |
---|---|
params | the parameters for tunnelling this connection |
IOException | in case of a problem |
---|
Marks this connection as not being in a reusable state.
This can be used immediately before releasing this connection
to prevent it's reuse. Reasons for preventing reuse include
error conditions and the evaluation of a
reuse strategy
.
Note:
It is not necessary to call here before writing to
or reading from this connection. Communication attempts will
automatically unmark the state as non-reusable. It can then
be switched back using markReusable
.