-
Notifications
You must be signed in to change notification settings - Fork 588
Improve HTTP client with connection pool #7557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
inthirakumaaran
wants to merge
3
commits into
wso2:master
Choose a base branch
from
inthirakumaaran:http-client-pooling-pub
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
160 changes: 160 additions & 0 deletions
160
...2.carbon.identity.core/src/main/java/org/wso2/carbon/identity/core/HTTPClientManager.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| /* | ||
| * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. 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. | ||
| */ | ||
|
|
||
| package org.wso2.carbon.identity.core; | ||
|
|
||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.apache.hc.client5.http.impl.DefaultConnectionKeepAliveStrategy; | ||
| import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; | ||
| import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; | ||
| import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; | ||
| import org.wso2.carbon.base.ServerConfiguration; | ||
| import org.wso2.carbon.utils.httpclient5.HTTPClientUtils; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * Manage HTTP client creation with pool. | ||
| */ | ||
| public class HTTPClientManager { | ||
|
|
||
| public static final String HTTP_CLIENT_MAX_TOTAL_CONNECTIONS = "HttpClient.ConnectionPool.MaxTotalConnections"; | ||
| public static final String HTTP_CLIENT_DEFAULT_MAX_CONNECTIONS_PER_ROUTE = | ||
| "HttpClient.ConnectionPool.DefaultMaxConnectionsPerRoute"; | ||
| public static final String HTTP_CLIENT_ADD_KEEP_ALIVE_STRATEGY = | ||
| "HttpClient.ConnectionPool.AddKeepAliveStrategy"; | ||
| public static final String HTTP_CLIENT_POOL_ENABLED = "HttpClient.ConnectionPool.Enabled"; | ||
|
|
||
| private static final Log log = LogFactory.getLog(HTTPClientManager.class); | ||
| private static final CloseableHttpClient httpClient; | ||
| private static final boolean isConnectionPoolEnabled; | ||
|
|
||
| private HTTPClientManager() { | ||
| } | ||
|
|
||
| static { | ||
|
|
||
| isConnectionPoolEnabled = Boolean.parseBoolean( | ||
inthirakumaaran marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ServerConfiguration.getInstance().getFirstProperty(HTTP_CLIENT_POOL_ENABLED)); | ||
|
|
||
| HttpClientBuilder clientBuilder = HTTPClientUtils.createClientWithCustomHostnameVerifier(); | ||
|
|
||
| if (log.isDebugEnabled()) { | ||
| log.debug("Initializing HTTPClientManager with connection pool enabled: " + isConnectionPoolEnabled); | ||
| } | ||
| if (isConnectionPoolEnabled) { | ||
|
|
||
| String maxTotalConnectionProp = ServerConfiguration.getInstance() | ||
| .getFirstProperty(HTTP_CLIENT_MAX_TOTAL_CONNECTIONS); | ||
| String defaultMaxPerRouteProp = ServerConfiguration.getInstance() | ||
| .getFirstProperty(HTTP_CLIENT_DEFAULT_MAX_CONNECTIONS_PER_ROUTE); | ||
| String addKeepAliveStrategy = ServerConfiguration.getInstance() | ||
| .getFirstProperty(HTTP_CLIENT_ADD_KEEP_ALIVE_STRATEGY); | ||
|
|
||
| int maxTotalConnections = 100; | ||
| int defaultMaxPerRoute = 100; | ||
|
|
||
| if (maxTotalConnectionProp != null) { | ||
| try { | ||
| maxTotalConnections = Integer.parseInt(maxTotalConnectionProp); | ||
| } catch (NumberFormatException ignore) { | ||
| log.debug("Parsing issue for maxTotalConnections property: " + maxTotalConnectionProp); | ||
| } | ||
| } | ||
| if (defaultMaxPerRouteProp != null) { | ||
| try { | ||
| defaultMaxPerRoute = Integer.parseInt(defaultMaxPerRouteProp); | ||
| } catch (NumberFormatException ignore) { | ||
| log.debug("Parsing issue for defaultMaxPerRoute property: " + defaultMaxPerRouteProp); | ||
| } | ||
| } | ||
| PoolingHttpClientConnectionManager connManager = new PoolingHttpClientConnectionManager(); | ||
| connManager.setMaxTotal(maxTotalConnections); | ||
| connManager.setDefaultMaxPerRoute(defaultMaxPerRoute); | ||
| clientBuilder.setConnectionManager(connManager); | ||
| if (Boolean.parseBoolean(addKeepAliveStrategy)) { | ||
| clientBuilder.setKeepAliveStrategy(new DefaultConnectionKeepAliveStrategy()); | ||
| } | ||
| } | ||
| httpClient = clientBuilder.build(); | ||
| } | ||
|
|
||
| public static CloseableHttpClient getHttpClient() { | ||
|
|
||
| return httpClient; | ||
| } | ||
|
|
||
| /** | ||
| * Executes an operation with appropriate HttpClient management. | ||
| * Handles both pooled and non-pooled clients, ensuring proper cleanup. | ||
| * | ||
| * @param operation The operation to execute with the HttpClient | ||
| * @param <T> Return type of the operation | ||
| * @param <E> Exception type that the operation may throw | ||
| * @return Result of the operation | ||
| * @throws E if operation fails | ||
inthirakumaaran marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| */ | ||
| public static <T, E extends Exception> T executeWithHttpClient(HttpClientOperation<T, E> operation) | ||
| throws E { | ||
|
|
||
| boolean usePooling = isConnectionPoolEnabled; | ||
| CloseableHttpClient httpClient = usePooling ? getHttpClient() | ||
| : HTTPClientUtils.createClientWithCustomHostnameVerifier().build(); | ||
|
|
||
| try { | ||
| return operation.execute(httpClient); | ||
| } finally { | ||
| closeHttpClientIfNeeded(httpClient); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Closes HttpClient only if not using connection pooling. | ||
| * | ||
| * @param httpClient The client to close | ||
| */ | ||
| private static void closeHttpClientIfNeeded(CloseableHttpClient httpClient) { | ||
|
|
||
| if (!isConnectionPoolEnabled) { | ||
| try { | ||
| httpClient.close(); | ||
| } catch (IOException e) { | ||
| log.debug("Failed to close non-pooled HttpClient", e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static boolean isConnectionPoolEnabled() { | ||
|
|
||
| return isConnectionPoolEnabled; | ||
| } | ||
|
|
||
| /** | ||
| * Functional interface for operations that use HttpClient. | ||
| * Generalized to work with any exception type. | ||
| * | ||
| * @param <T> Return type of the operation | ||
| * @param <E> Exception type that may be thrown | ||
| */ | ||
| @FunctionalInterface | ||
| public interface HttpClientOperation<T, E extends Exception> { | ||
|
|
||
| T execute(CloseableHttpClient httpClient) throws E; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.