Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Add EndpointContext (#2275)
* chore: Add EndpointContext * chore: Update constants scope to private * chore: Rename tests * chore: Fix lint issues * chore: Clean up EndpointContext * chore: Add uses for the EndpointContext in ClientContext * chore: Replace ClientContext getEndpoint() logic * chore: Remove stubsettings code * chore: Clean up EndpointContext test case * chore: Fix lint issues * chore: Add variables for test params * feat: Remove TransportChannelProvider logic * feat: Add javadocs for clientSettingsEndpoint
- Loading branch information
Showing
4 changed files
with
306 additions
and
121 deletions.
There are no files selected for viewing
This file contains 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
128 changes: 128 additions & 0 deletions
128
gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java
This file contains 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,128 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are | ||
| * met: | ||
| * | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * * Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following disclaimer | ||
| * in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * * Neither the name of Google LLC nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package com.google.api.gax.rpc; | ||
|
|
||
| import com.google.api.core.InternalApi; | ||
| import com.google.api.gax.rpc.mtls.MtlsProvider; | ||
| import com.google.auto.value.AutoValue; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import java.io.IOException; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** Contains the fields required to resolve the endpoint */ | ||
| @InternalApi | ||
| @AutoValue | ||
| public abstract class EndpointContext { | ||
| /** | ||
| * ClientSettingsEndpoint is the endpoint value set via the ClientSettings/StubSettings classes. | ||
| */ | ||
| @Nullable | ||
| public abstract String clientSettingsEndpoint(); | ||
|
|
||
| @Nullable | ||
| public abstract String mtlsEndpoint(); | ||
|
|
||
| public abstract boolean switchToMtlsEndpointAllowed(); | ||
|
|
||
| @Nullable | ||
| public abstract MtlsProvider mtlsProvider(); | ||
|
|
||
| public abstract Builder toBuilder(); | ||
|
|
||
| private String resolvedEndpoint; | ||
|
|
||
| public static Builder newBuilder() { | ||
| return new AutoValue_EndpointContext.Builder().setSwitchToMtlsEndpointAllowed(false); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| void determineEndpoint() throws IOException { | ||
| MtlsProvider mtlsProvider = mtlsProvider() == null ? new MtlsProvider() : mtlsProvider(); | ||
| resolvedEndpoint = | ||
| mtlsEndpointResolver( | ||
| clientSettingsEndpoint(), mtlsEndpoint(), switchToMtlsEndpointAllowed(), mtlsProvider); | ||
| } | ||
|
|
||
| // This takes in parameters because determineEndpoint()'s logic will be updated | ||
| // to pass custom values in. | ||
| // Follows https://google.aip.dev/auth/4114 for resolving the endpoint | ||
| @VisibleForTesting | ||
| String mtlsEndpointResolver( | ||
| String endpoint, | ||
| String mtlsEndpoint, | ||
| boolean switchToMtlsEndpointAllowed, | ||
| MtlsProvider mtlsProvider) | ||
| throws IOException { | ||
| if (switchToMtlsEndpointAllowed && mtlsProvider != null) { | ||
| switch (mtlsProvider.getMtlsEndpointUsagePolicy()) { | ||
| case ALWAYS: | ||
| return mtlsEndpoint; | ||
| case NEVER: | ||
| return endpoint; | ||
| default: | ||
| if (mtlsProvider.useMtlsClientCertificate() && mtlsProvider.getKeyStore() != null) { | ||
| return mtlsEndpoint; | ||
| } | ||
| return endpoint; | ||
| } | ||
| } | ||
| return endpoint; | ||
| } | ||
|
|
||
| /** | ||
| * The resolved endpoint is the computed endpoint after accounting for the custom endpoints and | ||
| * mTLS configurations. | ||
| */ | ||
| public String getResolvedEndpoint() { | ||
| return resolvedEndpoint; | ||
| } | ||
|
|
||
| @AutoValue.Builder | ||
| public abstract static class Builder { | ||
| /** | ||
| * ClientSettingsEndpoint is the endpoint value set via the ClientSettings/StubSettings classes. | ||
| */ | ||
| public abstract Builder setClientSettingsEndpoint(String clientSettingsEndpoint); | ||
|
|
||
| public abstract Builder setMtlsEndpoint(String mtlsEndpoint); | ||
|
|
||
| public abstract Builder setSwitchToMtlsEndpointAllowed(boolean switchToMtlsEndpointAllowed); | ||
|
|
||
| public abstract Builder setMtlsProvider(MtlsProvider mtlsProvider); | ||
|
|
||
| abstract EndpointContext autoBuild(); | ||
|
|
||
| public EndpointContext build() throws IOException { | ||
| EndpointContext endpointContext = autoBuild(); | ||
| endpointContext.determineEndpoint(); | ||
| return endpointContext; | ||
| } | ||
| } | ||
| } |
This file contains 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
Oops, something went wrong.