Package org.apache.hc.client5.http.io

Class ConnectionEndpoint

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, org.apache.hc.core5.io.ModalCloseable
    Direct Known Subclasses:
    BasicHttpClientConnectionManager.InternalConnectionEndpoint, PoolingHttpClientConnectionManager.InternalConnectionEndpoint
    @Contract(threading=SAFE)
public abstract class ConnectionEndpoint
extends java.lang.Object
implements org.apache.hc.core5.io.ModalCloseable
    Client endpoint leased from a connection manager. Client points can be used to execute HTTP requests.

    Once the endpoint is no longer needed it MUST be released with ModalCloseable.close(org.apache.hc.core5.io.CloseMode) )}.

    Since:
    5.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract org.apache.hc.core5.http.ClassicHttpResponse execute​(java.lang.String id, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.impl.io.HttpRequestExecutor executor, org.apache.hc.core5.http.protocol.HttpContext context)
      Executes HTTP request using the provided request executor.
      abstract boolean isConnected()
      Determines if the connection to the remote endpoint is still open and valid.
      abstract void setSocketTimeout​(org.apache.hc.core5.util.Timeout timeout)
      Sets the socket timeout value.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.io.Closeable

        close

      • Methods inherited from interface org.apache.hc.core5.io.ModalCloseable

        close

    • Constructor Detail

      • ConnectionEndpoint

        public ConnectionEndpoint()

    • Method Detail

      • execute

        public abstract org.apache.hc.core5.http.ClassicHttpResponse execute​(java.lang.String id,
                                                                     org.apache.hc.core5.http.ClassicHttpRequest request,
                                                                     org.apache.hc.core5.http.impl.io.HttpRequestExecutor executor,
                                                                     org.apache.hc.core5.http.protocol.HttpContext context)
                                                              throws java.io.IOException,
                                                                     org.apache.hc.core5.http.HttpException
        Executes HTTP request using the provided request executor.

        Once the endpoint is no longer needed it MUST be released with ModalCloseable.close(org.apache.hc.core5.io.CloseMode).

        Parameters:
        id - unique operation ID or null.
        request - the request message.
        executor - the request executor.
        context - the execution context.
        Throws:
        java.io.IOException
        org.apache.hc.core5.http.HttpException

      • isConnected

        public abstract boolean isConnected()
        Determines if the connection to the remote endpoint is still open and valid.

      • setSocketTimeout

        public abstract void setSocketTimeout​(org.apache.hc.core5.util.Timeout timeout)
        Sets the socket timeout value.
        Parameters:
        timeout - timeout value