refactor ParameterizableRequest, now reveals the ParameterBuilder for direct access usage

Author: lbalmaceda

lib/src/main/java/com/auth0/authentication/AuthenticationAPIClient.java

@@ -39,6 +39,8 @@
  */
 public class AuthenticationRequest implements Request<Authentication> {
 
+    private static final String ID_TOKEN_KEY = "id_token";
+
     private final ParameterizableRequest<Token> credentialsRequest;
     private final ParameterizableRequest<UserProfile> tokenInfoRequest;
 
@@ -49,49 +51,51 @@ public class AuthenticationRequest implements Request<Authentication> {
 
     /**
      * Adds additional parameters for the login request
+     *
      * @param parameters as a non-null dictionary
      * @return itself
      */
     public AuthenticationRequest addParameters(Map<String, Object> parameters) {
-        credentialsRequest.addParameters(parameters);
+        credentialsRequest.getParameterBuilder().addAll(parameters);
         return this;
     }
 
     /**
      * Set the scope used to authenticate the user
+     *
      * @param scope value
      * @return itself
      */
     public AuthenticationRequest setScope(String scope) {
-        credentialsRequest.addParameters(new ParameterBuilder().clearAll().setScope(scope).asDictionary());
+        credentialsRequest.getParameterBuilder().setScope(scope);
         return this;
     }
 
     /**
      * Set the connection used to authenticate
+     *
      * @param connection name
      * @return itself
      */
     public AuthenticationRequest setConnection(String connection) {
-        credentialsRequest.addParameters(new ParameterBuilder().clearAll().setConnection(connection).asDictionary());
+        credentialsRequest.getParameterBuilder().setConnection(connection);
         return this;
     }
 
     /**
      * Starts the log in request and then fetches the user's profile
+     *
      * @param callback called on either success or failure
      */
     @Override
     public void start(final BaseCallback<Authentication> callback) {
         credentialsRequest.start(new BaseCallback<Token>() {
             @Override
             public void onSuccess(final Token token) {
-                Map<String, Object> parameters = new ParameterBuilder()
-                        .clearAll()
-                        .set("id_token", token.getIdToken())
-                        .asDictionary();
                 tokenInfoRequest
-                        .addParameters(parameters)
+                        .getParameterBuilder()
+                        .set(ID_TOKEN_KEY, token.getIdToken());
+                tokenInfoRequest
                         .start(new BaseCallback<UserProfile>() {
                             @Override
                             public void onSuccess(UserProfile profile) {
@@ -114,18 +118,15 @@ public void onFailure(Auth0Exception error) {
 
     /**
      * Logs in the user with Auth0 and fetches it's profile.
+     *
      * @return authentication object containing the user's tokens and profile
      * @throws Auth0Exception when either authentication or profile fetch fails
      */
     @Override
     public Authentication execute() throws Auth0Exception {
         Token token = credentialsRequest.execute();
-        Map<String, Object> parameters = new ParameterBuilder()
-                .clearAll()
-                .set("id_token", token.getIdToken())
-                .asDictionary();
+        tokenInfoRequest.getParameterBuilder().set(ID_TOKEN_KEY, token.getIdToken());
         UserProfile profile = tokenInfoRequest
-                .addParameters(parameters)
                 .execute();
         return new Authentication(profile, token);
     }

lib/src/main/java/com/auth0/authentication/AuthenticationRequest.java

@@ -42,37 +42,34 @@ public class ChangePasswordRequest implements ParameterizableRequest<Void> {
 
     ChangePasswordRequest(ParameterizableRequest<Void> request) {
         this.request = request;
-    }
-
-    private ChangePasswordRequest addParameter(String key, Object value) {
-        Map<String, Object> parameters = new HashMap<>();
-        parameters.put(key, value);
-        return addParameters(parameters);
+        request.getParameterBuilder();
     }
 
     /**
      * Set the 'password' parameter to be sent in the request
+     *
      * @param newPassword the new password
      * @return itself
      */
     public ChangePasswordRequest setNewPassword(String newPassword) {
-        return addParameter(PASSWORD_KEY, newPassword);
+        request.getParameterBuilder().set(PASSWORD_KEY, newPassword);
+        return this;
     }
 
     /**
-     * Adds additional parameters to be sent in the request
-     * @param parameters as a non-null dictionary
-     * @return itself
+     * Getter for this request ParameterBuilder.
+     *
+     * @return the associated ParameterBuilder instance
      */
     @Override
-    public ChangePasswordRequest addParameters(Map<String, Object> parameters) {
-        request.addParameters(parameters);
-        return this;
+    public ParameterBuilder getParameterBuilder() {
+        return request.getParameterBuilder();
     }
 
     /**
      * Adds an additional header for the request
-     * @param name of the header
+     *
+     * @param name  of the header
      * @param value of the header
      * @return itself
      */
@@ -84,6 +81,7 @@ public ChangePasswordRequest addHeader(String name, String value) {
 
     /**
      * Starts the change password request
+     *
      * @param callback called either on success or failure
      */
     @Override
@@ -93,6 +91,7 @@ public void start(final BaseCallback<Void> callback) {
 
     /**
      * Executes the change password request
+     *
      * @return nothing on success
      * @throws Auth0Exception when the change password request fails
      */

lib/src/main/java/com/auth0/authentication/ChangePasswordRequest.java

@@ -25,20 +25,20 @@
 package com.auth0.authentication;
 
 import com.auth0.Auth0Exception;
+import com.auth0.authentication.result.Delegation;
+import com.auth0.callback.BaseCallback;
 import com.auth0.request.ParameterizableRequest;
 import com.auth0.request.Request;
-import com.auth0.callback.BaseCallback;
-import com.auth0.authentication.result.Delegation;
 
-import java.util.HashMap;
 import java.util.Map;
 
 /**
  * Represents a delegation request for Auth0 tokens that will yield a new delegation token.
  * The delegation response depends on the 'api_type' parameter.
+ *
  * @param <T> type of object that will hold the delegation response. When requesting Auth0’s 'id_token' you can
- *           use {@link Delegation}, otherwise you’ll need to provide an object that can be created from the JSON
- *           payload or just use {@code Map<String, Object>}
+ *            use {@link Delegation}, otherwise you’ll need to provide an object that can be created from the JSON
+ *            payload or just use {@code Map<String, Object>}
  */
 public class DelegationRequest<T> implements Request<T> {
 
@@ -54,23 +54,24 @@ public class DelegationRequest<T> implements Request<T> {
     }
 
     private DelegationRequest<T> addParameter(String key, Object value) {
-        Map<String, Object> parameters = new HashMap<>();
-        parameters.put(key, value);
-        return addParameters(parameters);
+        request.getParameterBuilder().set(key, value);
+        return this;
     }
 
     /**
      * Add additional parameters to be sent in the request
+     *
      * @param parameters as a non-null dictionary
      * @return itself
      */
     public DelegationRequest<T> addParameters(Map<String, Object> parameters) {
-        request.addParameters(parameters);
+        request.getParameterBuilder().addAll(parameters);
         return this;
     }
 
     /**
      * Set the 'api_type' parameter to be sent in the request
+     *
      * @param apiType the delegation api type
      * @return itself
      */
@@ -80,15 +81,18 @@ public DelegationRequest<T> setApiType(String apiType) {
 
     /**
      * Set the 'scope' used to make the delegation
+     *
      * @param scope value
      * @return itself
      */
     public DelegationRequest<T> setScope(String scope) {
-        return addParameters(new ParameterBuilder().clearAll().setScope(scope).asDictionary());
+        request.getParameterBuilder().setScope(scope);
+        return this;
     }
 
     /**
      * Set the 'target' parameter to be sent in the request
+     *
      * @param target the delegation target
      * @return itself
      */
@@ -98,6 +102,7 @@ public DelegationRequest<T> setTarget(String target) {
 
     /**
      * Starts the delegation request against Auth0 API
+     *
      * @param callback called either on success or failure
      */
     @Override
@@ -107,6 +112,7 @@ public void start(final BaseCallback<T> callback) {
 
     /**
      * Executes the delegation request against Auth0 API
+     *
      * @return the delegation response on success
      * @throws Auth0Exception when the delegation request fails
      */

lib/src/main/java/com/auth0/authentication/DelegationRequest.java

@@ -177,7 +177,7 @@ public ParameterBuilder addAll(Map<String, Object> parameters) {
      *
      * @return itself
      */
-    public ParameterBuilder clearAll() {
+    public ParameterBuilder clearAllA() {
         parameters.clear();
         return this;
     }

lib/src/main/java/com/auth0/authentication/ParameterBuilder.java

@@ -52,7 +52,7 @@ public class SignUpRequest implements Request<Authentication> {
      * @return itself
      */
     public SignUpRequest addSignUpParameters(Map<String, Object> parameters) {
-        signUpRequest.addParameters(parameters);
+        signUpRequest.getParameterBuilder().addAll(parameters);
         return this;
     }
 

lib/src/main/java/com/auth0/authentication/SignUpRequest.java

@@ -27,6 +27,7 @@
 import com.auth0.APIException;
 import com.auth0.Auth0Exception;
 import com.auth0.RequestBodyBuildException;
+import com.auth0.authentication.ParameterBuilder;
 import com.auth0.callback.BaseCallback;
 import com.auth0.request.AuthorizableRequest;
 import com.auth0.request.ParameterizableRequest;
@@ -47,12 +48,12 @@
 abstract class BaseRequest<T> implements ParameterizableRequest<T>, AuthorizableRequest<T>, Callback {
 
     private final Map<String, String> headers;
-    private final Map<String, Object> parameters;
     protected final HttpUrl url;
     protected final OkHttpClient client;
     private final ObjectReader reader;
     private final ObjectReader errorReader;
     private final ObjectWriter writer;
+    private final ParameterBuilder builder;
 
     private BaseCallback<T> callback;
 
@@ -68,7 +69,7 @@ public BaseRequest(HttpUrl url, OkHttpClient client, ObjectReader reader, Object
         this.writer = writer;
         this.callback = callback;
         this.headers = new HashMap<>();
-        this.parameters = new HashMap<>();
+        this.builder = ParameterBuilder.newEmptyBuilder();
     }
 
     protected void setCallback(BaseCallback<T> callback) {
@@ -92,16 +93,12 @@ protected Request.Builder newBuilder() {
         return builder;
     }
 
-    protected Map<String, Object> getParameters() {
-        return parameters;
-    }
-
     protected ObjectReader getReader() {
         return reader;
     }
 
     protected RequestBody buildBody() throws RequestBodyBuildException {
-        return JsonRequestBodyBuilder.createBody(parameters, writer);
+        return JsonRequestBodyBuilder.createBody(builder.asDictionary(), writer);
     }
 
     protected APIException parseUnsuccessfulResponse(Response response) {
@@ -140,11 +137,8 @@ public AuthorizableRequest<T> setBearer(String jwt) {
     }
 
     @Override
-    public ParameterizableRequest<T> addParameters(Map<String, Object> parameters) {
-        if (parameters != null) {
-            this.parameters.putAll(parameters);
-        }
-        return this;
+    public ParameterBuilder getParameterBuilder() {
+        return builder;
     }
 
     @Override

lib/src/main/java/com/auth0/internal/BaseRequest.java

@@ -24,24 +24,26 @@
 
 package com.auth0.request;
 
-import java.util.Map;
+import com.auth0.authentication.ParameterBuilder;
 
 /**
  * Defines a request that can be configured (payload and headers)
+ *
  * @param <T>
  */
 public interface ParameterizableRequest<T> extends Request<T> {
 
     /**
-     * Adds additional parameters to send in the request
-     * @param parameters as a non-null dictionary
-     * @return itself
+     * Getter for this request ParameterBuilder.
+     *
+     * @return the associated ParameterBuilder instance
      */
-    ParameterizableRequest<T> addParameters(Map<String, Object> parameters);
+    ParameterBuilder getParameterBuilder();
 
     /**
      * Adds an additional header for the request
-     * @param name of the header
+     *
+     * @param name  of the header
      * @param value of the header
      * @return itself
      */