Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.nio.DefaultManagedAsyncClientConnection

Modifier and Type	Field and Description
private final AtomicBoolean	closed
private final IOSession	ioSession
private static final Logger	LOG
private final Timeout	socketTimeout

Access	Constructor and Description
public	DefaultManagedAsyncClientConnection(final IOSession ioSession)

Method Summary

Modifier and Type	Method and Description
public void	activate() Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.activate. Restores the connection from idle mode.
public void	close(final CloseMode How to close the receiver. closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it.
public void	close() Implements org.apache.hc.core5.http.HttpConnection.close. Closes this connection gracefully.
public EndpointDetails	getEndpointDetails() Implements org.apache.hc.core5.http.HttpConnection.getEndpointDetails. Returns this connection's endpoint details.
public String	getId() Implements org.apache.hc.core5.util.Identifiable.getId.
public SocketAddress	getLocalAddress() Implements org.apache.hc.core5.http.HttpConnection.getLocalAddress. Returns this connection's local address or `null` if it is not bound yet.
public ProtocolVersion	getProtocolVersion() Implements org.apache.hc.core5.http.HttpConnection.getProtocolVersion. Returns this connection's protocol version or `null` if unknown.
public SocketAddress	getRemoteAddress() Implements org.apache.hc.core5.http.HttpConnection.getRemoteAddress. Returns this connection's remote address or `null` if it is not connected yet or unconnected.
public Timeout	getSocketTimeout() Implements org.apache.hc.core5.http.SocketModalCloseable.getSocketTimeout. Returns the socket timeout value.
public SSLSession	getSSLSession() Implements org.apache.hc.core5.http.HttpConnection.getSSLSession. Returns this connection's SSL session or `null` if TLS has not been activated.
public TlsDetails	getTlsDetails() Implements org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.getTlsDetails. Returns details of a fully established TLS session.
public boolean	isOpen() Implements org.apache.hc.core5.http.HttpConnection.isOpen. Checks if this connection is open.
public void	passivate() Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.passivate. Puts the connection into idle mode.
public void	setSocketTimeout(final Timeout timeout value timeout) Implements org.apache.hc.core5.http.SocketModalCloseable.setSocketTimeout. Sets the socket timeout value.
public void	startTls(final SSLContext SSL context to be used for this session. sslContext, final NamedEndpoint optional endpoint details for outgoing client side connections. endpoint, final SSLBufferMode SSL buffer management mode. sslBufferMode, final SSLSessionInitializer SSL session initialization callback. initializer, final SSLSessionVerifier SSL session verification callback. verifier, final Timeout the timeout to use while performing the TLS handshake; may be `null`. handshakeTimeout, final FutureCallback<TransportSecurityLayer> callback) Overrides default org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls. Starts TLS session over an existing network connection with the given SSL context.
public void	startTls(final SSLContext SSL context to be used for this session. sslContext, final NamedEndpoint optional endpoint details for outgoing client side connections. endpoint, final SSLBufferMode SSL buffer management mode. sslBufferMode, final SSLSessionInitializer SSL session initialization callback. initializer, final SSLSessionVerifier SSL session verification callback. verifier, final Timeout the timeout to use while performing the TLS handshake; may be `null`. handshakeTimeout) Implements org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls. Starts TLS session over an existing network connection with the given SSL context.
public void	submitCommand(final Command the command to be executed. command, final Command.Priority the command priority. priority) Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.submitCommand. Submits the given command for execution.
public void	switchProtocol(final String the application protocol ID protocolId, final FutureCallback<ProtocolIOSession> the result callback callback) Overrides default org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.switchProtocol. Switches this I/O session to the application protocol with the given ID.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

closed	back to summary
private final AtomicBoolean closed

ioSession	back to summary
private final IOSession ioSession

LOG	back to summary
private static final Logger LOG

socketTimeout	back to summary
private final Timeout socketTimeout

DefaultManagedAsyncClientConnection	back to summary
public DefaultManagedAsyncClientConnection(final IOSession ioSession)

Method Detail

activate	back to summary
public void activate() Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.activate. Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.activate. Restores the connection from idle mode. Annotations @Override

activate

back to summary

public void activate()

Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.activate.

Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.activate.

Restores the connection from idle mode.

Annotations

@Override

close	back to summary
public void close(final CloseMode closeMode) Implements org.apache.hc.core5.io.ModalCloseable.close. Doc from org.apache.hc.core5.io.ModalCloseable.close. Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect. Parameters closeMode:CloseMode How to close the receiver. Annotations @Override

back to summary

public void close(final CloseMode closeMode)

Implements org.apache.hc.core5.io.ModalCloseable.close.

Doc from org.apache.hc.core5.io.ModalCloseable.close.

Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.

Parameters

closeMode:CloseMode: How to close the receiver.

Annotations

@Override

close back to summary

close	back to summary
public void close() throws IOException Implements org.apache.hc.core5.http.HttpConnection.close. Doc from org.apache.hc.core5.http.HttpConnection.close. Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use `shutdown` instead. Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

public void close() throws IOException

Implements org.apache.hc.core5.http.HttpConnection.close.

Doc from org.apache.hc.core5.http.HttpConnection.close.

Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use shutdown instead.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

getEndpointDetails	back to summary
public EndpointDetails getEndpointDetails() Implements org.apache.hc.core5.http.HttpConnection.getEndpointDetails. Doc from org.apache.hc.core5.http.HttpConnection.getEndpointDetails. Returns this connection's endpoint details. Returns:EndpointDetails this connection's endpoint details. Annotations @Override

getEndpointDetails

back to summary

public EndpointDetails getEndpointDetails()

Implements org.apache.hc.core5.http.HttpConnection.getEndpointDetails.

Doc from org.apache.hc.core5.http.HttpConnection.getEndpointDetails.

Returns this connection's endpoint details.

Returns:EndpointDetails

this connection's endpoint details.

Annotations

@Override

getId	back to summary
public String getId() Implements org.apache.hc.core5.util.Identifiable.getId. Annotations @Override

getId

back to summary

public String getId()

Implements org.apache.hc.core5.util.Identifiable.getId.

Annotations

@Override

getLocalAddress back to summary

getLocalAddress	back to summary
public SocketAddress getLocalAddress() Implements org.apache.hc.core5.http.HttpConnection.getLocalAddress. Doc from org.apache.hc.core5.http.HttpConnection.getLocalAddress. Returns this connection's local address or `null` if it is not bound yet. Returns:SocketAddress this connection's local address or `null` if it is not bound yet. Annotations @Override

public SocketAddress getLocalAddress()

Implements org.apache.hc.core5.http.HttpConnection.getLocalAddress.

Doc from org.apache.hc.core5.http.HttpConnection.getLocalAddress.

Returns this connection's local address or null if it is not bound yet.

Returns:SocketAddress

this connection's local address or null if it is not bound yet.

Annotations

@Override

getProtocolVersion back to summary

getProtocolVersion	back to summary
public ProtocolVersion getProtocolVersion() Implements org.apache.hc.core5.http.HttpConnection.getProtocolVersion. Doc from org.apache.hc.core5.http.HttpConnection.getProtocolVersion. Returns this connection's protocol version or `null` if unknown. Returns:ProtocolVersion this connection's protocol version or `null` if unknown. Annotations @Override

public ProtocolVersion getProtocolVersion()

Implements org.apache.hc.core5.http.HttpConnection.getProtocolVersion.

Doc from org.apache.hc.core5.http.HttpConnection.getProtocolVersion.

Returns this connection's protocol version or null if unknown.

Returns:ProtocolVersion

this connection's protocol version or null if unknown.

Annotations

@Override

getRemoteAddress back to summary

getRemoteAddress	back to summary
public SocketAddress getRemoteAddress() Implements org.apache.hc.core5.http.HttpConnection.getRemoteAddress. Doc from org.apache.hc.core5.http.HttpConnection.getRemoteAddress. Returns this connection's remote address or `null` if it is not connected yet or unconnected. Returns:SocketAddress this connection's remote address or `null` if it is not connected yet or unconnected. Annotations @Override

public SocketAddress getRemoteAddress()

Implements org.apache.hc.core5.http.HttpConnection.getRemoteAddress.

Doc from org.apache.hc.core5.http.HttpConnection.getRemoteAddress.

Returns this connection's remote address or null if it is not connected yet or unconnected.

Returns:SocketAddress

this connection's remote address or null if it is not connected yet or unconnected.

Annotations

@Override

getSocketTimeout	back to summary
public Timeout getSocketTimeout() Implements org.apache.hc.core5.http.SocketModalCloseable.getSocketTimeout. Doc from org.apache.hc.core5.http.SocketModalCloseable.getSocketTimeout. Returns the socket timeout value. Returns:Timeout timeout value. Annotations @Override

getSocketTimeout

back to summary

public Timeout getSocketTimeout()

Implements org.apache.hc.core5.http.SocketModalCloseable.getSocketTimeout.

Doc from org.apache.hc.core5.http.SocketModalCloseable.getSocketTimeout.

Returns the socket timeout value.

Returns:Timeout

timeout value.

Annotations

@Override

getSSLSession back to summary

getSSLSession	back to summary
public SSLSession getSSLSession() Implements org.apache.hc.core5.http.HttpConnection.getSSLSession. Doc from org.apache.hc.core5.http.HttpConnection.getSSLSession. Returns this connection's SSL session or `null` if TLS has not been activated. Returns:SSLSession this connection's SSL session or `null` if TLS has not been activated. Annotations @Override

public SSLSession getSSLSession()

Implements org.apache.hc.core5.http.HttpConnection.getSSLSession.

Doc from org.apache.hc.core5.http.HttpConnection.getSSLSession.

Returns this connection's SSL session or null if TLS has not been activated.

Returns:SSLSession

this connection's SSL session or null if TLS has not been activated.

Annotations

@Override

getTlsDetails	back to summary
public TlsDetails getTlsDetails() Implements org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.getTlsDetails. Doc from org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.getTlsDetails. Returns details of a fully established TLS session. Returns:TlsDetails TLS session details. Annotations @Override

getTlsDetails

back to summary

public TlsDetails getTlsDetails()

Implements org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.getTlsDetails.

Doc from org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.getTlsDetails.

Returns details of a fully established TLS session.

Returns:TlsDetails

TLS session details.

Annotations

@Override

isOpen	back to summary
public boolean isOpen() Implements org.apache.hc.core5.http.HttpConnection.isOpen. Doc from org.apache.hc.core5.http.HttpConnection.isOpen. Checks if this connection is open. Returns:boolean true if it is open, false if it is closed. Annotations @Override

isOpen

back to summary

public boolean isOpen()

Implements org.apache.hc.core5.http.HttpConnection.isOpen.

Doc from org.apache.hc.core5.http.HttpConnection.isOpen.

Checks if this connection is open.

Returns:boolean

true if it is open, false if it is closed.

Annotations

@Override

passivate	back to summary
public void passivate() Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.passivate. Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.passivate. Puts the connection into idle mode. Annotations @Override

passivate

back to summary

public void passivate()

Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.passivate.

Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.passivate.

Puts the connection into idle mode.

Annotations

@Override

setSocketTimeout	back to summary
public void setSocketTimeout(final Timeout timeout) Implements org.apache.hc.core5.http.SocketModalCloseable.setSocketTimeout. Doc from org.apache.hc.core5.http.SocketModalCloseable.setSocketTimeout. Sets the socket timeout value. Parameters timeout:Timeout timeout value Annotations @Override

setSocketTimeout

back to summary

public void setSocketTimeout(final Timeout timeout)

Implements org.apache.hc.core5.http.SocketModalCloseable.setSocketTimeout.

Doc from org.apache.hc.core5.http.SocketModalCloseable.setSocketTimeout.

Sets the socket timeout value.

Parameters

timeout:Timeout: timeout value

Annotations

@Override

startTls back to summary

startTls	back to summary
public void startTls(final SSLContext sslContext, final NamedEndpoint endpoint, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout, final FutureCallback<TransportSecurityLayer> callback) throws UnsupportedOperationException Overrides default org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls. Doc from org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls. Starts TLS session over an existing network connection with the given SSL context. `NamedEndpoint` details are applicable for client side connections and are used for host name verification, when supported by the SSL engine. Parameters sslContext:SSLContext SSL context to be used for this session. endpoint:NamedEndpoint optional endpoint details for outgoing client side connections. sslBufferMode:SSLBufferMode SSL buffer management mode. initializer:SSLSessionInitializer SSL session initialization callback. verifier:SSLSessionVerifier SSL session verification callback. handshakeTimeout:Timeout the timeout to use while performing the TLS handshake; may be `null`. Annotations @Override

public void startTls(final SSLContext sslContext, final NamedEndpoint endpoint, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout, final FutureCallback<TransportSecurityLayer> callback) throws UnsupportedOperationException

Overrides default org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls.

Doc from org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls.

Starts TLS session over an existing network connection with the given SSL context. NamedEndpoint details are applicable for client side connections and are used for host name verification, when supported by the SSL engine.

Parameters

sslContext:SSLContext: SSL context to be used for this session.
endpoint:NamedEndpoint: optional endpoint details for outgoing client side connections.
sslBufferMode:SSLBufferMode: SSL buffer management mode.
initializer:SSLSessionInitializer: SSL session initialization callback.
verifier:SSLSessionVerifier: SSL session verification callback.
handshakeTimeout:Timeout: the timeout to use while performing the TLS handshake; may be null.

Annotations

@Override

startTls back to summary

startTls	back to summary
public void startTls(final SSLContext sslContext, final NamedEndpoint endpoint, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout) throws UnsupportedOperationException Implements org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls. Doc from org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls. Starts TLS session over an existing network connection with the given SSL context. `NamedEndpoint` details are applicable for client side connections and are used for host name verification, when supported by the SSL engine. Parameters sslContext:SSLContext SSL context to be used for this session. endpoint:NamedEndpoint optional endpoint details for outgoing client side connections. sslBufferMode:SSLBufferMode SSL buffer management mode. initializer:SSLSessionInitializer SSL session initialization callback. verifier:SSLSessionVerifier SSL session verification callback. handshakeTimeout:Timeout the timeout to use while performing the TLS handshake; may be `null`. Annotations @Override

Implements org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls.

Doc from org.apache.hc.core5.reactor.ssl.TransportSecurityLayer.startTls.

Parameters

sslContext:SSLContext: SSL context to be used for this session.
endpoint:NamedEndpoint: optional endpoint details for outgoing client side connections.
sslBufferMode:SSLBufferMode: SSL buffer management mode.
initializer:SSLSessionInitializer: SSL session initialization callback.
verifier:SSLSessionVerifier: SSL session verification callback.
handshakeTimeout:Timeout: the timeout to use while performing the TLS handshake; may be null.

Annotations

@Override

submitCommand	back to summary
public void submitCommand(final Command command, final Command.Priority priority) Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.submitCommand. Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.submitCommand. Submits the given command for execution. Parameters command:Command the command to be executed. priority:Command.Priority the command priority. Annotations @Override

submitCommand

back to summary

public void submitCommand(final Command command, final Command.Priority priority)

Implements org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.submitCommand.

Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.submitCommand.

Submits the given command for execution.

Parameters

command:Command: the command to be executed.
priority:Command.Priority: the command priority.

Annotations

@Override

switchProtocol	back to summary
public void switchProtocol(final String protocolId, final FutureCallback<ProtocolIOSession> callback) throws UnsupportedOperationException Overrides default org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.switchProtocol. Doc from org.apache.hc.client5.http.nio.ManagedAsyncClientConnection.switchProtocol. Switches this I/O session to the application protocol with the given ID. Parameters protocolId:String the application protocol ID callback:FutureCallback<ProtocolIOSession> the result callback Annotations @Override Exceptions UnsupportedOperationException: if application protocol switch is not supported.

switchProtocol

back to summary