@Deprecated public abstract class AbstractClientConnAdapter extends Object implements ManagedClientConnection, HttpContext
operated
to
managed
client connections.
Read and write methods are delegated to the wrapped connection.
Operations affecting the connection state have to be implemented
by derived classes. Operations for querying the connection state
are delegated to the wrapped connection if there is one, or
return a default value if there is none.
This adapter tracks the checkpoints for reusable communication states,
as indicated by markReusable
and queried by
isMarkedReusable
.
All send and receive operations will automatically clear the mark.
Connection release calls are delegated to the connection manager,
if there is one. abortConnection
will
clear the reusability mark first. The connection manager is
expected to tolerate multiple calls to the release method.
RESERVED_PREFIX
Modifier and Type | Method and Description |
---|---|
void |
abortConnection()
Deprecated.
Releases the connection without the option of keep-alive.
|
void |
bind(Socket socket)
Deprecated.
Binds this connection to the given socket.
|
void |
flush()
Deprecated.
Writes out all pending buffered data over the open connection.
|
Object |
getAttribute(String id)
Deprecated.
Obtains attribute with the given name.
|
InetAddress |
getLocalAddress()
Deprecated.
|
int |
getLocalPort()
Deprecated.
|
HttpConnectionMetrics |
getMetrics()
Deprecated.
Returns a collection of connection metrics.
|
InetAddress |
getRemoteAddress()
Deprecated.
|
int |
getRemotePort()
Deprecated.
|
Socket |
getSocket()
Deprecated.
Returns the underlying socket.
|
int |
getSocketTimeout()
Deprecated.
Returns the socket timeout value.
|
SSLSession |
getSSLSession()
Deprecated.
Obtains the SSL session of the underlying connection, if any.
|
boolean |
isMarkedReusable()
Deprecated.
Indicates whether this connection is in a reusable communication state.
|
boolean |
isOpen()
Deprecated.
Checks if this connection is open.
|
boolean |
isResponseAvailable(int timeout)
Deprecated.
Checks if response data is available from the connection.
|
boolean |
isSecure()
Deprecated.
Indicates whether this connection is secure.
|
boolean |
isStale()
Deprecated.
Checks whether this connection has gone down.
|
void |
markReusable()
Deprecated.
Marks this connection as being in a reusable communication state.
|
void |
receiveResponseEntity(HttpResponse response)
Deprecated.
Receives the next response entity available from this connection and
attaches it to an existing HttpResponse object.
|
HttpResponse |
receiveResponseHeader()
Deprecated.
Receives the request line and headers of the next response available from
this connection.
|
void |
releaseConnection()
Deprecated.
Releases the connection with the option of keep-alive.
|
Object |
removeAttribute(String id)
Deprecated.
Removes attribute with the given name from the context.
|
void |
sendRequestEntity(HttpEntityEnclosingRequest request)
Deprecated.
Sends the request entity over the connection.
|
void |
sendRequestHeader(HttpRequest request)
Deprecated.
Sends the request line and all headers over the connection.
|
void |
setAttribute(String id,
Object obj)
Deprecated.
Sets value of the attribute with the given name.
|
void |
setIdleDuration(long duration,
TimeUnit unit)
Deprecated.
Sets the duration that this connection can remain idle before it is
reused.
|
void |
setSocketTimeout(int timeout)
Deprecated.
Sets the socket timeout value.
|
void |
unmarkReusable()
Deprecated.
Marks this connection as not being in a reusable state.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRoute, getState, layerProtocol, open, setState, tunnelProxy, tunnelTarget
getId
close, shutdown
public boolean isOpen()
HttpConnection
isOpen
in interface HttpConnection
public boolean isStale()
HttpConnection
isStale
in interface HttpConnection
true
if attempts to use this connection are
likely to succeed, or false
if they are likely
to fail and this connection should be closedpublic void setSocketTimeout(int timeout)
HttpConnection
setSocketTimeout
in interface HttpConnection
timeout
- timeout value in millisecondspublic int getSocketTimeout()
HttpConnection
getSocketTimeout
in interface HttpConnection
0
if timeout is disabled or -1
if
timeout is undefined.public HttpConnectionMetrics getMetrics()
HttpConnection
getMetrics
in interface HttpConnection
public void flush() throws IOException
HttpClientConnection
flush
in interface HttpClientConnection
IOException
- in case of an I/O errorpublic boolean isResponseAvailable(int timeout) throws IOException
HttpClientConnection
isResponseAvailable
in interface HttpClientConnection
timeout
- the maximum time in milliseconds to wait for datatimeout
milliseconds.IOException
- if an error happens on the connectionpublic void receiveResponseEntity(HttpResponse response) throws HttpException, IOException
HttpClientConnection
receiveResponseEntity
in interface HttpClientConnection
response
- the response to attach the entity toHttpException
- in case of HTTP protocol violationIOException
- in case of an I/O errorpublic HttpResponse receiveResponseHeader() throws HttpException, IOException
HttpClientConnection
receiveResponseHeader
in interface HttpClientConnection
HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O errorpublic void sendRequestEntity(HttpEntityEnclosingRequest request) throws HttpException, IOException
HttpClientConnection
sendRequestEntity
in interface HttpClientConnection
request
- the request whose entity to send.HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O errorpublic void sendRequestHeader(HttpRequest request) throws HttpException, IOException
HttpClientConnection
sendRequestHeader
in interface HttpClientConnection
request
- the request whose headers to send.HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O errorpublic InetAddress getLocalAddress()
getLocalAddress
in interface HttpInetConnection
public int getLocalPort()
getLocalPort
in interface HttpInetConnection
public InetAddress getRemoteAddress()
getRemoteAddress
in interface HttpInetConnection
public int getRemotePort()
getRemotePort
in interface HttpInetConnection
public boolean isSecure()
ManagedClientConnection
isSecure
in interface HttpRoutedConnection
isSecure
in interface ManagedClientConnection
true
if this connection is secure,
false
otherwisepublic void bind(Socket socket) throws IOException
ManagedHttpClientConnection
bind
in interface ManagedHttpClientConnection
socket
- the socket to bind the connection to.IOException
public Socket getSocket()
ManagedHttpClientConnection
getSocket
in interface ManagedHttpClientConnection
public SSLSession getSSLSession()
ManagedClientConnection
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 ManagedClientConnection.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 HttpRoutedConnection
getSSLSession
in interface ManagedClientConnection
getSSLSession
in interface ManagedHttpClientConnection
null
otherwisepublic void markReusable()
ManagedClientConnection
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.
markReusable
in interface ManagedClientConnection
public void unmarkReusable()
ManagedClientConnection
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
.
unmarkReusable
in interface ManagedClientConnection
public boolean isMarkedReusable()
ManagedClientConnection
markReusable
and
unmarkReusable
for details.isMarkedReusable
in interface ManagedClientConnection
true
if this connection is marked as being in
a reusable communication state,
false
otherwisepublic void setIdleDuration(long duration, TimeUnit unit)
ManagedClientConnection
setIdleDuration
in interface ManagedClientConnection
public void releaseConnection()
ConnectionReleaseTrigger
abortConnection
for a hard release. The
connection may be reused as specified by the duration.releaseConnection
in interface ConnectionReleaseTrigger
public void abortConnection()
ConnectionReleaseTrigger
ConnectionReleaseTrigger.releaseConnection()
for a graceful release.abortConnection
in interface ConnectionReleaseTrigger
public Object getAttribute(String id)
HttpContext
getAttribute
in interface HttpContext
id
- the attribute name.null
if not set.public Object removeAttribute(String id)
HttpContext
removeAttribute
in interface HttpContext
id
- the attribute name.null
if not set.public void setAttribute(String id, Object obj)
HttpContext
setAttribute
in interface HttpContext
id
- the attribute name.obj
- the attribute value.Copyright © 2010 - 2020 Adobe. All Rights Reserved