OAuth2/client: doc-nit: add note about running a client in a conainer (…

…#8324)
projectnessie · Apr 12, 2024 · 71faf89 · 71faf89
1 parent 44cc4eb
commit 71faf89
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/api/client/src/main/java/org/projectnessie/client/NessieConfigConstants.java b/api/client/src/main/java/org/projectnessie/client/NessieConfigConstants.java
@@ -303,10 +303,16 @@ public final class NessieConfigConstants {
 
   /**
    * Config property name ({@value #CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT}) for the
-   * OAuth2 authentication provider. The port used for the internal web server that listens for the
-   * authorization code callback. This is only used if the grant type to use is {@value
-   * #CONF_NESSIE_OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE}. Optional; if not present, a random port
-   * will be used.
+   * OAuth2 authentication provider.
+   *
+   * <p>When running a client inside a container make sure to specify a port and forward the port to
+   * the container host.
+   *
+   * <p>The port used for the internal web server that listens for the authorization code callback.
+   * This is only used if the grant type to use is {@value
+   * #CONF_NESSIE_OAUTH2_GRANT_TYPE_AUTHORIZATION_CODE}.
+   *
+   * <p>Optional; if not present, a random port will be used.
    */
   public static final String CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT =
       "nessie.authentication.oauth2.auth-code-flow.web-port";

diff --git a/api/client/src/main/java/org/projectnessie/client/auth/oauth2/OAuth2AuthenticatorConfig.java b/api/client/src/main/java/org/projectnessie/client/auth/oauth2/OAuth2AuthenticatorConfig.java
@@ -312,9 +312,13 @@ default Duration getAuthorizationCodeFlowTimeout() {
   }
 
   /**
-   * The port to use for the local web server that listens for the authorization code. Optional. If
-   * not set or set to zero, a random port from the dynamic client port range will be used. Only
-   * relevant when using the {@link GrantType#AUTHORIZATION_CODE} grant type.
+   * The port to use for the local web server that listens for the authorization code.
+   *
+   * <p>When running a client inside a container make sure to specify a port and forward the port to
+   * the container host.
+   *
+   * <p>If not set or set to zero, a random port from the dynamic client port range will be used.
+   * Only relevant when using the {@link GrantType#AUTHORIZATION_CODE} grant type.
    *
    * @see NessieConfigConstants#CONF_NESSIE_OAUTH2_AUTHORIZATION_CODE_FLOW_WEB_PORT
    */