org.apache.hc.client5.http.classic.ExecRuntime Maven / Gradle / Ivy
Show all versions of httpclient5 Show documentation
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* This interface is considered internal and generally ought not be used or accessed
* by custom request exec handlers.
*
* @since 5.0
*/
@Internal
public interface ExecRuntime {
/**
* Determines of the request execution has been aborted.
*
* @return {@code true} if the request execution has been acquired,
* {@code false} otherwise.
*/
boolean isExecutionAborted();
/**
* Determines of a connection endpoint has been acquired.
*
* @return {@code true} if an endpoint has been acquired, {@code false} otherwise.
*/
boolean isEndpointAcquired();
/**
* Acquires a connection endpoint. Endpoints can leased from a pool
* or unconnected new endpoint can be created.
*
* @param id unique operation ID or {@code null}.
* @param route the connection route.
* @param state the expected connection state. May be {@code null} if connection
* can be state-less or its state is irrelevant.
* @param context the execution context.
* @throws IOException if an I/O error occurs.
*/
void acquireEndpoint(
String id,
HttpRoute route,
Object state,
HttpClientContext context) throws IOException;
/**
* Releases the acquired endpoint potentially making it available for re-use.
*/
void releaseEndpoint();
/**
* Shuts down and discards the acquired endpoint.
*/
void discardEndpoint();
/**
* 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).
*
* @return {@code true} if the endpoint is connected, {@code false} otherwise.
*/
boolean isEndpointConnected();
/**
* Disconnects the local endpoint from the initial hop in the connection route.
*
* @throws IOException if an I/O error occurs.
*/
void disconnectEndpoint() 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).
*
* @param context the execution context.
* @throws IOException if an I/O error occurs.
*/
void connectEndpoint(HttpClientContext context) throws IOException;
/**
* Upgrades transport security of the active connection by using the TLS security protocol.
*
* @param context the execution context.
* @throws IOException if an I/O error occurs.
*/
void upgradeTls(HttpClientContext context) throws IOException;
/**
* Gets information about the underlying endpoint when connected or {@code null} otherwise.
*
* @return an EndpointInfo, defaults to {@code null}.
*/
default EndpointInfo getEndpointInfo() {
return null;
}
/**
* Executes HTTP request using the given context.
*
* @param id unique operation ID or {@code null}.
* @param request the request message.
* @param context the execution context.
* @return a ClassicHttpResponse.
* @throws IOException if an I/O error occurs.
* @throws HttpException if a protocol error occurs.
*/
ClassicHttpResponse execute(
String id,
ClassicHttpRequest request,
HttpClientContext context) throws IOException, HttpException;
/**
* Executes HTTP request using the given context.
*
* @param id unique operation ID or {@code null}.
* @param request the request message.
* @param informationCallback information (1xx) response handler
* @param context the execution context.
* @return a ClassicHttpResponse.
* @throws IOException if an I/O error occurs.
* @throws HttpException if a protocol error occurs.
* @since 5.4
*/
default ClassicHttpResponse execute(
String id,
ClassicHttpRequest request,
HttpResponseInformationCallback informationCallback,
HttpClientContext context) throws IOException, HttpException {
return execute(id, request, context);
}
/**
* Determines of the connection is considered re-usable.
*
* @return {@code true} if the connection is re-usable, {@code false} otherwise.
*/
boolean isConnectionReusable();
/**
* 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.
* @param state the connection state representation or {@code null} if stateless.
* @param validityTime the period of time this connection is valid for.
*/
void markConnectionReusable(Object state, TimeValue validityTime);
/**
* Marks the connection as non re-usable.
*/
void markConnectionNonReusable();
/**
* Forks this runtime for parallel execution.
*
* @return another runtime with the same configuration.
*/
ExecRuntime fork(CancellableDependency cancellableAware);
}