Skip to content

feat: add proxy support #143

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.

Sign up for GitHub

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

Merged
sufyankhanrao merged 6 commits into from
Aug 12, 2025
Merged

feat: add proxy support #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ca28797
feat(http-client-configration): add proxy support
hamzamahmood Aug 7, 2025
25c4abb
Update README.md
hamzamahmood Aug 7, 2025
9ebdfc1
fix: npe on client new builder
hamzamahmood Aug 8, 2025
e6fa057
fix: lint errors
hamzamahmood Aug 11, 2025
3baade1
Update CoreHttpClientConfiguration.java
hamzamahmood Aug 12, 2025
16ef119
fix: CoreHttpClientConfiguration toString() proxyConfiguration name
hamzamahmood Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,20 @@ Core lib's Maven group ID is `io.apimatic`, and its artifact ID is `core`.
| [`Or`](./src/main/java/io/apimatic/core/authentication/multiple/Or.java) | A class to hold the algorithm for `Or` combination of auth schemes |
| [`Single`](./src/main/java/io/apimatic/core/authentication/multiple/Single.java) | A class to hold the logic for single auth scheme, it is used as leaf node for auth combination or it could be used directly to apply one auth only to the http request |
| [`CoreHttpClientConfiguration`](./src/main/java/io/apimatic/core/configurations/http/client/CoreHttpClientConfiguration.java) | To hold HTTP Client Configuration |
| [`CoreProxyConfiguration`](./src/main/java/io/apimatic/core/configurations/http/client/CoreProxyConfiguration.java) | To hold the Proxy configuration for the underlying HTTP client instance. |
| [`EndpointConfiguration`](./src/main/java/io/apimatic/core/configurations/http/request/EndpointConfiguration.java) | The configuration for an endpoint |
| [`AsyncExecutor`](./src/main/java/io/apimatic/core/request/async/AsyncExecutor.java) | Executor service for asynchronous HTTP endpoint call |
| [`OptionalNullable`](./src/main/java/io/apimatic/core/types/OptionalNullable.java) | Class to encapsulate fields which are Optional as well as Nullable |
| [`BaseModel`](./src/main/java/io/apimatic/core/types/BaseModel.java) | Base model for all the models |
| [`CoreApiException`](./src/main/java/io/apimatic/core/types/CoreApiException.java) | This is the base class for all exceptions that represent an error response from the server |
| [`MultipartFileWrapper`](./src/main/java/io/apimatic/core/types/http/request/MultipartFileWrapper.java) | To wrap file and headers to be sent as part of a multipart request |
| [`MultipartWrapper`](./src/main/java/io/apimatic/core/types/http/request/MultipartWrapper.java) | To wrap byteArray and headers to be sent as part of a multipart request |
| [`PaginatedData`](./src/main/java/io/apimatic/core/types/pagination/PaginatedData.java) | To provide pagination functionality for both synchronous and asynchronous pagination types |
| [`PageWrapper`](./src/main/java/io/apimatic/core/types/pagination/PageWrapper.java) | To wrap a single page along with its items and meta-data in the paginated data |
| [`CursorPagination`](./src/main/java/io/apimatic/core/types/pagination/CursorPagination.java) | Provides cursor based pagination strategy |
| [`LinkPagination`](./src/main/java/io/apimatic/core/types/pagination/LinkPagination.java) | Provides link based pagination strategy |
| [`OffsetPagination`](./src/main/java/io/apimatic/core/types/pagination/OffsetPagination.java) | Provides offset based pagination strategy |
| [`PagePagination`](./src/main/java/io/apimatic/core/types/pagination/PagePagination.java) | Provides page based pagination strategy |
| [`PaginatedData`](./src/main/java/io/apimatic/core/types/pagination/PaginatedData.java) | To provide pagination functionality for both synchronous and asynchronous pagination types |
| [`PageWrapper`](./src/main/java/io/apimatic/core/types/pagination/PageWrapper.java) | To wrap a single page along with its items and meta-data in the paginated data |
| [`CursorPagination`](./src/main/java/io/apimatic/core/types/pagination/CursorPagination.java) | Provides cursor based pagination strategy |
| [`LinkPagination`](./src/main/java/io/apimatic/core/types/pagination/LinkPagination.java) | Provides link based pagination strategy |
| [`OffsetPagination`](./src/main/java/io/apimatic/core/types/pagination/OffsetPagination.java) | Provides offset based pagination strategy |
| [`PagePagination`](./src/main/java/io/apimatic/core/types/pagination/PagePagination.java) | Provides page based pagination strategy |
| [`CoreHelper`](./src/main/java/io/apimatic/core/utilities/CoreHelper.java) | This is a Helper class with commonly used utilities for the SDK |
| [`DateHelper`](./src/main/java/io/apimatic/core/utilities/DateHelper.java) | This is a utility class for LocalDate operations |
| [`LocalDateTimeHelper`](./src/main/java/io/apimatic/core/utilities/LocalDateTimeHelper.java) | This is a utility class for LocalDateTime operations |
Expand All @@ -72,7 +73,7 @@ Core lib's Maven group ID is `io.apimatic`, and its artifact ID is `core`.
| [`CoreJsonObject`](./src/main/java/io/apimatic/core/utilities/CoreJsonObject.java) | Wrapper class for JSON object |
| [`CoreJsonValue`](./src/main/java/io/apimatic/core/utilities/CoreJsonValue.java) | Wrapper class for JSON value |
| [`TestHelper`](./src/main/java/io/apimatic/core/utilities/TestHelper.java) | Contains utility methods for comparing objects, arrays and files |
| [`AdditionalProperties`](./src/main/java/io/apimatic/core/types/AdditionalProperties.java) | A generic class for managing additional properties in a model. |
| [`AdditionalProperties`](./src/main/java/io/apimatic/core/types/AdditionalProperties.java) | A generic class for managing additional properties in a model. |
| [`ConversionHelper`](./src/main/java/io/apimatic/core/utilities/ConversionHelper.java) | A Helper class for the coversion of type (provided as function) for all structures (array, map, array of map, n-dimensional arrays etc) supported in the SDK. |

## Interfaces
Expand Down
45 changes: 41 additions & 4 deletions src/main/java/io/apimatic/core/configurations/http/client/CoreHttpClientConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.apimatic.core.configurations.http.client;

import io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
Expand Down Expand Up @@ -122,6 +123,12 @@ public final class CoreHttpClientConfiguration implements ClientConfiguration {
*/
private final boolean skipSslCertVerification;

/**
* The proxy configuration used to route network requests through a proxy server.
* Contains details such as address, port, and optional authentication credentials.
*/
private final ProxyConfiguration proxyConfiguration;

/**
* @param timeout
* @param numberOfRetries
Expand All @@ -134,13 +141,15 @@ public final class CoreHttpClientConfiguration implements ClientConfiguration {
* @param shouldRetryOnTimeout
* @param httpClientInstance
* @param overrideHttpClientConfigurations
* @param proxyConfiguration
*/
private CoreHttpClientConfiguration(final long timeout, final int numberOfRetries,
final int backOffFactor, final long retryInterval,
final boolean skipSslCertVerification, final Set<Integer> httpStatusCodesToRetry,
final Set<Method> httpMethodsToRetry, final long maximumRetryWaitTime,
final boolean shouldRetryOnTimeout, final okhttp3.OkHttpClient httpClientInstance,
final boolean overrideHttpClientConfigurations) {
final boolean overrideHttpClientConfigurations,
final ProxyConfiguration proxyConfiguration) {
this.timeout = timeout;
this.numberOfRetries = numberOfRetries;
this.backOffFactor = backOffFactor;
Expand All @@ -152,6 +161,7 @@ private CoreHttpClientConfiguration(final long timeout, final int numberOfRetrie
this.httpClientInstance = httpClientInstance;
this.overrideHttpClientConfigurations = overrideHttpClientConfigurations;
this.skipSslCertVerification = skipSslCertVerification;
this.proxyConfiguration = proxyConfiguration;
}

/**
Expand Down Expand Up @@ -243,6 +253,15 @@ public boolean skipSslCertVerification() {
return skipSslCertVerification;
}

/**
* Returns the proxy configuration used to route requests through a proxy server.
* This includes the proxy address, port, and any authentication credentials.
* @return the {@link ProxyConfiguration}
*/
public ProxyConfiguration getProxyConfiguration() {
return proxyConfiguration;
}

/**
* Converts this HttpClientConfiguration into string format.
* @return String representation of this class.
Expand All @@ -255,7 +274,8 @@ public String toString() {
+ ", httpMethodsToRetry=" + httpMethodsToRetry + ", maximumRetryWaitTime="
+ maximumRetryWaitTime + ", shouldRetryOnTimeout=" + shouldRetryOnTimeout
+ ", httpClientInstance=" + httpClientInstance
+ ", overrideHttpClientConfigurations=" + overrideHttpClientConfigurations + "]";
+ ", overrideHttpClientConfigurations=" + overrideHttpClientConfigurations
+ ", proxyConfiguration=" + proxyConfiguration + "]";
}

/**
Expand All @@ -269,7 +289,8 @@ public Builder newBuilder() {
.httpStatusCodesToRetry(httpStatusCodesToRetry)
.httpMethodsToRetry(httpMethodsToRetry).maximumRetryWaitTime(maximumRetryWaitTime)
.shouldRetryOnTimeout(shouldRetryOnTimeout)
.httpClientInstance(httpClientInstance, overrideHttpClientConfigurations);
.httpClientInstance(httpClientInstance, overrideHttpClientConfigurations)
.proxyConfiguration(proxyConfiguration);
}

/**
Expand Down Expand Up @@ -322,6 +343,11 @@ public static class Builder {
* Skip Ssl certification.
*/
private boolean skipSslCertVerification;
/**
* The proxy configuration used to route network requests through a proxy server.
* Contains details such as address, port, and optional authentication credentials.
*/
private ProxyConfiguration proxyConfiguration;

/**
* Default Constructor to initiate builder with default properties.
Expand Down Expand Up @@ -463,6 +489,17 @@ public Builder skipSslCertVerification(boolean skipSslCertVerification) {
return this;
}

/**
* Sets the proxy configuration to be used for routing requests through a proxy server.
*
* @param proxyConfiguration the {@link ProxyConfiguration} instance to use
* @return the builder instance
*/
public Builder proxyConfiguration(ProxyConfiguration proxyConfiguration) {
this.proxyConfiguration = proxyConfiguration;
return this;
}

/**
* Builds a new HttpClientConfiguration object using the set fields.
* @return {@link CoreHttpClientConfiguration}.
Expand All @@ -471,7 +508,7 @@ public CoreHttpClientConfiguration build() {
return new CoreHttpClientConfiguration(timeout, numberOfRetries, backOffFactor,
retryInterval, skipSslCertVerification, httpStatusCodesToRetry,
httpMethodsToRetry, maximumRetryWaitTime, shouldRetryOnTimeout,
httpClientInstance, overrideHttpClientConfigurations);
httpClientInstance, overrideHttpClientConfigurations, proxyConfiguration);
}
}
}
Loading
Loading