Package org.apache.http.impl.conn

Class AbstractClientConnAdapter

    • Method Detail

      • isOpen

        public boolean isOpen()
        Deprecated.
        Description copied from interface: HttpConnection
        Checks if this connection is open.
        Specified by:
        isOpen in interface HttpConnection
        Returns:
        true if it is open, false if it is closed.

      • isStale

        public boolean isStale()
        Deprecated.
        Description copied from interface: HttpConnection
        Checks whether this connection has gone down. Network connections may get closed during some time of inactivity for several reasons. The next time a read is attempted on such a connection it will throw an IOException. This method tries to alleviate this inconvenience by trying to find out if a connection is still usable. Implementations may do that by attempting a read with a very small timeout. Thus this method may block for a small amount of time before returning a result. It is therefore an expensive operation.
        Specified by:
        isStale in interface HttpConnection
        Returns:
        true if attempts to use this connection are likely to succeed, or false if they are likely to fail and this connection should be closed

      • setSocketTimeout

        public void setSocketTimeout​(int timeout)
        Deprecated.
        Description copied from interface: HttpConnection
        Sets the socket timeout value.
        Specified by:
        setSocketTimeout in interface HttpConnection
        Parameters:
        timeout - timeout value in milliseconds

      • getSocketTimeout

        public int getSocketTimeout()
        Deprecated.
        Description copied from interface: HttpConnection
        Returns the socket timeout value.
        Specified by:
        getSocketTimeout in interface HttpConnection
        Returns:
        positive value in milliseconds if a timeout is set, 0 if timeout is disabled or -1 if timeout is undefined.

      • flush

        public void flush()
           throws java.io.IOException
        Deprecated.
        Description copied from interface: HttpClientConnection
        Writes out all pending buffered data over the open connection.
        Specified by:
        flush in interface HttpClientConnection
        Throws:
        java.io.IOException - in case of an I/O error

      • isResponseAvailable

        public boolean isResponseAvailable​(int timeout)
                            throws java.io.IOException
        Deprecated.
        Description copied from interface: HttpClientConnection
        Checks if response data is available from the connection. May wait for the specified time until some data becomes available. Note that some implementations may completely ignore the timeout parameter.
        Specified by:
        isResponseAvailable in interface HttpClientConnection
        Parameters:
        timeout - the maximum time in milliseconds to wait for data
        Returns:
        true if data is available; false if there was no data available even after waiting for timeout milliseconds.
        Throws:
        java.io.IOException - if an error happens on the connection

      • receiveResponseEntity

        public void receiveResponseEntity​(HttpResponse response)
                           throws HttpException,
                                  java.io.IOException
        Deprecated.
        Description copied from interface: HttpClientConnection
        Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
        Specified by:
        receiveResponseEntity in interface HttpClientConnection
        Parameters:
        response - the response to attach the entity to
        Throws:
        HttpException - in case of HTTP protocol violation
        java.io.IOException - in case of an I/O error

      • receiveResponseHeader

        public HttpResponse receiveResponseHeader()
                                   throws HttpException,
                                          java.io.IOException
        Deprecated.
        Description copied from interface: HttpClientConnection
        Receives the request line and headers of the next response available from this connection. The caller should examine the HttpResponse object to find out if it should try to receive a response entity as well.
        Specified by:
        receiveResponseHeader in interface HttpClientConnection
        Returns:
        a new HttpResponse object with status line and headers initialized.
        Throws:
        HttpException - in case of HTTP protocol violation
        java.io.IOException - in case of an I/O error

      • sendRequestHeader

        public void sendRequestHeader​(HttpRequest request)
                       throws HttpException,
                              java.io.IOException
        Deprecated.
        Description copied from interface: HttpClientConnection
        Sends the request line and all headers over the connection.
        Specified by:
        sendRequestHeader in interface HttpClientConnection
        Parameters:
        request - the request whose headers to send.
        Throws:
        HttpException - in case of HTTP protocol violation
        java.io.IOException - in case of an I/O error

      • isSecure

        public boolean isSecure()
        Deprecated.
        Description copied from interface: ManagedClientConnection
        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.
        Specified by:
        isSecure in interface HttpRoutedConnection
        Specified by:
        isSecure in interface ManagedClientConnection
        Returns:
        true if this connection is secure, false otherwise

      • bind

        public void bind​(java.net.Socket socket)
          throws java.io.IOException
        Deprecated.
        Description copied from interface: ManagedHttpClientConnection
        Binds this connection to the given socket. The connection is considered open if it is bound and the underlying socket is connection to a remote host.
        Specified by:
        bind in interface ManagedHttpClientConnection
        Parameters:
        socket - the socket to bind the connection to.
        Throws:
        java.io.IOException

      • getSSLSession

        public javax.net.ssl.SSLSession getSSLSession()
        Deprecated.
        Description copied from interface: ManagedClientConnection
        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 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.

        Specified by:
        getSSLSession in interface HttpRoutedConnection
        Specified by:
        getSSLSession in interface ManagedClientConnection
        Specified by:
        getSSLSession in interface ManagedHttpClientConnection
        Returns:
        the underlying SSL session if available, null otherwise

      • markReusable

        public void markReusable()
        Deprecated.
        Description copied from interface: ManagedClientConnection
        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 its 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.

        Specified by:
        markReusable in interface ManagedClientConnection

      • unmarkReusable

        public void unmarkReusable()
        Deprecated.
        Description copied from interface: ManagedClientConnection
        Marks this connection as not being in a reusable state. This can be used immediately before releasing this connection to prevent its 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.

        Specified by:
        unmarkReusable in interface ManagedClientConnection

      • setIdleDuration

        public void setIdleDuration​(long duration,
                            java.util.concurrent.TimeUnit unit)
        Deprecated.
        Description copied from interface: ManagedClientConnection
        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.
        Specified by:
        setIdleDuration in interface ManagedClientConnection

      • releaseConnection

        public void releaseConnection()
        Deprecated.
        Description copied from interface: ConnectionReleaseTrigger
        Releases the connection with the option of keep-alive. This is a "graceful" release and may cause IO operations for consuming the remainder of a response entity. Use abortConnection for a hard release. The connection may be reused as specified by the duration.
        Specified by:
        releaseConnection in interface ConnectionReleaseTrigger

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String id)
        Deprecated.
        Description copied from interface: HttpContext
        Obtains attribute with the given name.
        Specified by:
        getAttribute in interface HttpContext
        Parameters:
        id - the attribute name.
        Returns:
        attribute value, or null if not set.

      • removeAttribute

        public java.lang.Object removeAttribute​(java.lang.String id)
        Deprecated.
        Description copied from interface: HttpContext
        Removes attribute with the given name from the context.
        Specified by:
        removeAttribute in interface HttpContext
        Parameters:
        id - the attribute name.
        Returns:
        attribute value, or null if not set.

      • setAttribute

        public void setAttribute​(java.lang.String id,
                         java.lang.Object obj)
        Deprecated.
        Description copied from interface: HttpContext
        Sets value of the attribute with the given name.
        Specified by:
        setAttribute in interface HttpContext
        Parameters:
        id - the attribute name.
        obj - the attribute value.