implement possibility to add extra parameters to Access Token Request (AccessTokenRequestParams#*ExtraParameters methods), #980 (thanks to https://github.com/pmorch)

kullfar · kullfar · commit 4e90348e66a7 · 2021-03-12T12:38:53.000+03:00
diff --git a/changelog b/changelog
@@ -2,6 +2,9 @@
  * add ScopeBuilder to easily specify multiple scopes while requesting OAuth2.0 Access Tokens
  * make Base64 en/de-coding not dependent from java8 implementation (use three optional implementation
     (internal java 8+, Apache Commons Codec, JAXB) detected in runtime) (thanks to https://github.com/CodingFabian)
+ * implement possibility to add extra parameters to Access Token Request
+    (AccessTokenRequestParams#*ExtraParameters methods), https://github.com/scribejava/scribejava/issues/980
+    (thanks to https://github.com/pmorch)
 
 [8.1.0]
  * add raw Response (with HTTP response code and body) as member to the OAuth2AccessTokenErrorResponse
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/AccessTokenRequestParams.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/AccessTokenRequestParams.java
@@ -1,12 +1,18 @@
 package com.github.scribejava.core.oauth;
 
 import com.github.scribejava.core.builder.ScopeBuilder;
+import java.util.HashMap;
+import java.util.Map;
 
+/**
+ * not thread safe
+ */
 public class AccessTokenRequestParams {
 
     private final String code;
     private String pkceCodeVerifier;
     private String scope;
+    private Map<String, String> extraParameters;
 
     public AccessTokenRequestParams(String code) {
         this.code = code;
@@ -31,6 +37,34 @@ public AccessTokenRequestParams scope(ScopeBuilder scope) {
         return this;
     }
 
+    public AccessTokenRequestParams addExtraParameters(Map<String, String> extraParameters) {
+        if (extraParameters == null || extraParameters.isEmpty()) {
+            return this;
+        }
+        if (this.extraParameters == null) {
+            extraParameters = new HashMap<>();
+        }
+        this.extraParameters.putAll(extraParameters);
+        return this;
+    }
+
+    public AccessTokenRequestParams addExtraParameter(String name, String value) {
+        if (this.extraParameters == null) {
+            extraParameters = new HashMap<>();
+        }
+        this.extraParameters.put(name, value);
+        return this;
+    }
+
+    public AccessTokenRequestParams setExtraParameters(Map<String, String> extraParameters) {
+        this.extraParameters = extraParameters;
+        return this;
+    }
+
+    public Map<String, String> getExtraParameters() {
+        return extraParameters;
+    }
+
     public String getCode() {
         return code;
     }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuth20Service.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuth20Service.java
@@ -140,6 +140,14 @@ protected OAuthRequest createAccessTokenRequest(AccessTokenRequestParams params)
         if (pkceCodeVerifier != null) {
             request.addParameter(PKCE.PKCE_CODE_VERIFIER_PARAM, pkceCodeVerifier);
         }
+
+        final Map<String, String> extraParameters = params.getExtraParameters();
+        if (extraParameters != null && !extraParameters.isEmpty()) {
+            for (Map.Entry<String, String> extraParameter : extraParameters.entrySet()) {
+                request.addParameter(extraParameter.getKey(), extraParameter.getValue());
+            }
+        }
+
         logRequestWithParams("access token", request);
         return request;
     }
