public interface ManagedClientConnection extends HttpClientConnection, HttpRoutedConnection, ConnectionReleaseTrigger
| Modifier and Type | Method and Description |
|---|---|
HttpRoute |
getRoute()
Obtains the current route of this connection.
|
SSLSession |
getSSLSession()
Obtains the SSL session of the underlying connection, if any.
|
Object |
getState()
Returns the state object associated with this connection.
|
boolean |
isMarkedReusable()
Indicates whether this connection is in a reusable communication state.
|
boolean |
isSecure()
Indicates whether this connection is secure.
|
void |
layerProtocol(HttpContext context,
HttpParams params)
Layers a new protocol on top of a
tunnelled
connection. |
void |
markReusable()
Marks this connection as being in a reusable communication state.
|
void |
open(HttpRoute route,
HttpContext context,
HttpParams params)
Opens this connection according to the given route.
|
void |
setIdleDuration(long duration,
TimeUnit unit)
Sets the duration that this connection can remain idle before it is
reused.
|
void |
setState(Object state)
Assigns a state object to this connection.
|
void |
tunnelProxy(HttpHost next,
boolean secure,
HttpParams params)
Indicates that a tunnel to an intermediate proxy has been established.
|
void |
tunnelTarget(boolean secure,
HttpParams params)
Indicates that a tunnel to the target has been established.
|
void |
unmarkReusable()
Marks this connection as not being in a reusable state.
|
flush, isResponseAvailable, receiveResponseEntity, receiveResponseHeader, sendRequestEntity, sendRequestHeadergetLocalAddress, getLocalPort, getRemoteAddress, getRemotePortclose, getMetrics, getSocketTimeout, isOpen, isStale, setSocketTimeout, shutdownabortConnection, releaseConnectionboolean isSecure()
isSecure in interface HttpRoutedConnectiontrue if this connection is secure,
false otherwiseHttpRoute getRoute()
getRoute in interface HttpRoutedConnectionnull if not connectedSSLSession getSSLSession()
SSLSocket, the SSL session of
that socket is obtained. This is a potentially blocking operation.
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.getSSLSession in interface HttpRoutedConnectionnull otherwisevoid open(HttpRoute route, HttpContext context, HttpParams params) throws IOException
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 connectionparams - the parameters for opening this connectionIOException - in case of a problemvoid tunnelTarget(boolean secure,
HttpParams params)
throws IOException
open.
Subsequently, layerProtocol can be called
to layer the TLS/SSL protocol on top of the tunnelled connection.
secure - true if the tunnel should be considered
secure, false otherwiseparams - the parameters for tunnelling this connectionIOException - in case of a problemvoid tunnelProxy(HttpHost next, boolean secure, HttpParams params) throws IOException
tunnelTarget(boolean, org.apache.http.params.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, org.apache.http.params.HttpParams)
to indicate an end-to-end tunnel.secure - true if the connection should be
considered secure, false otherwiseparams - the parameters for tunnelling this connectionIOException - in case of a problemvoid layerProtocol(HttpContext context, HttpParams params) throws IOException
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 connectionparams - the parameters for layering on top of this connectionIOException - in case of a problemvoid markReusable()
route mismatch, the connection being closed,
or other circumstances might prevent reuse.void unmarkReusable()
reuse strategy.
markReusable.boolean isMarkedReusable()
markReusable and
unmarkReusable for details.true if this connection is marked as being in
a reusable communication state,
false otherwisevoid setState(Object state)
state - The state objectObject getState()
void setIdleDuration(long duration,
TimeUnit unit)
Copyright © 1999–2013 The Apache Software Foundation. All rights reserved.