Merge pull request #3 from auth0/sync-mode

Add sync (blocking) mode to all requests

Author: hzalaz

core/src/main/java/com/auth0/Auth0Exception.java

@@ -0,0 +1,39 @@
+/*
+ * Auth0Exception.java
+ *
+ * Copyright (c) 2016 Auth0 (http://auth0.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.auth0;
+
+/**
+ * Base Exception for any error found during a request to Auth0's API
+ */
+public class Auth0Exception extends RuntimeException {
+
+    public Auth0Exception(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public Auth0Exception(String message) {
+        super(message);
+    }
+}

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

@@ -406,7 +406,12 @@ public ParameterizableRequest<Void> passwordlessWithSMS(String phoneNumber, Pass
                 .addParameters(parameters);
     }
 
-    protected ParameterizableRequest<Map<String, Object>> delegation() {
+    /**
+     * Performs a custom <a href="https://auth0.com/docs/auth-api#!#post--delegation">delegation</a> request that will
+     * yield a delegation token.
+     * @return a request to configure and start
+     */
+    public ParameterizableRequest<Map<String, Object>> delegation() {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment("delegation")
                 .build();
@@ -432,7 +437,11 @@ protected <T> ParameterizableRequest<T> delegation(Class<T> clazz) {
                 .addParameters(parameters);
     }
 
-    protected ParameterizableRequest<Void> passwordless() {
+    /**
+     * Start a custom passwordless flow
+     * @return a request to configure and start
+     */
+    public ParameterizableRequest<Void> passwordless() {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment("passwordless")
                 .addPathSegment("start")
@@ -446,7 +455,7 @@ protected ParameterizableRequest<Void> passwordless() {
         return RequestFactory.POST(url, client, mapper)
                 .addParameters(parameters);
     }
-
+    
     protected ParameterizableRequest<Token> loginWithResourceOwner() {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment("oauth")

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

@@ -24,6 +24,7 @@
 
 package com.auth0.authentication;
 
+import com.auth0.Auth0Exception;
 import com.auth0.authentication.api.ParameterBuilder;
 import com.auth0.authentication.api.ParameterizableRequest;
 import com.auth0.authentication.api.Request;
@@ -98,16 +99,34 @@ public void onSuccess(UserProfile profile) {
                             }
 
                             @Override
-                            public void onFailure(Throwable error) {
+                            public void onFailure(Auth0Exception error) {
                                 callback.onFailure(error);
                             }
                         });
             }
 
             @Override
-            public void onFailure(Throwable error) {
+            public void onFailure(Auth0Exception error) {
                 callback.onFailure(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();
+        UserProfile profile = tokenInfoRequest
+                .addParameters(parameters)
+                .execute();
+        return new Authentication(profile, token);
+    }
 }

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

@@ -24,6 +24,7 @@
 
 package com.auth0.authentication;
 
+import com.auth0.Auth0Exception;
 import com.auth0.authentication.api.ParameterizableRequest;
 import com.auth0.authentication.api.callback.BaseCallback;
 
@@ -82,11 +83,21 @@ public ChangePasswordRequest addHeader(String name, String value) {
     }
 
     /**
-     * Performs the HTTP request against Auth0 API
+     * Starts the change password request
      * @param callback called either on success or failure
      */
     @Override
     public void start(final BaseCallback<Void> callback) {
         request.start(callback);
     }
+
+    /**
+     * Executes the change password request
+     * @return nothing on success
+     * @throws Auth0Exception when the change password request fails
+     */
+    @Override
+    public Void execute() throws Auth0Exception {
+        return request.execute();
+    }
 }

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

@@ -24,6 +24,7 @@
 
 package com.auth0.authentication;
 
+import com.auth0.Auth0Exception;
 import com.auth0.authentication.api.ParameterBuilder;
 import com.auth0.authentication.api.ParameterizableRequest;
 import com.auth0.authentication.api.Request;
@@ -33,7 +34,11 @@
 import java.util.Map;
 
 /**
- * Represent a delegation request for Auth0 tokens that will yield a new 'id_token'
+ * 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>}
  */
 public class DelegationRequest<T> implements Request<T> {
 
@@ -65,7 +70,7 @@ public DelegationRequest<T> addParameters(Map<String, Object> parameters) {
     }
 
     /**
-     * Set the api_type parameter to be sent in the request
+     * Set the 'api_type' parameter to be sent in the request
      * @param apiType the delegation api type
      * @return itself
      */
@@ -74,7 +79,7 @@ public DelegationRequest<T> setApiType(String apiType) {
     }
 
     /**
-     * Set the scope used to make the delegation
+     * Set the 'scope' used to make the delegation
      * @param scope value
      * @return itself
      */
@@ -83,7 +88,7 @@ public DelegationRequest<T> setScope(String scope) {
     }
 
     /**
-     * Set the target parameter to be sent in the request
+     * Set the 'target' parameter to be sent in the request
      * @param target the delegation target
      * @return itself
      */
@@ -92,11 +97,21 @@ public DelegationRequest<T> setTarget(String target) {
     }
 
     /**
-     * Performs the HTTP request against Auth0 API
+     * Starts the delegation request against Auth0 API
      * @param callback called either on success or failure
      */
     @Override
     public void start(final BaseCallback<T> callback) {
         request.start(callback);
     }
+
+    /**
+     * Executes the delegation request against Auth0 API
+     * @return the delegation response on success
+     * @throws Auth0Exception when the delegation request fails
+     */
+    @Override
+    public T execute() throws Auth0Exception {
+        return request.execute();
+    }
 }

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

@@ -24,6 +24,7 @@
 
 package com.auth0.authentication;
 
+import com.auth0.Auth0Exception;
 import com.auth0.authentication.api.ParameterizableRequest;
 import com.auth0.authentication.api.Request;
 import com.auth0.authentication.api.callback.BaseCallback;
@@ -98,9 +99,20 @@ public void onSuccess(final DatabaseUser user) {
             }
 
             @Override
-            public void onFailure(Throwable error) {
+            public void onFailure(Auth0Exception error) {
                 callback.onFailure(error);
             }
         });
     }
+
+    /**
+     * Execute the create user request and then logs the user in.
+     * @return authentication object on success
+     * @throws Auth0Exception on failure
+     */
+    @Override
+    public Authentication execute() throws Auth0Exception {
+        signUpRequest.execute();
+        return authenticationRequest.execute();
+    }
 }

…thentication/api/APIClientException.java …th0/authentication/api/APIException.javacore/src/main/java/com/auth0/authentication/api/APIClientException.java renamed to core/src/main/java/com/auth0/authentication/api/APIException.java core/src/main/java/com/auth0/authentication/api/APIClientException.java renamed to core/src/main/java/com/auth0/authentication/api/APIException.java

@@ -24,13 +24,15 @@
 
 package com.auth0.authentication.api;
 
+import com.auth0.Auth0Exception;
+
 import java.util.HashMap;
 import java.util.Map;
 
 /**
  * Internal exception raised when a request to the API fails
  */
-public class APIClientException extends RuntimeException {
+public class APIException extends Auth0Exception {
 
     private int statusCode;
 
@@ -41,7 +43,7 @@ public class APIClientException extends RuntimeException {
      * @param detailMessage error message
      * @param throwable the cause of the exception
      */
-    public APIClientException(String detailMessage, Throwable throwable) {
+    public APIException(String detailMessage, Throwable throwable) {
         super(detailMessage, throwable);
         this.statusCode = -1;
         this.responseError = new HashMap<>();
@@ -53,7 +55,7 @@ public APIClientException(String detailMessage, Throwable throwable) {
      * @param statusCode status code returned by the server
      * @param responseError payload of the error returned by the server
      */
-    public APIClientException(String detailMessage, int statusCode, Map<String, Object> responseError) {
+    public APIException(String detailMessage, int statusCode, Map<String, Object> responseError) {
         super(detailMessage);
         this.statusCode = statusCode;
         this.responseError = responseError != null ? responseError : new HashMap<String, Object>();
@@ -66,7 +68,7 @@ public APIClientException(String detailMessage, int statusCode, Map<String, Obje
      * @param statusCode status code returned by the server
      * @param responseError payload of the error returned by the server
      */
-    public APIClientException(String detailMessage, Throwable throwable, int statusCode, Map<String, Object> responseError) {
+    public APIException(String detailMessage, Throwable throwable, int statusCode, Map<String, Object> responseError) {
         super(detailMessage, throwable);
         this.statusCode = statusCode;
         this.responseError = responseError != null ? responseError : new HashMap<String, Object>();

core/src/main/java/com/auth0/authentication/api/Request.java

@@ -24,6 +24,7 @@
 
 package com.auth0.authentication.api;
 
+import com.auth0.Auth0Exception;
 import com.auth0.authentication.api.callback.BaseCallback;
 
 /**
@@ -32,5 +33,16 @@
  */
 public interface Request<T> {
 
+    /**
+     * Performs an async HTTP request against Auth0 API
+     * @param callback called either on success or failure
+     */
     void start(BaseCallback<T> callback);
+
+    /**
+     * Executes the HTTP request against Auth0 API (blocking the current thread)
+     * @return the response on success
+     * @throws Auth0Exception on failure
+     */
+    T execute() throws Auth0Exception;
 }

core/src/main/java/com/auth0/authentication/api/RequestBodyBuildException.java

@@ -24,10 +24,12 @@
 
 package com.auth0.authentication.api;
 
+import com.auth0.Auth0Exception;
+
 /**
  * Exception that wraps errors when creating a body for a request
  */
-public class RequestBodyBuildException extends RuntimeException {
+public class RequestBodyBuildException extends Auth0Exception {
 
     public RequestBodyBuildException(String message, Throwable cause) {
         super(message, cause);

core/src/main/java/com/auth0/authentication/api/callback/Callback.java

@@ -24,15 +24,17 @@
 
 package com.auth0.authentication.api.callback;
 
+import com.auth0.Auth0Exception;
+
 /**
  * Interface for all callbacks used with Auth0 API clients
  */
 public interface Callback {
 
     /**
      * Method called on Auth0 API request failure
-     * @param error Error with the reason of the failure
+     * @param error Auth0Exception with the reason of the failure
      */
-    void onFailure(Throwable error);
+    void onFailure(Auth0Exception error);
 
 }