feat: add resilience layer for Authlete API calls (rate limit best practices)

pom.xml

@@ -157,6 +157,14 @@
       <artifactId>gson</artifactId>
       <version>2.10.1</version>
     </dependency>
+
+    <!-- Test-only: unit tests for the resilience layer. -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13.2</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

src/main/java/com/authlete/jaxrs/server/api/AuthorizationDecisionEndpoint.java

@@ -29,7 +29,7 @@
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.Client;
 import com.authlete.common.types.User;
 import com.authlete.jaxrs.AuthorizationDecisionHandler.Params;
@@ -113,7 +113,7 @@ public Response post(
                 session.getId());
 
         // Handle the end-user's decision.
-        return handle(AuthleteApiFactory.getDefaultApi(), spi, params);
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(), spi, params);
     }
 
 }

src/main/java/com/authlete/jaxrs/server/api/AuthorizationEndpoint.java

@@ -27,7 +27,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.UriInfo;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BaseAuthorizationEndpoint;
 
 
@@ -104,7 +104,7 @@ public Response post(
      */
     private Response handle(HttpServletRequest request, MultivaluedMap<String, String> parameters)
     {
-        return handle(AuthleteApiFactory.getDefaultApi(),
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(),
                 new AuthorizationRequestHandlerSpiImpl(request), parameters);
     }
 }

src/main/java/com/authlete/jaxrs/server/api/ClientRegistrationEndpoint.java

@@ -34,7 +34,7 @@
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.Response.Status;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.util.Utils;
 import com.authlete.jaxrs.BaseClientRegistrationEndpoint;
 import com.authlete.jaxrs.server.obb.util.ObbUtils;
@@ -71,7 +71,7 @@ public Response register(
             @Context HttpServletRequest httpServletRequest)
     {
         // The interface of Authlete APIs.
-        AuthleteApi api = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi api = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Pre-process the request body as necessary.
         json = preprocessRequestBody(httpServletRequest, json);
@@ -92,7 +92,7 @@ public Response read(
             @Context HttpServletRequest httpServletRequest)
     {
         // The interface of Authlete APIs.
-        AuthleteApi api = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi api = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Extra process before executing the "read" operation.
         preprocessClient(httpServletRequest, api, clientId);
@@ -115,7 +115,7 @@ public Response update(
             @Context HttpServletRequest httpServletRequest)
     {
         // The interface of Authlete APIs.
-        AuthleteApi api = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi api = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Pre-process the request body as necessary.
         json = preprocessRequestBody(httpServletRequest, json);
@@ -136,7 +136,7 @@ public Response delete(
             @Context HttpServletRequest httpServletRequest)
     {
         // The interface of Authlete APIs.
-        AuthleteApi api = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi api = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Extra process before executing the "delete" operation.
         preprocessClient(httpServletRequest, api, clientId);

src/main/java/com/authlete/jaxrs/server/api/ConfigurationEndpoint.java

@@ -22,7 +22,7 @@
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.ServiceConfigurationRequest;
 import com.authlete.jaxrs.BaseConfigurationEndpoint;
 
@@ -105,7 +105,7 @@ public Response get(
             )
     {
         // An AuthleteApi instance to access Authlete APIs.
-        AuthleteApi api = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi api = ResilientAuthleteApiFactory.getDefaultApi();
 
         // If either or both of the 'pretty' request parameter
         // and the 'patch' request parameter are given.

src/main/java/com/authlete/jaxrs/server/api/FederationConfigurationEndpoint.java

@@ -20,7 +20,7 @@
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.FederationConfigurationRequest;
 import com.authlete.common.types.EntityType;
 import com.authlete.jaxrs.BaseFederationConfigurationEndpoint;
@@ -78,6 +78,6 @@ public class FederationConfigurationEndpoint extends BaseFederationConfiguration
     public Response get()
     {
         // Handle the request to the endpoint.
-        return handle(AuthleteApiFactory.getDefaultApi(), REQUEST);
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(), REQUEST);
     }
 }

src/main/java/com/authlete/jaxrs/server/api/FederationRegistrationEndpoint.java

@@ -21,7 +21,7 @@
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.FederationRegistrationRequest;
 import com.authlete.jaxrs.BaseFederationRegistrationEndpoint;
 
@@ -89,7 +89,7 @@ public Response entityConfiguration(String jwt)
     {
         // Client registration by a relying party's entity configuration.
         return handle(
-                AuthleteApiFactory.getDefaultApi(),
+                ResilientAuthleteApiFactory.getDefaultApi(),
                 request().setEntityConfiguration(jwt));
     }
 
@@ -100,7 +100,7 @@ public Response trustChain(String json)
     {
         // Client registration by a relying party's trust chain.
         return handle(
-                AuthleteApiFactory.getDefaultApi(),
+                ResilientAuthleteApiFactory.getDefaultApi(),
                 request().setTrustChain(json));
     }
 

src/main/java/com/authlete/jaxrs/server/api/GrantManagementEndpoint.java

@@ -24,7 +24,7 @@
 import javax.ws.rs.PathParam;
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BaseGrantManagementEndpoint;
 
 
@@ -47,7 +47,7 @@ public Response query(
             @PathParam("grantId") String grantId)
     {
         // Handle the grant management 'query' request.
-        return handle(AuthleteApiFactory.getDefaultApi(), req, grantId);
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(), req, grantId);
     }
 
 
@@ -61,6 +61,6 @@ public Response revoke(
             @PathParam("grantId") String grantId)
     {
         // Handle the grant management 'revoke' request.
-        return handle(AuthleteApiFactory.getDefaultApi(), req, grantId);
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(), req, grantId);
     }
 }

src/main/java/com/authlete/jaxrs/server/api/IntrospectionEndpoint.java

@@ -26,7 +26,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.Response.Status;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.web.BasicCredentials;
 import com.authlete.jaxrs.BaseIntrospectionEndpoint;
 import com.authlete.jaxrs.IntrospectionRequestHandler.Params;
@@ -104,7 +104,7 @@ public Response post(
         Params params = buildParams(parameters, accept, rsEntity);
 
         // Handle the introspection request.
-        return handle(AuthleteApiFactory.getDefaultApi(), params);
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(), params);
     }
 
 

src/main/java/com/authlete/jaxrs/server/api/JwksEndpoint.java

@@ -20,7 +20,7 @@
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BaseJwksEndpoint;
 
 
@@ -60,6 +60,6 @@ public class JwksEndpoint extends BaseJwksEndpoint
     public Response get()
     {
         // Handle the JWK Set request.
-        return handle(AuthleteApiFactory.getDefaultApi());
+        return handle(ResilientAuthleteApiFactory.getDefaultApi());
     }
 }

src/main/java/com/authlete/jaxrs/server/api/PushedAuthReqEndpoint.java

@@ -11,7 +11,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BasePushedAuthReqEndpoint;
 import com.authlete.jaxrs.PushedAuthReqHandler.Params;
 
@@ -40,7 +40,7 @@ public Response post(
             MultivaluedMap<String, String> parameters)
     {
         // Authlete API
-        AuthleteApi authleteApi = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi authleteApi = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Parameters for Authlete's pushed_auth_req API.
         Params params = buildParams(request, parameters);

src/main/java/com/authlete/jaxrs/server/api/RevocationEndpoint.java

@@ -27,7 +27,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BaseRevocationEndpoint;
 import com.authlete.jaxrs.RevocationRequestHandler.Params;
 
@@ -57,7 +57,7 @@ public Response post(
             MultivaluedMap<String, String> parameters)
     {
         // Authlete API
-        AuthleteApi authleteApi = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi authleteApi = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Parameters for Authlete's /auth/revocation API
         Params params = buildParams(request, parameters);

src/main/java/com/authlete/jaxrs/server/api/TokenEndpoint.java

@@ -28,7 +28,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.util.Utils;
 import com.authlete.jaxrs.BaseTokenEndpoint;
 import com.authlete.jaxrs.TokenRequestHandler.Params;
@@ -80,7 +80,7 @@ public Response post(
             MultivaluedMap<String, String> parameters)
     {
         // Authlete API
-        AuthleteApi authleteApi = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi authleteApi = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Process the token request in a standard way.
         Response response = processTokenRequest(authleteApi, request, parameters);

src/main/java/com/authlete/jaxrs/server/api/UserInfoEndpoint.java

@@ -26,7 +26,7 @@
 import javax.ws.rs.core.HttpHeaders;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BaseUserInfoEndpoint;
 import com.authlete.jaxrs.UserInfoRequestHandler.Params;
 import com.authlete.jaxrs.util.JaxRsUtils;
@@ -124,7 +124,7 @@ private Response handle(
     {
         Params params = buildParams(request, body, accessToken, dpop);
 
-        return handle(AuthleteApiFactory.getDefaultApi(),
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(),
                 new UserInfoRequestHandlerSpiImpl(), params);
     }
 

src/main/java/com/authlete/jaxrs/server/api/attestation/AttestationChallengeEndpoint.java

@@ -21,7 +21,7 @@
 import javax.ws.rs.Path;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.AttestationChallengeRequest;
 import com.authlete.jaxrs.BaseAttestationChallengeEndpoint;
 
@@ -60,7 +60,7 @@ public class AttestationChallengeEndpoint extends BaseAttestationChallengeEndpoi
     public Response post()
     {
         // Authlete API interface
-        AuthleteApi api = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi api = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Request to the Authlete's /api/{service-id}/attestation/challenge API
         AttestationChallengeRequest request =

src/main/java/com/authlete/jaxrs/server/api/backchannel/BackchannelAuthenticationCallbackEndpoint.java

@@ -27,7 +27,7 @@
 import javax.ws.rs.WebApplicationException;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.BackchannelAuthenticationCompleteRequest.Result;
 import com.authlete.common.types.User;
 import com.authlete.jaxrs.BackchannelAuthenticationCompleteRequestHandler;
@@ -106,7 +106,7 @@ private Response doProcess(AsyncAuthenticationCallbackRequest request)
 
         // Complete the authentication and authorization process.
         new BackchannelAuthenticationCompleteRequestHandler(
-                AuthleteApiFactory.getDefaultApi(),
+                ResilientAuthleteApiFactory.getDefaultApi(),
                 new BackchannelAuthenticationCompleteHandlerSpiImpl(
                         result, user, authTime, acrs, errorDescription, null)
             )

src/main/java/com/authlete/jaxrs/server/api/backchannel/BackchannelAuthenticationEndpoint.java

@@ -27,7 +27,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BackchannelAuthenticationRequestHandler.Params;
 import com.authlete.jaxrs.BaseBackchannelAuthenticationEndpoint;
 
@@ -51,7 +51,7 @@ public Response post(
             MultivaluedMap<String, String> parameters)
     {
         // Authlete API
-        AuthleteApi authleteApi = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi authleteApi = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Parameters for Authlete's /backchannel/authentication API
         Params params = buildParams(request, parameters);

src/main/java/com/authlete/jaxrs/server/api/backchannel/BaseAuthenticationDeviceProcessor.java

@@ -21,7 +21,7 @@
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.dto.Scope;
 import com.authlete.common.dto.BackchannelAuthenticationCompleteRequest.Result;
 import com.authlete.common.types.User;
@@ -296,7 +296,7 @@ protected void completeWithTransactionFailed()
     protected void complete(Result result, Date authTime, String errorDescription, URI errorUri)
     {
         new BackchannelAuthenticationCompleteRequestHandler(
-                AuthleteApiFactory.getDefaultApi(),
+                ResilientAuthleteApiFactory.getDefaultApi(),
                 new BackchannelAuthenticationCompleteHandlerSpiImpl(
                         result, mUser, authTime, mAcrs, errorDescription, errorUri)
             )

src/main/java/com/authlete/jaxrs/server/api/device/DeviceAuthorizationEndpoint.java

@@ -27,7 +27,7 @@
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
 import com.authlete.common.api.AuthleteApi;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.jaxrs.BaseDeviceAuthorizationEndpoint;
 import com.authlete.jaxrs.DeviceAuthorizationRequestHandler.Params;
 
@@ -54,7 +54,7 @@ public Response post(
             MultivaluedMap<String, String> parameters)
     {
         // Authlete API
-        AuthleteApi authleteApi = AuthleteApiFactory.getDefaultApi();
+        AuthleteApi authleteApi = ResilientAuthleteApiFactory.getDefaultApi();
 
         // Parameters for Authlete's /device/authorization API
         Params params = buildParams(request, parameters);

src/main/java/com/authlete/jaxrs/server/api/device/DeviceCompleteEndpoint.java

@@ -28,7 +28,7 @@
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.MultivaluedMap;
 import javax.ws.rs.core.Response;
-import com.authlete.common.api.AuthleteApiFactory;
+import com.authlete.jaxrs.server.resilience.ResilientAuthleteApiFactory;
 import com.authlete.common.types.User;
 import com.authlete.jaxrs.BaseDeviceCompleteEndpoint;
 
@@ -125,7 +125,7 @@ private Response handle(
             MultivaluedMap<String, String> parameters, User user, Date userAuthenticatedAt,
             String[] acrs, String userCode, String[] claimNames)
     {
-        return handle(AuthleteApiFactory.getDefaultApi(), new DeviceCompleteRequestHandlerSpiImpl(
+        return handle(ResilientAuthleteApiFactory.getDefaultApi(), new DeviceCompleteRequestHandlerSpiImpl(
                 parameters, user, userAuthenticatedAt, acrs), userCode, claimNames);
     }
 }