Apache HttpClient 5.3 · org.apache.hc.client5.http.classic.ExecRuntime

Method Summary

Modifier and Type	Method and Description
public void	acquireEndpoint(String unique operation ID or `null`. id, HttpRoute the connection route. route, Object the expected connection state. May be `null` if connection can be state-less or its state is irrelevant. state, HttpClientContext the execution context. context) Acquires a connection endpoint.
public void	connectEndpoint(HttpClientContext the execution context. context) Connect the local endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).
public void	discardEndpoint() Shuts down and discards the acquired endpoint.
public void	disconnectEndpoint() Disconnects the local endpoint from the initial hop in the connection route.
public ClassicHttpResponse	execute(String unique operation ID or `null`. id, ClassicHttpRequest the request message. request, HttpClientContext the execution context. context) Executes HTTP request using the given context.
public ExecRuntime	Returns: another runtime with the same configuration. fork(CancellableDependency cancellableAware) Forks this runtime for parallel execution.
public boolean	Returns: `true` if the connection is re-usable, `false` otherwise. isConnectionReusable() Determines of the connection is considered re-usable.
public boolean	Returns: `true` if an endpoint has been acquired, `false` otherwise. isEndpointAcquired() Determines of a connection endpoint has been acquired.
public boolean	Returns: `true` if the endpoint is connected, `false` otherwise. isEndpointConnected() Determines of there the endpoint is connected to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).
public boolean	Returns: `true` if the request execution has been acquired, `false` otherwise. isExecutionAborted() Determines of the request execution has been aborted.
public void	markConnectionNonReusable() Marks the connection as non re-usable.
public void	markConnectionReusable(Object the connection state representation or `null` if stateless. state, TimeValue the period of time this connection is valid for. validityTime) Marks the connection as potentially re-usable for the given period of time and also marks it as stateful if the state representation is given.
public void	releaseEndpoint() Releases the acquired endpoint potentially making it available for re-use.
public void	upgradeTls(HttpClientContext the execution context. context) Upgrades transport security of the active connection by using the TLS security protocol.

Method Detail

acquireEndpoint back to summary

acquireEndpoint	back to summary
public void acquireEndpoint(String id, HttpRoute route, Object state, HttpClientContext context) throws IOException Acquires a connection endpoint. Endpoints can leased from a pool or unconnected new endpoint can be created. Parameters id:String unique operation ID or `null`. route:HttpRoute the connection route. state:Object the expected connection state. May be `null` if connection can be state-less or its state is irrelevant. context:HttpClientContext the execution context.

public void acquireEndpoint(String id, HttpRoute route, Object state, HttpClientContext context) throws IOException

Acquires a connection endpoint. Endpoints can leased from a pool or unconnected new endpoint can be created.

Parameters

id:String: unique operation ID or null.
route:HttpRoute: the connection route.
state:Object: the expected connection state. May be null if connection can be state-less or its state is irrelevant.
context:HttpClientContext: the execution context.

connectEndpoint	back to summary
public void connectEndpoint(HttpClientContext context) throws IOException Connect the local endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies). Parameters context:HttpClientContext the execution context.

connectEndpoint

back to summary

public void connectEndpoint(HttpClientContext context) throws IOException

Connect the local endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).

Parameters

context:HttpClientContext: the execution context.

discardEndpoint	back to summary
public void discardEndpoint() Shuts down and discards the acquired endpoint.

disconnectEndpoint	back to summary
public void disconnectEndpoint() throws IOException Disconnects the local endpoint from the initial hop in the connection route.

execute back to summary

execute	back to summary
public ClassicHttpResponse execute(String id, ClassicHttpRequest request, HttpClientContext context) throws IOException, HttpException Executes HTTP request using the given context. Parameters id:String unique operation ID or `null`. request:ClassicHttpRequest the request message. context:HttpClientContext the execution context.

public ClassicHttpResponse execute(String id, ClassicHttpRequest request, HttpClientContext context) throws IOException, HttpException

Executes HTTP request using the given context.

Parameters

id:String: unique operation ID or null.
request:ClassicHttpRequest: the request message.
context:HttpClientContext: the execution context.

fork	back to summary
public ExecRuntime fork(CancellableDependency cancellableAware) Forks this runtime for parallel execution. Returns:ExecRuntime another runtime with the same configuration.

fork

back to summary

public ExecRuntime fork(CancellableDependency cancellableAware)

Forks this runtime for parallel execution.

Returns:ExecRuntime: another runtime with the same configuration.

isConnectionReusable back to summary

isConnectionReusable	back to summary
public boolean isConnectionReusable() Determines of the connection is considered re-usable. Returns:boolean `true` if the connection is re-usable, `false` otherwise.

public boolean isConnectionReusable()

Determines of the connection is considered re-usable.

Returns:boolean: true if the connection is re-usable, false otherwise.

isEndpointAcquired back to summary

isEndpointAcquired	back to summary
public boolean isEndpointAcquired() Determines of a connection endpoint has been acquired. Returns:boolean `true` if an endpoint has been acquired, `false` otherwise.

public boolean isEndpointAcquired()

Determines of a connection endpoint has been acquired.

Returns:boolean: true if an endpoint has been acquired, false otherwise.

isEndpointConnected back to summary

isEndpointConnected	back to summary
public boolean isEndpointConnected() Determines of there the endpoint is connected to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies). Returns:boolean `true` if the endpoint is connected, `false` otherwise.

public boolean isEndpointConnected()

Determines of there the endpoint is connected to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).

Returns:boolean: true if the endpoint is connected, false otherwise.

isExecutionAborted back to summary

isExecutionAborted	back to summary
public boolean isExecutionAborted() Determines of the request execution has been aborted. Returns:boolean `true` if the request execution has been acquired, `false` otherwise.

public boolean isExecutionAborted()

Determines of the request execution has been aborted.

Returns:boolean: true if the request execution has been acquired, false otherwise.

markConnectionNonReusable	back to summary
public void markConnectionNonReusable() Marks the connection as non re-usable.

markConnectionReusable back to summary

markConnectionReusable	back to summary
public void markConnectionReusable(Object state, TimeValue validityTime) Marks the connection as potentially re-usable for the given period of time and also marks it as stateful if the state representation is given. Parameters state:Object the connection state representation or `null` if stateless. validityTime:TimeValue the period of time this connection is valid for.

public void markConnectionReusable(Object state, TimeValue validityTime)

Marks the connection as potentially re-usable for the given period of time and also marks it as stateful if the state representation is given.

Parameters

state:Object: the connection state representation or null if stateless.
validityTime:TimeValue: the period of time this connection is valid for.

releaseEndpoint	back to summary
public void releaseEndpoint() Releases the acquired endpoint potentially making it available for re-use.

upgradeTls	back to summary
public void upgradeTls(HttpClientContext context) throws IOException Upgrades transport security of the active connection by using the TLS security protocol. Parameters context:HttpClientContext the execution context.

upgradeTls

back to summary

public void upgradeTls(HttpClientContext context) throws IOException

Upgrades transport security of the active connection by using the TLS security protocol.

Parameters

context:HttpClientContext: the execution context.

public Interface ExecRuntime

Method Summary

Method Detail