Apache5HttpTransport.java
/*
* Copyright 2024 Google LLC
*
* Licensed 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.
*/
package com.google.api.client.http.apache.v5;
import com.google.api.client.http.HttpMethods;
import com.google.api.client.http.HttpTransport;
import com.google.common.annotations.Beta;
import com.google.common.base.Preconditions;
import java.io.IOException;
import java.net.ProxySelector;
import java.net.URI;
import java.util.concurrent.TimeUnit;
import org.apache.hc.client5.http.classic.HttpClient;
import org.apache.hc.client5.http.classic.methods.HttpDelete;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.HttpHead;
import org.apache.hc.client5.http.classic.methods.HttpOptions;
import org.apache.hc.client5.http.classic.methods.HttpPatch;
import org.apache.hc.client5.http.classic.methods.HttpPost;
import org.apache.hc.client5.http.classic.methods.HttpPut;
import org.apache.hc.client5.http.classic.methods.HttpTrace;
import org.apache.hc.client5.http.classic.methods.HttpUriRequestBase;
import org.apache.hc.client5.http.config.ConnectionConfig;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.client5.http.impl.routing.SystemDefaultRoutePlanner;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
import org.apache.hc.core5.io.CloseMode;
import org.apache.hc.core5.io.ModalCloseable;
/**
* Thread-safe HTTP transport based on the Apache HTTP Client library.
*
* <p>Implementation is thread-safe, as long as any parameter modification to the {@link
* #getHttpClient() Apache HTTP Client} is only done at initialization time. For maximum efficiency,
* applications should use a single globally-shared instance of the HTTP transport.
*
* <p>Default settings are specified in {@link #newDefaultHttpClient()}. Use the {@link
* #Apache5HttpTransport(HttpClient)} constructor to override the Apache HTTP Client used. Please
* read the <a
* href="https://github.com/apache/httpcomponents-client/blob/f898f1aca38f77f62a007856a674629cae5a02e6/httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientConfiguration.java">
* Apache HTTP Client 5.x configuration example</a> for more complex configuration options.
*/
public final class Apache5HttpTransport extends HttpTransport {
/** Apache HTTP client. */
private final HttpClient httpClient;
/** If the HTTP client uses mTLS channel. */
private final boolean isMtls;
/** Constructor that uses {@link #newDefaultHttpClient()} for the Apache HTTP client. */
public Apache5HttpTransport() {
this(newDefaultHttpClient(), false);
}
/**
* Constructor that allows an alternative Apache HTTP client to be used.
*
* <p>If you choose to provide your own Apache HttpClient implementation, be sure that
*
* <ul>
* <li>HTTP version is set to 1.1.
* <li>Retries are disabled (google-http-client handles retries).
* </ul>
*
* @param httpClient Apache HTTP client to use
*/
public Apache5HttpTransport(HttpClient httpClient) {
this.httpClient = httpClient;
this.isMtls = false;
}
/**
* {@link Beta} <br>
* Constructor that allows an alternative CLoseable Apache HTTP client to be used.
*
* <p>If you choose to provide your own Apache HttpClient implementation, be sure that
*
* <ul>
* <li>HTTP version is set to 1.1.
* <li>Retries are disabled (google-http-client handles retries).
* <li>Redirects are disabled (google-http-client handles retries).
* </ul>
*
* @param httpClient Apache HTTP client to use
* @param isMtls If the HTTP client is mutual TLS
*/
@Beta
public Apache5HttpTransport(HttpClient httpClient, boolean isMtls) {
this.httpClient = httpClient;
this.isMtls = isMtls;
}
/**
* Creates a new instance of the Apache HTTP client that is used by the {@link
* #Apache5HttpTransport()} constructor.
*
* <p>Settings:
*
* <ul>
* <li>The client connection manager is set to {@link PoolingHttpClientConnectionManager}.
* <li>The retry mechanism is turned off using {@link
* HttpClientBuilder#disableAutomaticRetries()}.
* <li>Redirects are turned off using {@link HttpClientBuilder#disableRedirectHandling}.
* <li>The route planner uses {@link SystemDefaultRoutePlanner} with {@link
* ProxySelector#getDefault()}, which uses the proxy settings from <a
* href="https://docs.oracle.com/javase/8/docs/api/java/net/doc-files/net-properties.html">system
* properties</a>.
* </ul>
*
* @return new instance of the Apache HTTP client
*/
public static HttpClient newDefaultHttpClient() {
return newDefaultHttpClientBuilder().build();
}
/**
* Creates a new Apache HTTP client builder that is used by the {@link #Apache5HttpTransport()}
* constructor.
*
* <p>Settings:
*
* <ul>
* <li>The client connection manager is set to {@link PoolingHttpClientConnectionManager}.
* <li>The retry mechanism is turned off using {@link
* HttpClientBuilder#disableAutomaticRetries()}.
* <li>Redirects are turned off using {@link HttpClientBuilder#disableRedirectHandling}.
* <li>The route planner uses {@link SystemDefaultRoutePlanner} with {@link
* ProxySelector#getDefault()}, which uses the proxy settings from <a
* href="http://docs.oracle.com/javase/8/docs/api/java/net/doc-files/net-properties.html">system
* properties</a>.
* </ul>
*
* @return new instance of the Apache HTTP client builder
*/
public static HttpClientBuilder newDefaultHttpClientBuilder() {
PoolingHttpClientConnectionManager connectionManager =
PoolingHttpClientConnectionManagerBuilder.create()
.setSSLSocketFactory(SSLConnectionSocketFactory.getSocketFactory())
.setMaxConnTotal(200)
.setMaxConnPerRoute(20)
.setDefaultConnectionConfig(
ConnectionConfig.custom().setTimeToLive(-1, TimeUnit.MILLISECONDS).build())
.build();
return HttpClients.custom()
.useSystemProperties()
.setConnectionManager(connectionManager)
.setRoutePlanner(new SystemDefaultRoutePlanner(ProxySelector.getDefault()))
.disableRedirectHandling()
.disableAutomaticRetries();
}
@Override
public boolean supportsMethod(String method) {
return true;
}
@Override
protected Apache5HttpRequest buildRequest(String method, String url) {
HttpUriRequestBase requestBase;
if (method.equals(HttpMethods.DELETE)) {
requestBase = new HttpDelete(url);
} else if (method.equals(HttpMethods.GET)) {
requestBase = new HttpGet(url);
} else if (method.equals(HttpMethods.HEAD)) {
requestBase = new HttpHead(url);
} else if (method.equals(HttpMethods.PATCH)) {
requestBase = new HttpPatch(url);
} else if (method.equals(HttpMethods.POST)) {
requestBase = new HttpPost(url);
} else if (method.equals(HttpMethods.PUT)) {
requestBase = new HttpPut(url);
} else if (method.equals(HttpMethods.TRACE)) {
requestBase = new HttpTrace(url);
} else if (method.equals(HttpMethods.OPTIONS)) {
requestBase = new HttpOptions(url);
} else {
requestBase = new HttpUriRequestBase(Preconditions.checkNotNull(method), URI.create(url));
}
return new Apache5HttpRequest(httpClient, requestBase);
}
/**
* Gracefully shuts down the connection manager and releases allocated resources. This closes all
* connections, whether they are currently used or not.
*/
@Override
public void shutdown() throws IOException {
if (httpClient instanceof ModalCloseable) {
((ModalCloseable) httpClient).close(CloseMode.GRACEFUL);
}
// otherwise no-op
}
/** Returns the Apache HTTP client. */
public HttpClient getHttpClient() {
return httpClient;
}
/** Returns if the underlying HTTP client is mTLS. */
@Override
public boolean isMtls() {
return isMtls;
}
}