From 9e880486aa3c2267a9d384f1af7defeba52b2eb6 Mon Sep 17 00:00:00 2001 From: Hideki Ikeda Date: Wed, 25 Dec 2024 15:55:38 +0900 Subject: [PATCH 1/4] Add request options to each API call method. --- pom.xml | 2 +- .../jakarta/AccessTokenValidator.java | 224 +++++-- .../authlete/jakarta/AuthleteApiCaller.java | 224 +++---- .../jakarta/AuthorizationDecisionHandler.java | 102 +++- .../jakarta/AuthorizationRequestHandler.java | 84 ++- ...lAuthenticationCompleteRequestHandler.java | 66 ++- ...ckchannelAuthenticationRequestHandler.java | 100 +++- .../BaseAuthorizationDecisionEndpoint.java | 118 +++- .../jakarta/BaseAuthorizationEndpoint.java | 61 +- ...BaseBackchannelAuthenticationEndpoint.java | 64 +- .../BaseClientRegistrationEndpoint.java | 174 +++++- .../jakarta/BaseConfigurationEndpoint.java | 85 ++- .../BaseCredentialIssuerMetadataEndpoint.java | 114 ++-- ...seCredentialJwtIssuerMetadataEndpoint.java | 114 ++-- .../BaseCredentialOfferUriEndpoint.java | 12 +- .../BaseDeviceAuthorizationEndpoint.java | 49 +- .../jakarta/BaseDeviceCompleteEndpoint.java | 47 +- .../BaseDeviceVerificationEndpoint.java | 38 +- .../BaseFederationConfigurationEndpoint.java | 111 +++- .../BaseFederationRegistrationEndpoint.java | 54 +- .../jakarta/BaseGrantManagementEndpoint.java | 45 +- .../jakarta/BaseIntrospectionEndpoint.java | 70 ++- .../authlete/jakarta/BaseJwksEndpoint.java | 32 +- .../jakarta/BasePushedAuthReqEndpoint.java | 96 ++- .../jakarta/BaseResourceEndpoint.java | 246 +++++++- .../jakarta/BaseRevocationEndpoint.java | 46 +- .../authlete/jakarta/BaseTokenEndpoint.java | 164 ++++- .../jakarta/BaseUserInfoEndpoint.java | 93 ++- .../ClientRegistrationRequestHandler.java | 135 ++++- .../jakarta/ConfigurationRequestHandler.java | 86 ++- ...redentialIssuerMetadataRequestHandler.java | 32 +- ...entialJwtIssuerMetadataRequestHandler.java | 29 +- .../CredentialOfferUriRequestHandler.java | 12 +- .../DeviceAuthorizationRequestHandler.java | 51 +- .../jakarta/DeviceCompleteRequestHandler.java | 62 +- .../DeviceVerificationRequestHandler.java | 33 +- ...FederationConfigurationRequestHandler.java | 33 +- .../FederationRegistrationRequestHandler.java | 33 +- .../authlete/jakarta/GMRequestHandler.java | 30 +- .../jakarta/IntrospectionRequestHandler.java | 74 ++- .../authlete/jakarta/JwksRequestHandler.java | 58 +- .../jakarta/PushedAuthReqHandler.java | 83 ++- .../jakarta/RevocationRequestHandler.java | 49 +- .../authlete/jakarta/TokenRequestHandler.java | 166 +++++- .../jakarta/UserInfoRequestHandler.java | 88 ++- .../authlete/jakarta/api/AuthleteApiImpl.java | 558 +++++++++++------- .../jakarta/api/AuthleteApiImplV3.java | 552 ++++++++++------- .../jakarta/api/AuthleteApiJaxrsImpl.java | 81 ++- 48 files changed, 3774 insertions(+), 1106 deletions(-) diff --git a/pom.xml b/pom.xml index f3ad8f8..65b5666 100644 --- a/pom.xml +++ b/pom.xml @@ -28,7 +28,7 @@ UTF-8 - 4.1 + 4.16 2.10.1 9.31 3.1.0 diff --git a/src/main/java/com/authlete/jakarta/AccessTokenValidator.java b/src/main/java/com/authlete/jakarta/AccessTokenValidator.java index 2e943cb..d583897 100644 --- a/src/main/java/com/authlete/jakarta/AccessTokenValidator.java +++ b/src/main/java/com/authlete/jakarta/AccessTokenValidator.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2023 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,6 +24,7 @@ import jakarta.ws.rs.core.Response; import jakarta.ws.rs.core.Response.Status; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.IntrospectionRequest; import com.authlete.common.dto.IntrospectionResponse; import com.authlete.common.dto.IntrospectionResponse.Action; @@ -337,16 +338,8 @@ public AccessTokenValidator(AuthleteApi api) /** - * Validate an access token. This method is an alias of the - * {@link #validate(Params)} method. - * - *

- * When the given access token is not valid, this method throws a - * {@link WebApplicationException}. The response contained in the - * exception complies with the requirements described in RFC 6750 (The OAuth - * 2.0 Authorization Framework: Bearer Token Usage). - *

+ * Validate an access token. This method is an alias of + * {@link #validate(String, Options) validate}{@code (accessToken, (Options)null)}. * * @param accessToken * An access token to validate. @@ -360,25 +353,38 @@ public AccessTokenValidator(AuthleteApi api) */ public AccessTokenInfo validate(String accessToken) throws WebApplicationException { - Params params = new Params() - .setAccessToken(accessToken) - ; - - return validate(params); + return validate(accessToken, (Options)null); } /** - * Validate an access token. This method is an alias of the - * {@link #validate(Params)} method. + * Validate an access token. This method is an alias of {@link + * #validate(String, String[], Options) validate}{@code (accessToken, null, options)}. * - *

- * When the given access token is not valid, this method throws a - * {@link WebApplicationException}. The response contained in the - * exception complies with the requirements described in RFC 6750 (The OAuth - * 2.0 Authorization Framework: Bearer Token Usage). - *

+ * @param accessToken + * An access token to validate. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, the access + * token does not exist or it has expired. + * + * @since 2.82 + */ + public AccessTokenInfo validate(String accessToken, Options options) throws WebApplicationException + { + return validate(accessToken, null, options); + } + + + /** + * Validate an access token. This method is an alias of + * {@link #validate(String, String[], Options) validate}{@code (accessToken, requiredScopes, null)}. * * @param accessToken * An access token to validate. @@ -402,18 +408,93 @@ public AccessTokenInfo validate(String accessToken) throws WebApplicationExcepti public AccessTokenInfo validate( String accessToken, String[] requiredScopes) throws WebApplicationException { - Params params = new Params() - .setAccessToken(accessToken) - .setRequiredScopes(requiredScopes) - ; + return validate(accessToken, requiredScopes, null); + } + - return validate(params); + /** + * Validate an access token. This method is an alias of + * {@link #validate(String, String[], String, String, Options) validate}{@code + * (accessToken, requiredScopes, null, null, options)}. + * + * @param accessToken + * An access token to validate. + * + * @param requiredScopes + * Scopes that must be associated with the access token. + * {@code null} is okay. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, one or more of + * the following conditions meet. + *
    + *
  1. The access token does not exist. + *
  2. The access token has expired. + *
  3. The access token does not cover the required scopes. + *
+ * + * @since 2.82 + */ + public AccessTokenInfo validate( + String accessToken, String[] requiredScopes, Options options) throws WebApplicationException + { + return validate(accessToken, requiredScopes, null, null, options); + } + + + /** + * Validate an access token. This method is an alias of + * {@link #validate(String, String[], String, String, Options) validate}{@code + * (accessToken, requiredScopes, requiredSubject, clientCertificate, null)}. + * + * @param accessToken + * An access token to validate. + * + * @param requiredScopes + * Scopes that must be associated with the access token. + * {@code null} is okay. + * + * @param requiredSubject + * Subject (= user's unique identifier) that must be associated + * with the access token. {@code null} is okay. + * + * @param clientCertificate + * TLS Certificate of the client presented during a call to + * the resource server, used with TLS-bound access tokens. + * Can be {@code null} if no certificate is presented. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, one or more of + * the following conditions meet. + *
    + *
  1. The access token does not exist. + *
  2. The access token has expired. + *
  3. The access token does not cover the required scopes. + *
  4. The access token is not associated with the required subject. + *
  5. The access token is bound to a client certificate, but the + * presented one does not match. + *
+ */ + public AccessTokenInfo validate( + String accessToken, String[] requiredScopes, + String requiredSubject, String clientCertificate) throws WebApplicationException + { + return validate(accessToken, requiredScopes, requiredSubject, clientCertificate, null); } /** * Validate an access token. This method is an alias of the - * {@link #validate(Params)} method. + * {@link #validate(Params, Options)} method. * *

* When the given access token is not valid, this method throws a @@ -439,6 +520,9 @@ public AccessTokenInfo validate( * the resource server, used with TLS-bound access tokens. * Can be {@code null} if no certificate is presented. * + * @param options + * Request options for {@code /api/auth/introspection} API. + * * @return * Information about the access token. * @@ -453,10 +537,13 @@ public AccessTokenInfo validate( *
  • The access token is bound to a client certificate, but the * presented one does not match. * + * + * @since 2.82 */ public AccessTokenInfo validate( String accessToken, String[] requiredScopes, - String requiredSubject, String clientCertificate) throws WebApplicationException + String requiredSubject, String clientCertificate, Options options) + throws WebApplicationException { Params params = new Params() .setAccessToken(accessToken) @@ -465,12 +552,13 @@ public AccessTokenInfo validate( .setClientCertificate(clientCertificate) ; - return validate(params); + return validate(params, options); } /** - * Validate an access token. + * Validate an access token. This method is an alias of + * {@link #validate(Params, Options) validate}{@code (params, null)}. * * @param params * Parameters needed for access token validation. @@ -484,6 +572,29 @@ public AccessTokenInfo validate( * @since 2.27 */ public AccessTokenInfo validate(Params params) throws WebApplicationException + { + return validate(params, null); + } + + + /** + * Validate an access token. + * + * @param params + * Parameters needed for access token validation. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. + * + * @since 2.82 + */ + public AccessTokenInfo validate(Params params, Options options) throws WebApplicationException { if (params == null || params.getAccessToken() == null) { @@ -493,7 +604,7 @@ public AccessTokenInfo validate(Params params) throws WebApplicationException try { - return process(params); + return process(params, options); } catch (WebApplicationException e) { @@ -508,7 +619,8 @@ public AccessTokenInfo validate(Params params) throws WebApplicationException /** - * Validate an access token. + * Validate an access token. This method is an alias of the + * {@link #validate(IntrospectionRequest, Options) validate}{@code (request, null)}. * * @param request * The request parameters to Authlete's {@code /auth/introspection} API. @@ -525,10 +637,37 @@ public AccessTokenInfo validate(Params params) throws WebApplicationException * @since 2.66 */ public IntrospectionResponse validate(IntrospectionRequest request) throws WebApplicationException + { + return validate(request, null); + } + + + /** + * Validate an access token. + * + * @param request + * The request parameters to Authlete's {@code /auth/introspection} API. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * The response from the Authlete's {@code /auth/introspection} API. + * + * @throws WebApplicationException + * The access token is invalid or something unexpected happened. + * This exception is raised when the {@code action} response parameter + * in the response from the {@code /auth/introspection} API is not + * {@link IntrospectionResponse.Action#OK OK}. + * + * @since 2.82 + */ + public IntrospectionResponse validate( + IntrospectionRequest request, Options options) throws WebApplicationException { try { - return process(request); + return process(request, options); } catch (WebApplicationException e) { @@ -542,7 +681,8 @@ public IntrospectionResponse validate(IntrospectionRequest request) throws WebAp } - private AccessTokenInfo process(Params params) throws WebApplicationException + + private AccessTokenInfo process(Params params, Options options) throws WebApplicationException { // Call Authlete's /api/auth/introspection API. IntrospectionResponse response = getApiCaller().callIntrospection( @@ -552,7 +692,8 @@ private AccessTokenInfo process(Params params) throws WebApplicationException params.getClientCertificate(), params.getDpop(), params.getHtm(), - params.getHtu() + params.getHtu(), + options ); // Handle the response from the /auth/introspection API. @@ -563,10 +704,11 @@ private AccessTokenInfo process(Params params) throws WebApplicationException } - private IntrospectionResponse process(IntrospectionRequest request) throws WebApplicationException + private IntrospectionResponse process( + IntrospectionRequest request, Options options) throws WebApplicationException { // Call Authlete's /api/auth/introspection API. - IntrospectionResponse response = getApiCaller().callIntrospection(request); + IntrospectionResponse response = getApiCaller().callIntrospection(request, options); // Handle the response from the /auth/introspection API. handleIntrospectionResponse(response); diff --git a/src/main/java/com/authlete/jakarta/AuthleteApiCaller.java b/src/main/java/com/authlete/jakarta/AuthleteApiCaller.java index e387ec0..247f3be 100644 --- a/src/main/java/com/authlete/jakarta/AuthleteApiCaller.java +++ b/src/main/java/com/authlete/jakarta/AuthleteApiCaller.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015-2023 Authlete, Inc. + * Copyright (C) 2015-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -28,6 +28,7 @@ import jakarta.ws.rs.core.Response.Status; import com.authlete.common.api.AuthleteApi; import com.authlete.common.api.AuthleteApiException; +import com.authlete.common.api.Options; import com.authlete.common.dto.AuthorizationFailRequest; import com.authlete.common.dto.AuthorizationFailResponse; import com.authlete.common.dto.AuthorizationIssueRequest; @@ -170,18 +171,18 @@ private InternalServerErrorException internalServerError(String message, Throwab /** * Call Authlete's {@code /api/auth/authorization} API. */ - public AuthorizationResponse callAuthorization(MultivaluedMap parameters) + public AuthorizationResponse callAuthorization(MultivaluedMap parameters, Options options) { String params = URLCoder.formUrlEncode(parameters); - return callAuthorization(params); + return callAuthorization(params, options); } /** * Call Authlete's {@code /api/auth/authorization} API. */ - private AuthorizationResponse callAuthorization(String parameters) + private AuthorizationResponse callAuthorization(String parameters, Options options) { if (parameters == null) { @@ -198,7 +199,7 @@ private AuthorizationResponse callAuthorization(String parameters) try { // Call Authlete's /api/auth/authorization API. - return mApi.authorization(request); + return mApi.authorization(request, options); } catch (AuthleteApiException e) { @@ -211,7 +212,8 @@ private AuthorizationResponse callAuthorization(String parameters) /** * Call Authlete's {@code /api/auth/authorization/fail} API. */ - private AuthorizationFailResponse callAuthorizationFail(String ticket, AuthorizationFailRequest.Reason reason) + private AuthorizationFailResponse callAuthorizationFail( + String ticket, AuthorizationFailRequest.Reason reason, Options options) { // Create a request for /api/auth/authorization/fail API. AuthorizationFailRequest request = new AuthorizationFailRequest() @@ -221,7 +223,7 @@ private AuthorizationFailResponse callAuthorizationFail(String ticket, Authoriza try { // Call Authlete's /api/auth/authorization/fail API. - return mApi.authorizationFail(request); + return mApi.authorizationFail(request, options); } catch (AuthleteApiException e) { @@ -235,10 +237,11 @@ private AuthorizationFailResponse callAuthorizationFail(String ticket, Authoriza * Create a response that describes the failure. This method * calls Authlete's {@code /api/auth/authorization/fail} API. */ - private Response createAuthorizationFailResponse(String ticket, AuthorizationFailRequest.Reason reason) + private Response createAuthorizationFailResponse( + String ticket, AuthorizationFailRequest.Reason reason, Options options) { // Call Authlete's /api/auth/authorization/fail API. - AuthorizationFailResponse response = callAuthorizationFail(ticket, reason); + AuthorizationFailResponse response = callAuthorizationFail(ticket, reason, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -278,11 +281,12 @@ private Response createAuthorizationFailResponse(String ticket, AuthorizationFai * Create an exception that describes the failure. This method * calls Authlete's {@code /api/auth/authorization/fail} API. */ - public WebApplicationException authorizationFail(String ticket, AuthorizationFailRequest.Reason reason) + public WebApplicationException authorizationFail( + String ticket, AuthorizationFailRequest.Reason reason, Options options) { // Create a response to the client application with the help of // Authlete's /api/auth/authorization/fail API. - Response response = createAuthorizationFailResponse(ticket, reason); + Response response = createAuthorizationFailResponse(ticket, reason, options); // Create an exception containing the response. return new WebApplicationException(response); @@ -296,7 +300,7 @@ private AuthorizationIssueResponse callAuthorizationIssue( String ticket, String subject, long authTime, String acr, Map claims, Property[] properties, String[] scopes, String sub, Map claimsForTx, - List> verifiedClaimsForTx) + List> verifiedClaimsForTx, Options options) { // Create a request for /api/auth/authorization/issue API. AuthorizationIssueRequest request = new AuthorizationIssueRequest() @@ -319,7 +323,7 @@ private AuthorizationIssueResponse callAuthorizationIssue( try { // Call Authlete's /api/auth/authorization/issue API. - return mApi.authorizationIssue(request); + return mApi.authorizationIssue(request, options); } catch (AuthleteApiException e) { @@ -335,9 +339,11 @@ private AuthorizationIssueResponse callAuthorizationIssue( */ public Response authorizationIssue( String ticket, String subject, long authTime, String acr, - Map claims, Property[] properties, String[] scopes) + Map claims, Property[] properties, String[] scopes, + Options options) { - return authorizationIssue(ticket, subject, authTime, acr, claims, properties, scopes, null); + return authorizationIssue( + ticket, subject, authTime, acr, claims, properties, scopes, null, options); } @@ -347,10 +353,10 @@ public Response authorizationIssue( */ public Response authorizationIssue( String ticket, String subject, long authTime, String acr, - Map claims, Property[] properties, String[] scopes, String sub) + Map claims, Property[] properties, String[] scopes, String sub, Options options) { return authorizationIssue( - ticket, subject, authTime, acr, claims, properties, scopes, sub, null, null); + ticket, subject, authTime, acr, claims, properties, scopes, sub, null, null, options); } @@ -362,12 +368,12 @@ public Response authorizationIssue( String ticket, String subject, long authTime, String acr, Map claims, Property[] properties, String[] scopes, String sub, Map claimsForTx, - List> verifiedClaimsForTx) + List> verifiedClaimsForTx, Options options) { // Call Authlete's /api/auth/authorization/issue API. AuthorizationIssueResponse response = callAuthorizationIssue(ticket, subject, authTime, acr, claims, - properties, scopes, sub, claimsForTx, verifiedClaimsForTx); + properties, scopes, sub, claimsForTx, verifiedClaimsForTx, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -409,13 +415,13 @@ public Response authorizationIssue( public TokenResponse callToken( MultivaluedMap parameters, String clientId, String clientSecret, Property[] properties, String clientCertificate, String[] clientCertificatePath, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options options) { String params = URLCoder.formUrlEncode(parameters); return callToken(params, clientId, clientSecret, properties, clientCertificate, clientCertificatePath, - dpop, htm, htu); + dpop, htm, htu, options); } @@ -425,7 +431,7 @@ public TokenResponse callToken( public TokenResponse callToken( String parameters, String clientId, String clientSecret, Property[] properties, String clientCertificate, String[] clientCertificatePath, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options options) { if (parameters == null) { @@ -451,7 +457,7 @@ public TokenResponse callToken( try { // Call Authlete's /api/auth/token API. - return mApi.token(request); + return mApi.token(request, options); } catch (AuthleteApiException e) { @@ -464,7 +470,8 @@ public TokenResponse callToken( /** * Call Authlete's {@code /api/auth/token/fail} API. */ - private TokenFailResponse callTokenFail(String ticket, TokenFailRequest.Reason reason) + private TokenFailResponse callTokenFail( + String ticket, TokenFailRequest.Reason reason, Options options) { // Create a request for /api/auth/token/fail API. TokenFailRequest request = new TokenFailRequest() @@ -474,7 +481,7 @@ private TokenFailResponse callTokenFail(String ticket, TokenFailRequest.Reason r try { // Call Authlete's /api/auth/token/fail API. - return mApi.tokenFail(request); + return mApi.tokenFail(request, options); } catch (AuthleteApiException e) { @@ -490,10 +497,10 @@ private TokenFailResponse callTokenFail(String ticket, TokenFailRequest.Reason r */ private Response createTokenFailResponse( String ticket, TokenFailRequest.Reason reason, - Map headers) + Map headers, Options options) { // Call Authlete's /api/auth/token/fail API. - TokenFailResponse response = callTokenFail(ticket, reason); + TokenFailResponse response = callTokenFail(ticket, reason, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -526,11 +533,11 @@ private Response createTokenFailResponse( */ public WebApplicationException tokenFail( String ticket, TokenFailRequest.Reason reason, - Map headers) + Map headers, Options options) { // Create a response to the client application with the help of // Authlete's /api/auth/token/fail API. - Response response = createTokenFailResponse(ticket, reason, headers); + Response response = createTokenFailResponse(ticket, reason, headers, options); // Create an exception containing the response. return new WebApplicationException(response); @@ -541,7 +548,7 @@ public WebApplicationException tokenFail( * Call Authlete's {@code /api/auth/token/issue} API. */ private TokenIssueResponse callTokenIssue( - String ticket, String subject, Property[] properties) + String ticket, String subject, Property[] properties, Options options) { // Create a request for Authlete's /api/auth/token/issue API. TokenIssueRequest request = new TokenIssueRequest() @@ -569,10 +576,10 @@ private TokenIssueResponse callTokenIssue( */ public Response tokenIssue( String ticket, String subject, Property[] properties, - Map headers) + Map headers, Options options) { // Call Authlete's /api/auth/token/issue API. - TokenIssueResponse response = callTokenIssue(ticket, subject, properties); + TokenIssueResponse response = callTokenIssue(ticket, subject, properties, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -602,12 +609,12 @@ public Response tokenIssue( /** * Call Authlete's {@code /api/service/configuration} API. */ - public String callServiceConfiguration(boolean pretty) + public String callServiceConfiguration(boolean pretty, Options options) { try { // Call Authlete's /api/service/configuration API. - return mApi.getServiceConfiguration(pretty); + return mApi.getServiceConfiguration(pretty, options); } catch (AuthleteApiException e) { @@ -620,12 +627,12 @@ public String callServiceConfiguration(boolean pretty) /** * Call Authlete's {@code /api/service/configuration} API. */ - public String callServiceConfiguration(ServiceConfigurationRequest request) + public String callServiceConfiguration(ServiceConfigurationRequest request, Options options) { try { // Call Authlete's /api/service/configuration API. - return mApi.getServiceConfiguration(request); + return mApi.getServiceConfiguration(request, options); } catch (AuthleteApiException e) { @@ -640,12 +647,12 @@ public String callServiceConfiguration(ServiceConfigurationRequest request) * {@code /api/service/jwks/get} API. */ public Response serviceJwksGet( - boolean pretty, boolean includePrivateKeys) throws AuthleteApiException + boolean pretty, boolean includePrivateKeys, Options options) throws AuthleteApiException { try { // Call Authlete's /api/service/jwks/get API. - String jwks = mApi.getServiceJwks(pretty, includePrivateKeys); + String jwks = mApi.getServiceJwks(pretty, includePrivateKeys, options); if (jwks == null || jwks.length() == 0) { @@ -695,18 +702,20 @@ private static String getFirst(Map> map, String key) /** * Call Authlete's {@code /api/auth/revocation} API. */ - public RevocationResponse callRevocation(MultivaluedMap parameters, String clientId, String clientSecret) + public RevocationResponse callRevocation( + MultivaluedMap parameters, String clientId, String clientSecret, Options options) { String params = URLCoder.formUrlEncode(parameters); - return callRevocation(params, clientId, clientSecret); + return callRevocation(params, clientId, clientSecret, options); } /** * Call Authlete's {@code /api/auth/revocation} API. */ - private RevocationResponse callRevocation(String parameters, String clientId, String clientSecret) + private RevocationResponse callRevocation( + String parameters, String clientId, String clientSecret, Options options) { if (parameters == null) { @@ -725,7 +734,7 @@ private RevocationResponse callRevocation(String parameters, String clientId, St try { // Call Authlete's /api/auth/revocation API. - return mApi.revocation(request); + return mApi.revocation(request, options); } catch (AuthleteApiException e) { @@ -739,7 +748,7 @@ private RevocationResponse callRevocation(String parameters, String clientId, St * Call Authlete's {@code /api/auth/userinfo} API. */ public UserInfoResponse callUserInfo( - String accessToken, String clientCertificate, String dpop, String htm, String htu) + String accessToken, String clientCertificate, String dpop, String htm, String htu, Options options) { // Create a request for Authlete's /api/auth/userinfo API. UserInfoRequest request = new UserInfoRequest() @@ -753,7 +762,7 @@ public UserInfoResponse callUserInfo( try { // Call Authlete's /api/auth/userinfo API. - return mApi.userinfo(request); + return mApi.userinfo(request, options); } catch (AuthleteApiException e) { @@ -768,7 +777,7 @@ public UserInfoResponse callUserInfo( */ private UserInfoIssueResponse callUserInfoIssue(String accessToken, Map claims, Map claimsForTx, - List> verifiedClaimsForTx) + List> verifiedClaimsForTx, Options options) { // Create a request for /api/auth/userinfo/issue API. UserInfoIssueRequest request = new UserInfoIssueRequest() @@ -792,7 +801,7 @@ private UserInfoIssueResponse callUserInfoIssue(String accessToken, try { // Call Authlete's /api/auth/userinfo/issue API. - return mApi.userinfoIssue(request); + return mApi.userinfoIssue(request, options); } catch (AuthleteApiException e) { @@ -808,11 +817,11 @@ private UserInfoIssueResponse callUserInfoIssue(String accessToken, public Response userInfoIssue(String accessToken, Map claims, Map claimsForTx, List> verifiedClaimsForTx, - Map headers) + Map headers, Options options) { // Call Authlete's /api/auth/userinfo/issue API. UserInfoIssueResponse response = callUserInfoIssue( - accessToken, claims, claimsForTx, verifiedClaimsForTx); + accessToken, claims, claimsForTx, verifiedClaimsForTx, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -861,7 +870,7 @@ public Response userInfoIssue(String accessToken, */ public IntrospectionResponse callIntrospection( String accessToken, String[] scopes, String subject, String clientCertificate, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options options) { // Create a request for /api/auth/introspection API. IntrospectionRequest request = new IntrospectionRequest() @@ -874,16 +883,16 @@ public IntrospectionResponse callIntrospection( .setHtu(htu) ; - return callIntrospection(request); + return callIntrospection(request, options); } - public IntrospectionResponse callIntrospection(IntrospectionRequest request) + public IntrospectionResponse callIntrospection(IntrospectionRequest request, Options options) { try { // Call Authlete's /api/auth/introspection API. - return mApi.introspection(request); + return mApi.introspection(request, options); } catch (AuthleteApiException e) { @@ -899,13 +908,13 @@ public IntrospectionResponse callIntrospection(IntrospectionRequest request) public StandardIntrospectionResponse callStandardIntrospection( MultivaluedMap parameters, boolean withHiddenProperties, String httpAcceptHeader, URI rsUri, JWSAlg introspectionSignAlg, JWEAlg introspectionEncAlg, JWEEnc introspectionEncEnc, - String sharedKeyForSign, String sharedKeyForEncryption, String publicKeyForEncryption) + String sharedKeyForSign, String sharedKeyForEncryption, String publicKeyForEncryption, Options options) { String params = URLCoder.formUrlEncode(parameters); return callStandardIntrospection( params, withHiddenProperties, httpAcceptHeader, rsUri, introspectionSignAlg, introspectionEncAlg, - introspectionEncEnc, sharedKeyForSign, sharedKeyForEncryption, publicKeyForEncryption); + introspectionEncEnc, sharedKeyForSign, sharedKeyForEncryption, publicKeyForEncryption, options); } @@ -915,7 +924,8 @@ public StandardIntrospectionResponse callStandardIntrospection( private StandardIntrospectionResponse callStandardIntrospection( String parameters, boolean withHiddenProperties, String httpAcceptHeader, URI rsUri, JWSAlg introspectionSignAlg, JWEAlg introspectionEncAlg, JWEEnc introspectionEncEnc, - String sharedKeyForSign, String sharedKeyForEncryption, String publicKeyForEncryption) + String sharedKeyForSign, String sharedKeyForEncryption, String publicKeyForEncryption, + Options options) { if (parameters == null) { @@ -941,7 +951,7 @@ private StandardIntrospectionResponse callStandardIntrospection( try { // Call Authlete's /api/auth/introspection/standard API. - return mApi.standardIntrospection(request); + return mApi.standardIntrospection(request, options); } catch (AuthleteApiException e) { @@ -956,11 +966,12 @@ private StandardIntrospectionResponse callStandardIntrospection( */ public BackchannelAuthenticationResponse callBackchannelAuthentication( MultivaluedMap parameters, String clientId, String clientSecret, - String clientCertificate, String[] clientCertificatePath) + String clientCertificate, String[] clientCertificatePath, Options options) { String params = URLCoder.formUrlEncode(parameters); - return callBackchannelAuthentication(params, clientId, clientSecret, clientCertificate, clientCertificatePath); + return callBackchannelAuthentication( + params, clientId, clientSecret, clientCertificate, clientCertificatePath, options); } @@ -969,7 +980,7 @@ public BackchannelAuthenticationResponse callBackchannelAuthentication( */ private BackchannelAuthenticationResponse callBackchannelAuthentication( String parameters, String clientId, String clientSecret, - String clientCertificate, String[] clientCertificatePath) + String clientCertificate, String[] clientCertificatePath, Options options) { if (parameters == null) { @@ -991,7 +1002,7 @@ private BackchannelAuthenticationResponse callBackchannelAuthentication( try { // Call Authlete's /api/backchannel/authentication API. - return mApi.backchannelAuthentication(request); + return mApi.backchannelAuthentication(request, options); } catch (AuthleteApiException e) { @@ -1004,7 +1015,8 @@ private BackchannelAuthenticationResponse callBackchannelAuthentication( /** * Call Authlete's {@code /api/backchannel/authentication/fail} API. */ - private BackchannelAuthenticationFailResponse callBackchannelAuthenticationFail(String ticket, BackchannelAuthenticationFailRequest.Reason reason) + private BackchannelAuthenticationFailResponse callBackchannelAuthenticationFail( + String ticket, BackchannelAuthenticationFailRequest.Reason reason, Options options) { // Create a request for /api/backchannel/authentication/fail API. BackchannelAuthenticationFailRequest request = new BackchannelAuthenticationFailRequest() @@ -1015,7 +1027,7 @@ private BackchannelAuthenticationFailResponse callBackchannelAuthenticationFail( try { // Call Authlete's /api/backchannel/authentication/fail API. - return mApi.backchannelAuthenticationFail(request); + return mApi.backchannelAuthenticationFail(request, options); } catch (AuthleteApiException e) { @@ -1029,10 +1041,11 @@ private BackchannelAuthenticationFailResponse callBackchannelAuthenticationFail( * Create a response that describes the failure. This method * calls Authlete's {@code /api/backchannel/authentication/fail} API. */ - private Response createBackchannelAuthenticationFailResponse(String ticket, BackchannelAuthenticationFailRequest.Reason reason) + private Response createBackchannelAuthenticationFailResponse( + String ticket, BackchannelAuthenticationFailRequest.Reason reason, Options options) { // Call Authlete's /api/backchannel/authentication/fail API. - BackchannelAuthenticationFailResponse response = callBackchannelAuthenticationFail(ticket, reason); + BackchannelAuthenticationFailResponse response = callBackchannelAuthenticationFail(ticket, reason, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -1068,11 +1081,12 @@ private Response createBackchannelAuthenticationFailResponse(String ticket, Back * Create an exception that describes the failure. This method * calls Authlete's {@code /api/backchannel/authentication/fail} API. */ - public WebApplicationException backchannelAuthenticationFail(String ticket, BackchannelAuthenticationFailRequest.Reason reason) + public WebApplicationException backchannelAuthenticationFail( + String ticket, BackchannelAuthenticationFailRequest.Reason reason, Options options) { // Create a response to the client application with the help of // Authlete's /api/backchannel/authentication/fail API. - Response response = createBackchannelAuthenticationFailResponse(ticket, reason); + Response response = createBackchannelAuthenticationFailResponse(ticket, reason, options); // Create an exception containing the response. return new WebApplicationException(response); @@ -1082,7 +1096,8 @@ public WebApplicationException backchannelAuthenticationFail(String ticket, Back /** * Call Authlete's {@code /api/backchannel/authentication/issue} API. */ - public BackchannelAuthenticationIssueResponse callBackchannelAuthenticationIssue(String ticket) + public BackchannelAuthenticationIssueResponse callBackchannelAuthenticationIssue( + String ticket, Options options) { // Create a request for /api/backchannel/authentication/issue API. BackchannelAuthenticationIssueRequest request = new BackchannelAuthenticationIssueRequest() @@ -1092,7 +1107,7 @@ public BackchannelAuthenticationIssueResponse callBackchannelAuthenticationIssue try { // Call Authlete's /api/backchannel/authentication/issue API. - return mApi.backchannelAuthenticationIssue(request); + return mApi.backchannelAuthenticationIssue(request, options); } catch (AuthleteApiException e) { @@ -1108,7 +1123,7 @@ public BackchannelAuthenticationIssueResponse callBackchannelAuthenticationIssue public BackchannelAuthenticationCompleteResponse callBackchannelAuthenticationComplete( String ticket, String subject, Result result, long authTime, String acr, Map claims, Property[] properties, String[] scopes, - String errorDescription, URI errorUri) + String errorDescription, URI errorUri, Options options) { // Create a request for /api/backchannel/authentication/complete API. BackchannelAuthenticationCompleteRequest request = new BackchannelAuthenticationCompleteRequest() @@ -1131,7 +1146,7 @@ public BackchannelAuthenticationCompleteResponse callBackchannelAuthenticationCo try { // Call Authlete's /api/backchannel/authentication/complete API. - return mApi.backchannelAuthenticationComplete(request); + return mApi.backchannelAuthenticationComplete(request, options); } catch (AuthleteApiException e) { @@ -1145,9 +1160,9 @@ public BackchannelAuthenticationCompleteResponse callBackchannelAuthenticationCo * Call Authlete's {@code /api/client/registration} API. */ public ClientRegistrationResponse callClientRegistration( - String json) + String json, Options options) { - return callClientRegistration(json, null); + return callClientRegistration(json, null, options); } @@ -1156,7 +1171,7 @@ public ClientRegistrationResponse callClientRegistration( * with an initial access token. */ public ClientRegistrationResponse callClientRegistration( - String json, String initialAccessToken) + String json, String initialAccessToken, Options options) { ClientRegistrationRequest request = new ClientRegistrationRequest() .setJson(json) @@ -1165,7 +1180,7 @@ public ClientRegistrationResponse callClientRegistration( try { - return mApi.dynamicClientRegister(request); + return mApi.dynamicClientRegister(request, options); } catch (AuthleteApiException e) { @@ -1178,7 +1193,7 @@ public ClientRegistrationResponse callClientRegistration( * Call Authlete's {@code /api/client/registration/get} API. */ public ClientRegistrationResponse callClientRegistrationGet( - String clientId, String registrationAccessToken) + String clientId, String registrationAccessToken, Options options) { ClientRegistrationRequest request = new ClientRegistrationRequest() .setClientId(clientId) @@ -1186,7 +1201,7 @@ public ClientRegistrationResponse callClientRegistrationGet( try { - return mApi.dynamicClientGet(request); + return mApi.dynamicClientGet(request, options); } catch (AuthleteApiException e) { @@ -1199,7 +1214,7 @@ public ClientRegistrationResponse callClientRegistrationGet( * Call Authlete's {@code /api/client/registration/update} API. */ public ClientRegistrationResponse callClientRegistrationUpdate( - String clientId, String json, String registrationAccessToken) + String clientId, String json, String registrationAccessToken, Options options) { ClientRegistrationRequest request = new ClientRegistrationRequest() .setClientId(clientId) @@ -1208,7 +1223,7 @@ public ClientRegistrationResponse callClientRegistrationUpdate( try { - return mApi.dynamicClientUpdate(request); + return mApi.dynamicClientUpdate(request, options); } catch (AuthleteApiException e) { @@ -1221,7 +1236,7 @@ public ClientRegistrationResponse callClientRegistrationUpdate( * Call Authlete's {@code /api/client/registration/delete} API. */ public ClientRegistrationResponse callClientRegistrationDelete( - String clientId, String registrationAccessToken) + String clientId, String registrationAccessToken, Options options) { ClientRegistrationRequest request = new ClientRegistrationRequest() .setClientId(clientId) @@ -1229,7 +1244,7 @@ public ClientRegistrationResponse callClientRegistrationDelete( try { - return mApi.dynamicClientDelete(request); + return mApi.dynamicClientDelete(request, options); } catch (AuthleteApiException e) { @@ -1244,13 +1259,13 @@ public ClientRegistrationResponse callClientRegistrationDelete( public DeviceAuthorizationResponse callDeviceAuthorization( MultivaluedMap parameters, String clientId, String clientSecret, - String clientCertificate, String[] clientCertificatePath) + String clientCertificate, String[] clientCertificatePath, Options options) { String params = URLCoder.formUrlEncode(parameters); return callDeviceAuthorization( params, clientId, clientSecret, - clientCertificate, clientCertificatePath); + clientCertificate, clientCertificatePath, options); } @@ -1259,7 +1274,7 @@ public DeviceAuthorizationResponse callDeviceAuthorization( */ private DeviceAuthorizationResponse callDeviceAuthorization( String parameters, String clientId, String clientSecret, - String clientCertificate, String[] clientCertificatePath) + String clientCertificate, String[] clientCertificatePath, Options options) { if (parameters == null) { @@ -1281,7 +1296,7 @@ private DeviceAuthorizationResponse callDeviceAuthorization( try { // Call Authlete's /api/device/authorization API. - return mApi.deviceAuthorization(request); + return mApi.deviceAuthorization(request, options); } catch (AuthleteApiException e) { @@ -1297,7 +1312,7 @@ private DeviceAuthorizationResponse callDeviceAuthorization( public DeviceCompleteResponse callDeviceComplete( String userCode, String subject, DeviceCompleteRequest.Result result, long authTime, String acr, Map claims, Property[] properties, - String[] scopes, String errorDescription, URI errorUri) + String[] scopes, String errorDescription, URI errorUri, Options options) { // Create a request for /api/device/complete API. DeviceCompleteRequest request = new DeviceCompleteRequest() @@ -1320,7 +1335,7 @@ public DeviceCompleteResponse callDeviceComplete( try { // Call Authlete's /api/device/complete API. - return mApi.deviceComplete(request); + return mApi.deviceComplete(request, options); } catch (AuthleteApiException e) { @@ -1333,7 +1348,7 @@ public DeviceCompleteResponse callDeviceComplete( /** * Call Authlete's {@code /api/device/verification} API. */ - public DeviceVerificationResponse callDeviceVerification(String userCode) + public DeviceVerificationResponse callDeviceVerification(String userCode, Options options) { // Create a request for /api/device/verification API. DeviceVerificationRequest request = new DeviceVerificationRequest() @@ -1343,7 +1358,7 @@ public DeviceVerificationResponse callDeviceVerification(String userCode) try { // Call Authlete's /api/device/verification API. - return mApi.deviceVerification(request); + return mApi.deviceVerification(request, options); } catch (AuthleteApiException e) { @@ -1359,13 +1374,13 @@ public DeviceVerificationResponse callDeviceVerification(String userCode) public PushedAuthReqResponse callPushedAuthReq( MultivaluedMap parameters, String clientId, String clientSecret, String clientCertificate, String[] clientCertificatePath, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options options) { String params = URLCoder.formUrlEncode(parameters); return callPushedAuthReq( params, clientId, clientSecret, clientCertificate, clientCertificatePath, - dpop, htm, htu); + dpop, htm, htu, options); } @@ -1375,7 +1390,7 @@ public PushedAuthReqResponse callPushedAuthReq( public PushedAuthReqResponse callPushedAuthReq( String parameters, String clientId, String clientSecret, String clientCertificate, String[] clientCertificatePath, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options options) { PushedAuthReqRequest request = new PushedAuthReqRequest() .setParameters(parameters) @@ -1390,7 +1405,7 @@ public PushedAuthReqResponse callPushedAuthReq( try { - return mApi.pushAuthorizationRequest(request); + return mApi.pushAuthorizationRequest(request, options); } catch (AuthleteApiException e) { @@ -1403,11 +1418,11 @@ public PushedAuthReqResponse callPushedAuthReq( /** * Call Authlete's {@code /api/gm} API. */ - public GMResponse callGm(GMRequest request) + public GMResponse callGm(GMRequest request, Options options) { try { - return mApi.gm(request); + return mApi.gm(request, options); } catch (AuthleteApiException e) { @@ -1421,11 +1436,11 @@ public GMResponse callGm(GMRequest request) * Call Authlete's {@code /api/federation/configuration} API. */ public FederationConfigurationResponse - callFederationConfiguration(FederationConfigurationRequest request) + callFederationConfiguration(FederationConfigurationRequest request, Options options) { try { - return mApi.federationConfiguration(request); + return mApi.federationConfiguration(request, options); } catch (AuthleteApiException e) { @@ -1439,11 +1454,11 @@ public GMResponse callGm(GMRequest request) * Call Authlete's {@code /api/federation/registration} API. */ public FederationRegistrationResponse - callFederationRegistration(FederationRegistrationRequest request) + callFederationRegistration(FederationRegistrationRequest request, Options options) { try { - return mApi.federationRegistration(request); + return mApi.federationRegistration(request, options); } catch (AuthleteApiException e) { @@ -1457,11 +1472,11 @@ public GMResponse callGm(GMRequest request) * Call Authlete's {@code /vci/metadata} API. */ public CredentialIssuerMetadataResponse - callCredentialIssuerMetadata(CredentialIssuerMetadataRequest request) + callCredentialIssuerMetadata(CredentialIssuerMetadataRequest request, Options options) { try { - return mApi.credentialIssuerMetadata(request); + return mApi.credentialIssuerMetadata(request, options); } catch (AuthleteApiException e) { @@ -1475,11 +1490,11 @@ public GMResponse callGm(GMRequest request) * Call Authlete's {@code /vci/jwtissuer} API. */ public CredentialJwtIssuerMetadataResponse - callCredentialJwtIssuerMetadata(CredentialJwtIssuerMetadataRequest request) + callCredentialJwtIssuerMetadata(CredentialJwtIssuerMetadataRequest request, Options options) { try { - return mApi.credentialJwtIssuerMetadata(request); + return mApi.credentialJwtIssuerMetadata(request, options); } catch (AuthleteApiException e) { @@ -1492,11 +1507,12 @@ public GMResponse callGm(GMRequest request) /** * Call Authlete's {@code /vci/offer/info} API. */ - public CredentialOfferInfoResponse callCredentialOfferInfo(CredentialOfferInfoRequest request) + public CredentialOfferInfoResponse callCredentialOfferInfo( + CredentialOfferInfoRequest request, Options options) { try { - return mApi.credentialOfferInfo(request); + return mApi.credentialOfferInfo(request, options); } catch (AuthleteApiException e) { diff --git a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java index 15b3cb6..72b9459 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015-2022 Authlete, Inc. + * Copyright (C) 2015-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -27,6 +27,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.assurance.VerifiedClaims; import com.authlete.common.assurance.constraint.VerifiedClaimsConstraint; import com.authlete.common.assurance.constraint.VerifiedClaimsContainerConstraint; @@ -479,7 +480,9 @@ public AuthorizationDecisionHandler(AuthleteApi api, AuthorizationDecisionHandle /** - * Handle an end-user's decision on an authorization request. + * Handle an end-user's decision on an authorization request. This method is + * an alias of {@link #handle(String, String[], String[], Options, Options) + * handle}{@code (ticket, claimNames, claimLocales, null, null)}. * * @param ticket * A ticket that was issued by Authlete's {@code /api/auth/authorization} API. @@ -500,6 +503,44 @@ public AuthorizationDecisionHandler(AuthleteApi api, AuthorizationDecisionHandle * An error occurred. */ public Response handle(String ticket, String[] claimNames, String[] claimLocales) throws WebApplicationException + { + return handle(ticket, claimNames, claimLocales, null, null); + } + + + /** + * Handle an end-user's decision on an authorization request. This method is + * an alias of the {@link #handle(Params, Options, Options)} method. + * + * @param ticket + * A ticket that was issued by Authlete's {@code /api/auth/authorization} API. + * + * @param claimNames + * Names of requested claims. Use the value of the {@code claims} + * parameter in a response from Authlete's {@code /api/auth/authorization} API. + * + * @param claimLocales + * Requested claim locales. Use the value of the {@code claimsLocales} + * parameter in a response from Authlete's {@code /api/auth/authorization} API. + * + * @param authzIssueOpts + * Request options for the {@code /api/auth/authorization/issue} API. + * + * @param authzFailOpts + * Request options for the {@code /api/auth/authorization/fail} API. + * + * @return + * A response to the client application. Basically, the response + * will trigger redirection to the client's redirection endpoint. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOpts, + Options authzFailOpts) throws WebApplicationException { Params params = new Params() .setTicket(ticket) @@ -507,12 +548,13 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales .setClaimLocales(claimLocales) ; - return handle(params); + return handle(params, authzIssueOpts, authzFailOpts); } /** - * Handle an end-user's decision on an authorization request. + * Handle an end-user's decision on an authorization request. This method is + * an alias of {@link #handle(Params, Options, Options) handle}{@code (params, null, null)}. * * @param params * Parameters necessary to handle the decision. @@ -527,11 +569,39 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales * @since 2.25 */ public Response handle(Params params) throws WebApplicationException + { + return handle(params, null, null); + } + + + /** + * Handle an end-user's decision on an authorization request. + * + * @param params + * Parameters necessary to handle the decision. + * + * @param authzIssueOpts + * Request options for the {@code /api/auth/authorization/issue} API. + * + * @param authzFailOpts + * Request options for the {@code /api/auth/authorization/fail} API. + * + * @return + * A response to the client application. Basically, the response + * will trigger redirection to the client's redirection endpoint. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + Params params, Options authzIssueOpts, Options authzFailOpts) throws WebApplicationException { try { // Process the end-user's decision. - return process(params); + return process(params, authzIssueOpts, authzFailOpts); } catch (WebApplicationException e) { @@ -548,13 +618,13 @@ public Response handle(Params params) throws WebApplicationException /** * Process the end-user's decision. */ - private Response process(Params params) + private Response process(Params params, Options authzIssueOpts, Options authzFailOpts) { // If the end-user did not grant authorization to the client application. if (mSpi.isClientAuthorized() == false) { // The end-user denied the authorization request. - return fail(params.getTicket(), Reason.DENIED); + return fail(params.getTicket(), Reason.DENIED, authzFailOpts); } // The subject (= unique identifier) of the end-user. @@ -564,7 +634,7 @@ private Response process(Params params) if (subject == null || subject.length() == 0) { // The end-user is not authenticated. - return fail(params.getTicket(), Reason.NOT_AUTHENTICATED); + return fail(params.getTicket(), Reason.NOT_AUTHENTICATED, authzFailOpts); } // the potentially pairwise subject of the end user @@ -619,7 +689,7 @@ private Response process(Params params) // Authorize the authorization request. return authorize(params.getTicket(), subject, authTime, acr, claims, - properties, scopes, sub, claimsForTx, verifiedClaimsForTx); + properties, scopes, sub, claimsForTx, verifiedClaimsForTx, authzIssueOpts); } @@ -1010,6 +1080,9 @@ private VerifiedClaimsCollector createVerifiedClaimsCollector() * Authlete computes values of transformed claims under * {@code verified_claims/claims}. * + * @param options + * Request options. + * * @return * A response that should be returned to the client application. */ @@ -1017,7 +1090,7 @@ private Response authorize( String ticket, String subject, long authTime, String acr, Map claims, Property[] properties, String[] scopes, String sub, Map claimsForTx, - List> verifiedClaimsForTx) + List> verifiedClaimsForTx, Options options) { try { @@ -1027,7 +1100,7 @@ private Response authorize( // the generated response, though. return getApiCaller().authorizationIssue( ticket, subject, authTime, acr, claims, properties, - scopes, sub, claimsForTx, verifiedClaimsForTx); + scopes, sub, claimsForTx, verifiedClaimsForTx, options); } catch (WebApplicationException e) { @@ -1049,16 +1122,19 @@ private Response authorize( * @param reason * A reason of the failure of the authorization request. * + * @param options + * Request options. + * * @return * A response that should be returned to the client application. */ - private Response fail(String ticket, Reason reason) + private Response fail(String ticket, Reason reason, Options options) { try { // Generate an error response to indicate that // the authorization request failed. - return getApiCaller().authorizationFail(ticket, reason).getResponse(); + return getApiCaller().authorizationFail(ticket, reason, options).getResponse(); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java index 47cc7a4..7e7b009 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015-2019 Authlete, Inc. + * Copyright (C) 2015-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,6 +22,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.AuthorizationFailRequest.Reason; import com.authlete.common.dto.AuthorizationResponse; import com.authlete.common.dto.Property; @@ -74,23 +75,59 @@ public AuthorizationRequestHandler(AuthleteApi api, AuthorizationRequestHandlerS * Handle an authorization request to a authorization endpoint * of OAuth 2.0 (RFC 6749). + * This method is an alias of {@link #handle(MultivaluedMap, Options, Options, Options) + * handle}{@code (parameters, null, null, null)}. * * @param parameters * Request parameters of an authorization request. * * @return + * A response that should be returned from the endpoint to the client + * application. + * + * @throws WebApplicationException + * An error occurred. + */ + public Response handle(MultivaluedMap parameters) throws WebApplicationException + { + return handle(parameters, null, null, null); + } + + + /** + * Handle an authorization request to a authorization endpoint + * of OAuth 2.0 (RFC 6749). + * + * @param parameters + * Request parameters of an authorization request. + * + * @param authzOpts + * Request options for the {@code /api/auth/authorization} API. + * + * @param authzIssueOpts + * Request options for the {@code /api/auth/authorization/issue} API. + * + * @param authzFailOpts + * Request options for the {@code /api/auth/authorization/fail} API. + * + * @return * A response that should be returned from the endpoint to the * client application. * * @throws WebApplicationException * An error occurred. + * + * @since 2.82 */ - public Response handle(MultivaluedMap parameters) throws WebApplicationException + public Response handle( + MultivaluedMap parameters, Options authzOpts, + Options authzIssueOpts, Options authzFailOpts) throws WebApplicationException { try { // Process the given parameters. - return process(parameters); + return process(parameters, authzOpts, authzIssueOpts, authzFailOpts); } catch (WebApplicationException e) { @@ -107,10 +144,11 @@ public Response handle(MultivaluedMap parameters) throws WebAppl /** * Process the authorization request. */ - private Response process(MultivaluedMap parameters) + private Response process( + MultivaluedMap parameters, Options authzOpts, Options authzIssueOpts, Options authzFailOpts) { // Call Authlete's /api/auth/authorization API. - AuthorizationResponse response = getApiCaller().callAuthorization(parameters); + AuthorizationResponse response = getApiCaller().callAuthorization(parameters, authzOpts); // 'action' in the response denotes the next action which // this service implementation should take. @@ -147,7 +185,7 @@ private Response process(MultivaluedMap parameters) // Process the authorization request without user interaction. // The flow reaches here only when the authorization request // contained prompt=none. - return handleNoInteraction(response); + return handleNoInteraction(response, authzIssueOpts, authzFailOpts); default: // This never happens. @@ -170,16 +208,17 @@ private Response handleInteraction(AuthorizationResponse response) * Handle the case where {@code action} parameter in a response from * Authlete's {@code /api/auth/authorization} API is {@code NO_INTERACTION}. */ - private Response handleNoInteraction(AuthorizationResponse response) + private Response handleNoInteraction( + AuthorizationResponse response, Options authzIssueOpts, Options authzFailOpts) { // Check 1. End-User Authentication - noInteractionCheckAuthentication(response); + noInteractionCheckAuthentication(response, authzFailOpts); // Get the time when the user was authenticated. long authTime = mSpi.getUserAuthenticatedAt(); // Check 2. Max Age - noInteractionCheckMaxAge(response, authTime); + noInteractionCheckMaxAge(response, authTime, authzFailOpts); // The current subject, i.e. the unique ID assigned by // the service to the current user. @@ -189,14 +228,14 @@ private Response handleNoInteraction(AuthorizationResponse response) String sub = mSpi.getSub(); // Check 3. Subject - noInteractionCheckSubject(response, subject); + noInteractionCheckSubject(response, subject, authzFailOpts); // Get the ACR that was satisfied when the current user // was authenticated. String acr = mSpi.getAcr(); // Check 4. ACR - noInteractionCheckAcr(response, acr); + noInteractionCheckAcr(response, acr, authzFailOpts); // Extra properties to associate with an access token and/or // an authorization code. @@ -209,14 +248,14 @@ private Response handleNoInteraction(AuthorizationResponse response) String[] scopes = mSpi.getScopes(); // Issue - return noInteractionIssue(response, authTime, subject, acr, properties, scopes, sub); + return noInteractionIssue(response, authTime, subject, acr, properties, scopes, sub, authzIssueOpts); } /** * Check whether an end-user has already logged in or not. */ - private void noInteractionCheckAuthentication(AuthorizationResponse response) + private void noInteractionCheckAuthentication(AuthorizationResponse response, Options options) { // If the current user has already been authenticated. if (mSpi.isUserAuthenticated()) @@ -226,11 +265,11 @@ private void noInteractionCheckAuthentication(AuthorizationResponse response) } // A user must have logged in. - throw getApiCaller().authorizationFail(response.getTicket(), Reason.NOT_LOGGED_IN); + throw getApiCaller().authorizationFail(response.getTicket(), Reason.NOT_LOGGED_IN, options); } - private void noInteractionCheckMaxAge(AuthorizationResponse response, long authTime) + private void noInteractionCheckMaxAge(AuthorizationResponse response, long authTime, Options options) { // Get the requested maximum authentication age. int maxAge = response.getMaxAge(); @@ -253,11 +292,11 @@ private void noInteractionCheckMaxAge(AuthorizationResponse response, long authT } // The maximum authentication age has elapsed. - throw getApiCaller().authorizationFail(response.getTicket(), Reason.EXCEEDS_MAX_AGE); + throw getApiCaller().authorizationFail(response.getTicket(), Reason.EXCEEDS_MAX_AGE, options); } - private void noInteractionCheckSubject(AuthorizationResponse response, String subject) + private void noInteractionCheckSubject(AuthorizationResponse response, String subject, Options options) { // Get the requested subject. String requestedSubject = response.getSubject(); @@ -277,11 +316,11 @@ private void noInteractionCheckSubject(AuthorizationResponse response, String su } // The current user is different from the requested subject. - throw getApiCaller().authorizationFail(response.getTicket(), Reason.DIFFERENT_SUBJECT); + throw getApiCaller().authorizationFail(response.getTicket(), Reason.DIFFERENT_SUBJECT, options); } - private void noInteractionCheckAcr(AuthorizationResponse response, String acr) + private void noInteractionCheckAcr(AuthorizationResponse response, String acr, Options options) { // Get the list of requested ACRs. String[] requestedAcrs = response.getAcrs(); @@ -307,7 +346,7 @@ private void noInteractionCheckAcr(AuthorizationResponse response, String acr) if (response.isAcrEssential()) { // None of the requested ACRs is satisfied. - throw getApiCaller().authorizationFail(response.getTicket(), Reason.ACR_NOT_SATISFIED); + throw getApiCaller().authorizationFail(response.getTicket(), Reason.ACR_NOT_SATISFIED, options); } // The ACR satisfied when the current user was authenticated @@ -320,7 +359,8 @@ private void noInteractionCheckAcr(AuthorizationResponse response, String acr) private Response noInteractionIssue( AuthorizationResponse response, long authTime, String subject, - String acr, Property[] properties, String[] scopes, String sub) + String acr, Property[] properties, String[] scopes, String sub, + Options options) { // When prompt=none is contained in an authorization request, // response.getClaims() returns null. This means that user @@ -335,6 +375,6 @@ private Response noInteractionIssue( return getApiCaller().authorizationIssue( response.getTicket(), subject, authTime, acr, - (Map) null, properties, scopes, sub); + (Map) null, properties, scopes, sub, options); } } diff --git a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java index dbdda83..7116819 100644 --- a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,6 +25,7 @@ import jakarta.ws.rs.core.MediaType; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.BackchannelAuthenticationCompleteResponse; import com.authlete.common.dto.Property; import com.authlete.common.dto.BackchannelAuthenticationCompleteRequest.Result; @@ -68,7 +69,8 @@ public class BackchannelAuthenticationCompleteRequestHandler extends BaseHandler * @param spi * Implementation of {@link BackchannelAuthenticationCompleteRequestHandlerSpi} interface. */ - public BackchannelAuthenticationCompleteRequestHandler(AuthleteApi api, BackchannelAuthenticationCompleteRequestHandlerSpi spi) + public BackchannelAuthenticationCompleteRequestHandler( + AuthleteApi api, BackchannelAuthenticationCompleteRequestHandlerSpi spi) { super(api); @@ -78,7 +80,8 @@ public BackchannelAuthenticationCompleteRequestHandler(AuthleteApi api, Backchan /** * Handle the result of end-user authentication and authorization in CIBA - * (Client Initiated Backchannel Authentication) flow. + * (Client Initiated Backchannel Authentication) flow. This method is an alias + * of {@link #handle(AuthleteApi, String[], Options) handle}{@code (ticket, claimNames, null)}. * * @param ticket * A ticket that was issued by Authlete's {@code /api/backchannel/authentication} @@ -93,11 +96,38 @@ public BackchannelAuthenticationCompleteRequestHandler(AuthleteApi api, Backchan * An error occurred. */ public void handle(String ticket, String[] claimNames) throws WebApplicationException + { + handle(ticket, claimNames, null); + } + + + /** + * Handle the result of end-user authentication and authorization in CIBA + * (Client Initiated Backchannel Authentication) flow. + * + * @param ticket + * A ticket that was issued by Authlete's {@code /api/backchannel/authentication} + * API. + * + * @param claimNames + * Names of requested claims. Use the value of the {@code claimNames} + * parameter in a response from Authlete's {@code /api/backchannel/authentication} + * API. + * + * @param options + * Request options for the {@code /api/backchannel/authentication/complete} API. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public void handle(String ticket, String[] claimNames, Options options) throws WebApplicationException { try { // Process the given parameters. - process(ticket, claimNames); + process(ticket, claimNames, options); } catch (WebApplicationException e) { @@ -112,11 +142,11 @@ public void handle(String ticket, String[] claimNames) throws WebApplicationExce } - private void process(String ticket, String[] claimNames) + private void process(String ticket, String[] claimNames, Options options) { // Complete the process with the result of end-user authentication and // authorization. - BackchannelAuthenticationCompleteResponse response = complete(ticket, claimNames); + BackchannelAuthenticationCompleteResponse response = complete(ticket, claimNames, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -148,7 +178,7 @@ private void process(String ticket, String[] claimNames) } - private BackchannelAuthenticationCompleteResponse complete(String ticket, String[] claimNames) + private BackchannelAuthenticationCompleteResponse complete(String ticket, String[] claimNames, Options options) { // Get the authentication result. Result result = mSpi.getResult(); @@ -166,7 +196,7 @@ private BackchannelAuthenticationCompleteResponse complete(String ticket, String // The end-user authorization has not been successfully done. // Then, complete the process with failure. - return fail(ticket, subject, result, errorDescription, errorUri); + return fail(ticket, subject, result, errorDescription, errorUri, options); } // OK. The end-user has successfully authorized the client. @@ -190,7 +220,7 @@ private BackchannelAuthenticationCompleteResponse complete(String ticket, String Property[] properties = mSpi.getProperties(); // Complete the process with successful authorization. - return authorize(ticket, subject, authTime, acr, claims, properties, scopes); + return authorize(ticket, subject, authTime, acr, claims, properties, scopes, options); } @@ -214,17 +244,20 @@ private BackchannelAuthenticationCompleteResponse complete(String ticket, String * @param errorUri * The URI of a document which describes the error in detail. * + * @param options + * Request options for the {@code /api/backchannel/authentication/complete} API. + * * @return * A response from Authlete's {@code /api/backchannel/authentication/complete} * API. */ private BackchannelAuthenticationCompleteResponse fail( String ticket, String subject, Result result, String errorDescription, - URI errorUri) + URI errorUri, Options options) { return callBackchannelAuthenticationComplete( ticket, subject, result, 0, null, null, null, null, errorDescription, - errorUri); + errorUri, options); } @@ -259,6 +292,9 @@ private BackchannelAuthenticationCompleteResponse fail( * @param properties * Extra properties to associate with an access token. * + * @param options + * Request options for the {@code /api/backchannel/authentication/complete} API. + * * @param scopes * Scopes to associate with an access token. If {@code null} is given, * the scopes contained in the original backchannel authentication @@ -271,22 +307,22 @@ private BackchannelAuthenticationCompleteResponse fail( */ private BackchannelAuthenticationCompleteResponse authorize( String ticket, String subject, long authTime, String acr, Map claims, - Property[] properties, String[] scopes) + Property[] properties, String[] scopes, Options options) { return callBackchannelAuthenticationComplete( ticket, subject, Result.AUTHORIZED, authTime, acr, claims, properties, - scopes, null, null); + scopes, null, null, options); } private BackchannelAuthenticationCompleteResponse callBackchannelAuthenticationComplete( String ticket, String subject, Result result, long authTime, String acr, Map claims, Property[] properties, String[] scopes, - String errorDescription, URI errorUri) + String errorDescription, URI errorUri, Options options) { return getApiCaller().callBackchannelAuthenticationComplete( ticket, subject, result, authTime, acr, claims, properties, scopes, - errorDescription, errorUri); + errorDescription, errorUri, options); } diff --git a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java index aebbdbb..4d7db07 100644 --- a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,6 +22,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.BackchannelAuthenticationFailRequest.Reason; import com.authlete.common.dto.BackchannelAuthenticationIssueResponse; import com.authlete.common.dto.BackchannelAuthenticationResponse; @@ -71,7 +72,8 @@ public class BackchannelAuthenticationRequestHandler extends BaseHandler * @param spi * Implementation of {@link BackchannelAuthenticationRequestHandlerSpi} interface. */ - public BackchannelAuthenticationRequestHandler(AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi) + public BackchannelAuthenticationRequestHandler( + AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi) { super(api); @@ -81,7 +83,9 @@ public BackchannelAuthenticationRequestHandler(AuthleteApi api, BackchannelAuthe /** * Handle a backchannel authentication request to a backchannel authentication - * endpoint of CIBA (Client Initiated Backchannel Authentication). + * endpoint of CIBA (Client Initiated Backchannel Authentication). This method + * is an alias of {@link #handle(MultivaluedMap, String, String[], Options, Options, Options) + * handle}{@code (parameters, authorization, clientCertificatePath, null, null, null)}. * * @param parameters * Request parameters of a backchannel authentication request. @@ -108,6 +112,52 @@ public BackchannelAuthenticationRequestHandler(AuthleteApi api, BackchannelAuthe public Response handle( MultivaluedMap parameters, String authorization, String[] clientCertificatePath) throws WebApplicationException + { + return handle(parameters, authorization, clientCertificatePath, null, null, null); + } + + + /** + * Handle a backchannel authentication request to a backchannel authentication + * endpoint of CIBA (Client Initiated Backchannel Authentication). + * + * @param parameters + * Request parameters of a backchannel authentication request. + * + * @param authorization + * The value of {@code Authorization} header in the backchannel authentication + * request. A client application may embed its pair of client ID and + * client secret in a backchannel authentication request using Basic + * Authentication. + * + * @param clientCertificatePath + * The path of the client's certificate, each in PEM format. The first + * item in the array is the client's certificate itself. May be {@code null} + * if the client did not send a certificate or path. + * + * @param bcAuthOptions + * Request options for the {@code /api/backchannel/authentication} API. + * + * @param bcAuthIssueOptions + * Request options for the {@code /api/backchannel/authentication/issue} API. + * + * @param bcAuthFailOptions + * Request options for the {@code /api/backchannel/authentication/fail} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath, Options bcAuthOptions, Options bcAuthIssueOptions, + Options bcAuthFailOptions) throws WebApplicationException { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -121,7 +171,8 @@ public Response handle( try { // Process the given parameters. - return process(parameters, clientId, clientSecret, clientCertificatePath); + return process(parameters, clientId, clientSecret, clientCertificatePath, + bcAuthOptions, bcAuthIssueOptions, bcAuthFailOptions); } catch (WebApplicationException e) { @@ -137,7 +188,8 @@ public Response handle( private Response process( MultivaluedMap parameters, String clientId, - String clientSecret, String[] clientCertificatePath) + String clientSecret, String[] clientCertificatePath, Options bcAuthOptions, + Options bcAuthIssueOptions, Options bcAuthFailOptions) { // TODO: Duplicate code. String clientCertificate = null; @@ -156,7 +208,8 @@ private Response process( // Call Authlete's /api/backchannel/authentication API. BackchannelAuthenticationResponse response = - getApiCaller().callBackchannelAuthentication(parameters, clientId, clientSecret, clientCertificate, clientCertificatePath); + getApiCaller().callBackchannelAuthentication( + parameters, clientId, clientSecret, clientCertificate, clientCertificatePath, bcAuthOptions); // 'action' in the response denotes the next action which // this service implementation should take. @@ -183,7 +236,7 @@ private Response process( case USER_IDENTIFICATION: // Process user identification. - return handleUserIdentification(response); + return handleUserIdentification(response, bcAuthIssueOptions, bcAuthFailOptions); default: // This never happens. @@ -192,26 +245,27 @@ private Response process( } - private Response handleUserIdentification(BackchannelAuthenticationResponse baRes) + private Response handleUserIdentification( + BackchannelAuthenticationResponse baRes, Options bcAuthIssueOptions, Options bcAuthFailOptions) { // Identify a user based on the hint contained in the backchannel authentication // request. - User user = identifyUserByHint(baRes); + User user = identifyUserByHint(baRes, bcAuthFailOptions); // Check the expiration of the login hint token if necessary. - checkExpirationOfLoginHintToken(baRes); + checkExpirationOfLoginHintToken(baRes, bcAuthFailOptions); // Check the user code contained in the backchannel authentication request // if necessary. - checkUserCode(baRes, user); + checkUserCode(baRes, user, bcAuthFailOptions); // Check the binding message in the backchannel authentication request // if necessary. - checkBindingMessage(baRes); + checkBindingMessage(baRes, bcAuthFailOptions); // Issue an 'auth_req_id'. BackchannelAuthenticationIssueResponse baiRes = - getApiCaller().callBackchannelAuthenticationIssue(baRes.getTicket()); + getApiCaller().callBackchannelAuthenticationIssue(baRes.getTicket(), bcAuthIssueOptions); // 'action' in the response denotes the next action which this service // implementation should take. @@ -244,7 +298,7 @@ private Response handleUserIdentification(BackchannelAuthenticationResponse baRe } - private User identifyUserByHint(BackchannelAuthenticationResponse baRes) + private User identifyUserByHint(BackchannelAuthenticationResponse baRes, Options bcAuthFailOptions) { // Get a user by the hint. User user = mSpi.getUserByHint(baRes.getHintType(), baRes.getHint(), baRes.getSub()); @@ -261,11 +315,13 @@ private User identifyUserByHint(BackchannelAuthenticationResponse baRes) } // Can't identify a user by the hint. - throw getApiCaller().backchannelAuthenticationFail(baRes.getTicket(), Reason.UNKNOWN_USER_ID); + throw getApiCaller().backchannelAuthenticationFail( + baRes.getTicket(), Reason.UNKNOWN_USER_ID, bcAuthFailOptions); } - private void checkExpirationOfLoginHintToken(BackchannelAuthenticationResponse baRes) + private void checkExpirationOfLoginHintToken( + BackchannelAuthenticationResponse baRes, Options bcAuthFailOptions) { if (baRes.getHintType() != UserIdentificationHintType.LOGIN_HINT_TOKEN) { @@ -284,11 +340,11 @@ private void checkExpirationOfLoginHintToken(BackchannelAuthenticationResponse b } // The login hint token has expired. - throw getApiCaller().backchannelAuthenticationFail(baRes.getTicket(), Reason.EXPIRED_LOGIN_HINT_TOKEN); + throw getApiCaller().backchannelAuthenticationFail(baRes.getTicket(), Reason.EXPIRED_LOGIN_HINT_TOKEN, bcAuthFailOptions); } - private void checkUserCode(BackchannelAuthenticationResponse baRes, User user) + private void checkUserCode(BackchannelAuthenticationResponse baRes, User user, Options bcAuthFailOptions) { if (mSpi.shouldCheckUserCode(user, baRes) == false) { @@ -306,11 +362,12 @@ private void checkUserCode(BackchannelAuthenticationResponse baRes, User user) } // The user code is invalid. - throw getApiCaller().backchannelAuthenticationFail(baRes.getTicket(), Reason.INVALID_USER_CODE); + throw getApiCaller().backchannelAuthenticationFail( + baRes.getTicket(), Reason.INVALID_USER_CODE, bcAuthFailOptions); } - private void checkBindingMessage(BackchannelAuthenticationResponse baRes) + private void checkBindingMessage(BackchannelAuthenticationResponse baRes, Options bcAuthFailOptions) { // The binding message in the backchannel authentication request. String bindingMessage = baRes.getBindingMessage(); @@ -328,7 +385,8 @@ private void checkBindingMessage(BackchannelAuthenticationResponse baRes) } // The binding message is invalid. - throw getApiCaller().backchannelAuthenticationFail(baRes.getTicket(), Reason.INVALID_BINDING_MESSAGE); + throw getApiCaller().backchannelAuthenticationFail( + baRes.getTicket(), Reason.INVALID_BINDING_MESSAGE, bcAuthFailOptions); } diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java index d1459b2..9a773d0 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2020 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.AuthorizationDecisionHandler.Params; import com.authlete.jakarta.spi.AuthorizationDecisionHandlerSpi; @@ -34,24 +35,42 @@ public class BaseAuthorizationDecisionEndpoint extends BaseEndpoint { /** - * Handle an authorization decision request. + * Handle an authorization decision request. This method is an alias of + * {@link #handle(AuthleteApi, AuthorizationDecisionHandlerSpi, String, String[], + * String[], Options, Options) handle}{@code (api, spi, ticket, claimNames, claimLocales, null, null)}. * - *

    - * This method internally creates a {@link AuthorizationDecisionHandler} instance and - * calls its {@link AuthorizationDecisionHandler#handle(String, String[], String[])} - * method. Then, this method uses the value returned from the {@code handle()} method - * as a response from this method. - *

    + * @param api + * An implementation of {@link AuthleteApi}. * - *

    - * When {@code AuthorizationDecisionHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} - * does nothing. You - * can override the method as necessary. After calling {@code onError()} method, - * this method calls {@code getResponse()} method of the exception and uses the - * returned value as a response from this method. - *

    + * @param spi + * An implementation of {@link AuthorizationDecisionHandlerSpi}. + * + * @param ticket + * A ticket that was issued by Authlete's {@code /api/auth/authorization} API. + * + * @param claimNames + * Names of requested claims. Use the value of the {@code claims} + * parameter in a response from Authlete's {@code /api/auth/authorization} API. + * + * @param claimLocales + * Requested claim locales. Use the value of the {@code claimsLocales} + * parameter in a response from Authlete's {@code /api/auth/authorization} API. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle( + AuthleteApi api, AuthorizationDecisionHandlerSpi spi, + String ticket, String[] claimNames, String[] claimLocales) + { + return handle(api, spi, ticket, claimNames, claimLocales, null, null); + } + + + /** + * Handle an authorization decision request. This method is an alias of + * {@link #handle(AuthleteApi, AuthorizationDecisionHandlerSpi, Params, Options, + * Options)} method. * * @param api * An implementation of {@link AuthleteApi}. @@ -70,12 +89,21 @@ public class BaseAuthorizationDecisionEndpoint extends BaseEndpoint * Requested claim locales. Use the value of the {@code claimsLocales} * parameter in a response from Authlete's {@code /api/auth/authorization} API. * + * @param authzIssueOpts + * Request options for the {@code /api/auth/authorization/issue} API. + * + * @param authzFailOpts + * Request options for the {@code /api/auth/authorization/fail} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handle( AuthleteApi api, AuthorizationDecisionHandlerSpi spi, - String ticket, String[] claimNames, String[] claimLocales) + String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOpts, + Options authzFailOpts) { Params params = new Params() .setTicket(ticket) @@ -83,7 +111,33 @@ public Response handle( .setClaimLocales(claimLocales) ; - return handle(api, spi, params); + return handle(api, spi, params, authzIssueOpts, authzFailOpts); + } + + + /** + * Handle an authorization decision request. This method is an alias of + * {@link #handle(AuthleteApi, AuthorizationDecisionHandlerSpi, Params, Options, + * Options) handle}{@code (api, spi, params, null, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link AuthorizationDecisionHandlerSpi}. + * + * @param params + * Parameters necessary to handle the decision. + * + * @return + * A response that should be returned to the client application. + * + * @since 2.26 + */ + public Response handle( + AuthleteApi api, AuthorizationDecisionHandlerSpi spi, Params params) + { + return handle(api, spi, params, null, null); } @@ -92,19 +146,18 @@ public Response handle( * *

    * This method internally creates a {@link AuthorizationDecisionHandler} instance and - * calls its {@link AuthorizationDecisionHandler#handle(String, String[], String[])} + * calls its {@link AuthorizationDecisionHandler#handle(Params, Options, Options)} * method. Then, this method uses the value returned from the {@code handle()} method * as a response from this method. *

    * *

    * When {@code AuthorizationDecisionHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} - * does nothing. You - * can override the method as necessary. After calling {@code onError()} method, - * this method calls {@code getResponse()} method of the exception and uses the - * returned value as a response from this method. + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} + * does nothing. You can override the method as necessary. After calling {@code + * onError()} method, this method calls {@code getResponse()} method of the + * exception and uses the returned value as a response from this method. *

    * * @param api @@ -116,13 +169,20 @@ public Response handle( * @param params * Parameters necessary to handle the decision. * + * @param authzIssueOpts + * Request options for the {@code /api/auth/authorization/issue} API. + * + * @param authzFailOpts + * Request options for the {@code /api/auth/authorization/fail} API. + * * @return * A response that should be returned to the client application. * - * @since 2.26 + * @since 2.82 */ public Response handle( - AuthleteApi api, AuthorizationDecisionHandlerSpi spi, Params params) + AuthleteApi api, AuthorizationDecisionHandlerSpi spi, Params params, + Options authzIssueOpts, Options authzFailOpts) { try { @@ -130,7 +190,7 @@ public Response handle( AuthorizationDecisionHandler handler = new AuthorizationDecisionHandler(api, spi); // Delegate the task to the handler. - return handler.handle(params); + return handler.handle(params, authzIssueOpts, authzFailOpts); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java index debf710..1ed1b9e 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2020 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.spi.AuthorizationRequestHandlerSpi; @@ -45,24 +46,48 @@ */ public class BaseAuthorizationEndpoint extends BaseEndpoint { + /** + * Handle an authorization request. This method is an alias of + * {@link #handle(AuthleteApi, AuthorizationRequestHandlerSpi, MultivaluedMap, + * Options, Options, Options) handle}{@code (api, spi, parameters, null, null, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link AuthorizationRequestHandlerSpi}. + * + * @param parameters + * Request parameters of the authorization request. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle( + AuthleteApi api, AuthorizationRequestHandlerSpi spi, + MultivaluedMap parameters) + { + return handle(api, spi, parameters, null, null, null); + } + + /** * Handle an authorization request. * *

    * This method internally creates a {@link AuthorizationRequestHandler} instance and - * calls its {@link AuthorizationRequestHandler#handle(MultivaluedMap)} method. - * Then, this method uses the value returned from the {@code handle()} method - * as a response from this method. + * calls its {@link AuthorizationRequestHandler#handle(MultivaluedMap, Options, + * Options, Options)} method. Then, this method uses the value returned from + * the {@code handle()} method as a response from this method. *

    * *

    * When {@code AuthorizationRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} - * does nothing. You - * can override the method as necessary. After calling {@code onError()} method, - * this method calls {@code getResponse()} method of the exception and uses the - * returned value as a response from this method. + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} + * does nothing. You can override the method as necessary. After calling {@code + * onError()} method, this method calls {@code getResponse()} method of the + * exception and uses the returned value as a response from this method. *

    * * @param api @@ -74,12 +99,24 @@ public class BaseAuthorizationEndpoint extends BaseEndpoint * @param parameters * Request parameters of the authorization request. * + * @param authzOpts + * Request options for the {@code /api/auth/authorization} API. + * + * @param authzIssueOpts + * Request options for the {@code /api/auth/authorization/issue} API. + * + * @param authzFailOpts + * Request options for the {@code /api/auth/authorization/fail} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handle( AuthleteApi api, AuthorizationRequestHandlerSpi spi, - MultivaluedMap parameters) + MultivaluedMap parameters, Options authzOpts, + Options authzIssueOpts, Options authzFailOpts) { try { @@ -87,7 +124,7 @@ public Response handle( AuthorizationRequestHandler handler = new AuthorizationRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(parameters); + return handler.handle(parameters, authzOpts, authzIssueOpts, authzFailOpts); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java index fe3eb8f..2d5c4e6 100644 --- a/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.spi.BackchannelAuthenticationRequestHandlerSpi; @@ -34,6 +35,41 @@ */ public class BaseBackchannelAuthenticationEndpoint extends BaseEndpoint { + /** + * Handle a backchannel authentication request in CIBA (Client Initiated + * Backchannel Authentication) flow. This method is an alias of {@link + * #handle(AuthleteApi, BackchannelAuthenticationRequestHandlerSpi, MultivaluedMap, String, String[], Options, Options, Options) + * handle}{@code (api, spi, parameters, authorization, clientCertificatePath, null, null, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link BackchannelAuthenticationRequestHandlerSpi}. + * + * @param parameters + * Request parameters of the backchannel authentication request. + * + * @param authorization + * The value of {@code Authorization} header of the backchannel authentication + * request. + * + * @param clientCertificatePath + * The certificate path used in mutual TLS authentication, in PEM format. The + * client's own certificate is the first in this array. Can be {@code null}. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle( + AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath) + { + return handle(api, spi, parameters, authorization, clientCertificatePath, null, null, null); + } + + /** * Handle a backchannel authentication request in CIBA (Client Initiated * Backchannel Authentication) flow. @@ -47,8 +83,8 @@ public class BaseBackchannelAuthenticationEndpoint extends BaseEndpoint * *

    * When {@code BackchannelAuthenticationRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You can override the method as necessary. After calling * {@code onError()} method, this method calls {@code getResponse()} method of * the exception and uses the returned value as a response from this method. @@ -71,20 +107,36 @@ public class BaseBackchannelAuthenticationEndpoint extends BaseEndpoint * The certificate path used in mutual TLS authentication, in PEM format. The * client's own certificate is the first in this array. Can be {@code null}. * + * @param bcAuthOptions + * Request options for the {@code /api/backchannel/authentication} API. + * + * @param bcAuthIssueOptions + * Request options for the {@code /api/backchannel/authentication/issue} API. + * + * @param bcAuthFailOptions + * Request options for the {@code /api/backchannel/authentication/fail} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handle( AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, - MultivaluedMap parameters, String authorization, String[] clientCertificatePath) + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath, Options bcAuthOptions, Options bcAuthIssueOptions, + Options bcAuthFailOptions) { try { // Create a handler. - BackchannelAuthenticationRequestHandler handler = new BackchannelAuthenticationRequestHandler(api, spi); + BackchannelAuthenticationRequestHandler handler = + new BackchannelAuthenticationRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(parameters, authorization, clientCertificatePath); + return handler.handle( + parameters, authorization, clientCertificatePath, bcAuthOptions, + bcAuthIssueOptions, bcAuthFailOptions); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java index 890bd2a..46e3341 100644 --- a/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; /** @@ -37,21 +38,48 @@ */ public class BaseClientRegistrationEndpoint extends BaseEndpoint { + /** + * Handle a client registration request. This method is an alias of {@link + * #handleGet(AuthleteApi, String, String, Options) handleRegister}{@code + * (api, json, authorization, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param json + * The serialized JSON body of the client registration request. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @return + * A response that should be returned to the client application. + */ + public Response handleRegister( + AuthleteApi api, + String json, + String authorization) + { + return handleRegister(api, json, authorization, null); + } + + /** * Handle a client registration request. * *

    * This method internally creates a {@link ClientRegistrationRequestHandler} * instance and calls its - * {@link ClientRegistrationRequestHandler#handleRegister(String, String)} + * {@link ClientRegistrationRequestHandler#handleRegister(String, String, Options)} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    * *

    * When {@code ClientRegistrationRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You can override the method as necessary. After calling * {@code onError()} method, this method calls {@code getResponse()} method of * the exception and uses the returned value as a response from this method. @@ -67,19 +95,25 @@ public class BaseClientRegistrationEndpoint extends BaseEndpoint * The value of {@code Authorization} header of the registration request. * This is optional. * + * @param options + * Request options for the {@code /api/client/registration} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handleRegister( AuthleteApi api, String json, - String authorization) + String authorization, + Options options) { try { ClientRegistrationRequestHandler handler = new ClientRegistrationRequestHandler(api); - return handler.handleRegister(json, authorization); + return handler.handleRegister(json, authorization, options); } catch (WebApplicationException e) { @@ -90,13 +124,43 @@ public Response handleRegister( } + /** + * Handle a client registration management get request. This method is an alias + * of {@link #handleGet(AuthleteApi, String, String, Options) handle}{@code + * (api, clientId, authorization, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param clientId + * The client ID as determined by the incoming request. You will + * commonly parse this from the incoming request URL as a path + * component. If your Service has its {@code registrationManagementEndpoint} + * property set, Authlete will add the client ID as a path parameter + * to this URI automatically. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @return + * A response that should be returned to the client application. + */ + public Response handleGet( + AuthleteApi api, + String clientId, + String authorization) + { + return handleGet(api, clientId, authorization, null); + } + + /** * Handle a client registration management get request. * *

    * This method internally creates a {@link ClientRegistrationRequestHandler} - * instance and calls its - * {@link ClientRegistrationRequestHandler#handleGet(String, String)} + * instance and calls its {@link ClientRegistrationRequestHandler#handleGet(String, String, Options)} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -124,19 +188,25 @@ public Response handleRegister( * The value of {@code Authorization} header of the registration request. * This is optional. * + * @param options + * Request options for the {@code /api/client/registration} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handleGet( AuthleteApi api, String clientId, - String authorization) + String authorization, + Options options) { try { ClientRegistrationRequestHandler handler = new ClientRegistrationRequestHandler(api); - return handler.handleGet(clientId, authorization); + return handler.handleGet(clientId, authorization, options); } catch (WebApplicationException e) { @@ -147,6 +217,41 @@ public Response handleGet( } + /** + * Handle a client registration management update request. This method is an + * alias of the {@link #handleUpdate(AuthleteApi, String, String, String, Options) + * handleUpdate}{@code (api, clientId, json, authorization, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param clientId + * The client ID as determined by the incoming request. You will + * commonly parse this from the incoming request URL as a path + * component. If your Service has its {@code registrationManagementEndpoint} + * property set, Authlete will add the client ID as a path parameter + * to this URI automatically. + * + * @param json + * The serialized JSON body of the client update request. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @return + * A response that should be returned to the client application. + */ + public Response handleUpdate( + AuthleteApi api, + String clientId, + String json, + String authorization) + { + return handleUpdate(api, clientId, json, authorization, null); + } + + /** * Handle a client registration management update request. * @@ -184,20 +289,26 @@ public Response handleGet( * The value of {@code Authorization} header of the registration request. * This is optional. * + * @param options + * Request options for the {@code /api/client/registration} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handleUpdate( AuthleteApi api, String clientId, String json, - String authorization) + String authorization, + Options options) { try { ClientRegistrationRequestHandler handler = new ClientRegistrationRequestHandler(api); - return handler.handleUpdate(clientId, json, authorization); + return handler.handleUpdate(clientId, json, authorization, options); } catch (WebApplicationException e) { @@ -208,6 +319,37 @@ public Response handleUpdate( } + /** + * Handle a client registration management delete request. This method is an + * alias of {@link #handleDelete(AuthleteApi, String, String, Options) handle}{@code + * (api, clientId, authorization, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param clientId + * The client ID as determined by the incoming request. You will + * commonly parse this from the incoming request URL as a path + * component. If your Service has its {@code registrationManagementEndpoint} + * property set, Authlete will add the client ID as a path parameter + * to this URI automatically. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @return + * A response that should be returned to the client application. + */ + public Response handleDelete( + AuthleteApi api, + String clientId, + String authorization) + { + return handleDelete(api, clientId, authorization, null); + } + + /** * Handle a client registration management delete request. * @@ -242,13 +384,19 @@ public Response handleUpdate( * The value of {@code Authorization} header of the registration request. * This is optional. * + * @param options + * Request options for the {@code /api/client/registration} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handleDelete( AuthleteApi api, String clientId, - String authorization) + String authorization, + Options options) { try { diff --git a/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java index eab7b27..542a2dc 100644 --- a/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2022 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.ServiceConfigurationRequest; @@ -71,33 +72,53 @@ */ public class BaseConfigurationEndpoint extends BaseEndpoint { + /** + * Handle a request for OpenID Provider configuration. This method is an alias + * of the {@link #handle(AuthleteApi, Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle(AuthleteApi api) + { + return handle(api, (Options)null); + } + + /** * Handle a request for OpenID Provider configuration. * *

    * This method internally creates a {@link ConfigurationRequestHandler} - * instance and calls its {@link ConfigurationRequestHandler#handle()} method. - * Then, this method uses the value returned from the {@code handle()} method - * as a response from this method. + * instance and calls its {@link ConfigurationRequestHandler#handle(Options)} + * method. Then, this method uses the value returned from the {@code handle()} + * method as a response from this method. *

    * *

    * When {@code ConfigurationRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} - * does nothing. You - * can override the method as necessary. After calling {@code onError()} method, - * this method calls {@code getResponse()} method of the exception and uses the - * returned value as a response from this method. + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} + * does nothing. You can override the method as necessary. After calling {@code + * onError()} method, this method calls {@code getResponse()} method of the + * exception and uses the returned value as a response from this method. *

    * * @param api * An implementation of {@link AuthleteApi}. * + * @param options + * Request options for the {@code /api/service/configuration} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ - public Response handle(AuthleteApi api) + public Response handle(AuthleteApi api, Options options) { try { @@ -105,7 +126,7 @@ public Response handle(AuthleteApi api) ConfigurationRequestHandler handler = new ConfigurationRequestHandler(api); // Delegate the task to the handler. - return handler.handle(); + return handler.handle(options); } catch (WebApplicationException e) { @@ -118,15 +139,36 @@ public Response handle(AuthleteApi api) } + /** + * Handle a request for OpenID Provider configuration. This method is an alias + * of the {@link #handle(AuthleteApi, ServiceConfigurationRequest, Options)} + * method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param request + * Request parameters for Authlete's {@code /service/configuration} API. + * + * @return + * A response that should be returned from the discovery endpoint. + * + * @since 2.50 + */ + public Response handle(AuthleteApi api, ServiceConfigurationRequest request) + { + return handle(api, request, null); + } + + /** * Handle a request for OpenID Provider configuration. * *

    * This method internally creates a {@link ConfigurationRequestHandler} * instance and calls its - * {@link ConfigurationRequestHandler#handle(ServiceConfigurationRequest) - * handle}{@code (}{@link ServiceConfigurationRequest}{@code )} method. - * Then, this method uses the value returned from the method as a response + * {@link ConfigurationRequestHandler#handle(ServiceConfigurationRequest, Options)} + * method. Then, this method uses the value returned from the method as a response * from this method. *

    * @@ -143,14 +185,19 @@ public Response handle(AuthleteApi api) * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /service/configuration} API. + * Request parameters for Authlete's {@code /api/service/configuration} + * API. + * + * @param options + * Request options for the {@code /api/service/configuration} API. * * @return * A response that should be returned from the discovery endpoint. * - * @since 2.50 + * @since 2.82 */ - public Response handle(AuthleteApi api, ServiceConfigurationRequest request) + public Response handle( + AuthleteApi api, ServiceConfigurationRequest request, Options options) { try { @@ -158,7 +205,7 @@ public Response handle(AuthleteApi api, ServiceConfigurationRequest request) ConfigurationRequestHandler handler = new ConfigurationRequestHandler(api); // Delegate the task to the handler. - return handler.handle(request); + return handler.handle(request, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java b/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java index 81db836..9d4a332 100644 --- a/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2023 Authlete, Inc. + * Copyright (C) 2023-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.CredentialIssuerMetadataRequest; @@ -54,24 +55,82 @@ */ public class BaseCredentialIssuerMetadataEndpoint extends BaseEndpoint { + /** + * Handle a request to the credential issuer metadata endpoint. This method is + * an alias of the {@link #handle(AuthleteApi, Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @return + * A response that should be returned from the credential issuer + * metadata endpoint. + */ + public Response handle(AuthleteApi api) + { + return handle(api, (Options)null); + } + + + /** + * Handle a request to the credential issuer metadata endpoint. This method + * is an alias of the {@link #handle(AuthleteApi, CredentialIssuerMetadataRequest, + * Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param options + * Request options for the {@code /api/vci/metadata} API. + * + * @return + * A response that should be returned from the credential issuer + * metadata endpoint. + * + * @since 2.82 + */ + public Response handle(AuthleteApi api, Options options) + { + return handle(api, new CredentialIssuerMetadataRequest(), options); + } + + + /** + * Handle a request to the credential issuer metadata endpoint. This method + * is an alias of the {@link #handle(AuthleteApi, CredentialIssuerMetadataRequest, + * Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param request + * Request parameters for Authlete's {@code /api/vci/metadata} API. + * + * @return + * A response that should be returned from the credential issuer + * metadata endpoint. + */ + public Response handle(AuthleteApi api, CredentialIssuerMetadataRequest request) + { + return handle(api, request, null); + } + + /** * Handle a request to the credential issuer metadata endpoint. * *

    * This method internally creates a {@link CredentialIssuerMetadataRequestHandler} - * instance and calls its {@link - * CredentialIssuerMetadataRequestHandler#handle(CredentialIssuerMetadataRequest) - * handle}({@link CredentialIssuerMetadataRequest}) method. - * Then, this method uses the value returned from the handler's method as a - * response from this method. + * instance and calls its {@link CredentialIssuerMetadataRequestHandler#handle(CredentialIssuerMetadataRequest, + * Options)} method. Then, this method uses the value returned from the handler's + * method as a response from this method. *

    * *

    * When the handler's method raises a {@link WebApplicationException}, this - * method calls {@link #onError(WebApplicationException) - * onError(WebApplicationException)} method with the exception. The default - * implementation of {@code onError()} does nothing. You can override the - * method as necessary. After calling {@code onError()} method, this method + * method calls {@link #onError(WebApplicationException) onError()} method with the exception. + * The default implementation of {@code onError()} does nothing. You can override + * the method as necessary. After calling {@code onError()} method, this method * calls {@code getResponse()} method of the exception and uses the returned * value as a response from this method. *

    @@ -79,11 +138,20 @@ public class BaseCredentialIssuerMetadataEndpoint extends BaseEndpoint * @param api * An implementation of {@link AuthleteApi}. * + * @param request + * Request parameters for Authlete's {@code /api/vci/metadata} API. + * + * @param options + * Request options for the {@code /api/vci/metadata} API. + * * @return * A response that should be returned from the credential issuer * metadata endpoint. + * + * @since 2.82 */ - public Response handle(AuthleteApi api, CredentialIssuerMetadataRequest request) + public Response handle( + AuthleteApi api, CredentialIssuerMetadataRequest request, Options options) { try { @@ -92,7 +160,7 @@ public Response handle(AuthleteApi api, CredentialIssuerMetadataRequest request) new CredentialIssuerMetadataRequestHandler(api); // Delegate the task to the handler. - return handler.handle(request); + return handler.handle(request, options); } catch (WebApplicationException e) { @@ -103,26 +171,4 @@ public Response handle(AuthleteApi api, CredentialIssuerMetadataRequest request) return e.getResponse(); } } - - - /** - * Handle a request to the credential issuer metadata endpoint. - * - *

    - * This method is an alias of {@link - * #handle(AuthleteApi, CredentialIssuerMetadataRequest) - * handle}{@code (api, new CredentialIssuerMetadataRequest())} - *

    - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @return - * A response that should be returned from the credential issuer - * metadata endpoint. - */ - public Response handle(AuthleteApi api) - { - return handle(api, new CredentialIssuerMetadataRequest()); - } } diff --git a/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java b/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java index 622854c..554716b 100644 --- a/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2023 Authlete, Inc. + * Copyright (C) 2023-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.CredentialJwtIssuerMetadataRequest; @@ -50,24 +51,80 @@ */ public class BaseCredentialJwtIssuerMetadataEndpoint extends BaseEndpoint { + /** + * Handle a request to the JWT issuer metadata endpoint. This method is an alias + * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @return + * A response that should be returned from the JWT issuer + * metadata endpoint. + */ + public Response handle(AuthleteApi api) + { + return handle(api, new CredentialJwtIssuerMetadataRequest()); + } + + + /** + * Handle a request to the JWT issuer metadata endpoint. This method is an alias + * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest, Options)} + * method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param options + * Request options for the {@code /api/vci/jwtissuer} API. + * + * @return + * A response that should be returned from the JWT issuer + * metadata endpoint. + * + * @since 2.82 + */ + public Response handle(AuthleteApi api, Options options) + { + return handle(api, new CredentialJwtIssuerMetadataRequest(), options); + } + + + /** + * Handle a request to the JWT issuer metadata endpoint. This method is an alias + * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest, CredentialJwtIssuerMetadataRequest, + * Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @return + * A response that should be returned from the JWT issuer + * metadata endpoint. + */ + public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest request) + { + return handle(api, request, null); + } + + /** * Handle a request to the JWT issuer metadata endpoint. * *

    - * This method internally creates a {@link - * CredentialJwtIssuerMetadataRequestHandler} instance and calls its {@link - * CredentialJwtIssuerMetadataRequestHandler#handle(CredentialJwtIssuerMetadataRequest) - * handle}({@link CredentialJwtIssuerMetadataRequest}) method. - * Then, this method uses the value returned from the handler's method as a - * response from this method. + * This method internally creates a {@link CredentialJwtIssuerMetadataRequestHandler} + * instance and calls its {@link + * CredentialJwtIssuerMetadataRequestHandler#handle(CredentialJwtIssuerMetadataRequest, Options)} + * method. Then, this method uses the value returned from the handler's method + * as a response from this method. *

    * *

    * When the handler's method raises a {@link WebApplicationException}, this - * method calls {@link #onError(WebApplicationException) - * onError(WebApplicationException)} method with the exception. The default - * implementation of {@code onError()} does nothing. You can override the - * method as necessary. After calling {@code onError()} method, this method + * method calls {@link #onError(WebApplicationException) onError()} method with the exception. + * The default implementation of {@code onError()} does nothing. You can override + * the method as necessary. After calling {@code onError()} method, this method * calls {@code getResponse()} method of the exception and uses the returned * value as a response from this method. *

    @@ -75,11 +132,20 @@ public class BaseCredentialJwtIssuerMetadataEndpoint extends BaseEndpoint * @param api * An implementation of {@link AuthleteApi}. * + * @param request + * Request parameters for Authlete's {@code /api/vci/jwtissuer} API. + * + * @param options + * Request options for the {@code /api/vci/jwtissuer} API. + * * @return * A response that should be returned from the JWT issuer * metadata endpoint. + * + * @since 2.82 */ - public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest request) + public Response handle( + AuthleteApi api, CredentialJwtIssuerMetadataRequest request, Options options) { try { @@ -88,7 +154,7 @@ public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest reque new CredentialJwtIssuerMetadataRequestHandler(api); // Delegate the task to the handler. - return handler.handle(request); + return handler.handle(request, options); } catch (WebApplicationException e) { @@ -99,26 +165,4 @@ public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest reque return e.getResponse(); } } - - - /** - * Handle a request to the JWT issuer metadata endpoint. - * - *

    - * This method is an alias of {@link - * #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest) - * handle}{@code (api, new CredentialJwtIssuerMetadataRequest())} - *

    - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @return - * A response that should be returned from the JWT issuer - * metadata endpoint. - */ - public Response handle(AuthleteApi api) - { - return handle(api, new CredentialJwtIssuerMetadataRequest()); - } } diff --git a/src/main/java/com/authlete/jakarta/BaseCredentialOfferUriEndpoint.java b/src/main/java/com/authlete/jakarta/BaseCredentialOfferUriEndpoint.java index 4b2bf14..36ffeef 100644 --- a/src/main/java/com/authlete/jakarta/BaseCredentialOfferUriEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseCredentialOfferUriEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2023 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,12 +20,20 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.CredentialOfferInfoRequest; public class BaseCredentialOfferUriEndpoint extends BaseEndpoint { public Response handle(final AuthleteApi api, final CredentialOfferInfoRequest request) + { + return handle(api, request, null); + } + + + public Response handle( + final AuthleteApi api, final CredentialOfferInfoRequest request, Options options) { try { @@ -33,7 +41,7 @@ public Response handle(final AuthleteApi api, final CredentialOfferInfoRequest r CredentialOfferUriRequestHandler handler = new CredentialOfferUriRequestHandler(api); // Delegate the task to the handler. - return handler.handle(request); + return handler.handle(request, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java index e1ad99b..13d9ce0 100644 --- a/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; /** @@ -32,12 +33,47 @@ */ public class BaseDeviceAuthorizationEndpoint extends BaseEndpoint { + /** + * Handle a device authorization request. This method is an alias of {@link + * #handle(AuthleteApi, MultivaluedMap, String, String[], Options) handle}{@code + * (api, parameters, authorization, clientCertificatePath, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link DeviceAuthorizationRequestHandlerSpi}. + * + * @param parameters + * Request parameters of the device authorization request. + * + * @param authorization + * The value of {@code Authorization} header of the device authorization + * request. + * + * @param clientCertificatePath + * The certificate path used in mutual TLS authentication, in PEM format. + * The client's own certificate is the first in this array. Can be + * {@code null}. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle( + AuthleteApi api, MultivaluedMap parameters, String authorization, + String[] clientCertificatePath) + { + return handle(api, parameters, authorization, clientCertificatePath, null); + } + + /** * Handle a device authorization request. * *

    * This method internally creates a {@link DeviceAuthorizationRequestHandler} - * instance and calls its {@link DeviceAuthorizationRequestHandler#handle(MultivaluedMap, String, String[])} + * instance and calls its {@link + * DeviceAuthorizationRequestHandler#handle(MultivaluedMap, String, String[], Options)} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -70,12 +106,17 @@ public class BaseDeviceAuthorizationEndpoint extends BaseEndpoint * The client's own certificate is the first in this array. Can be * {@code null}. * + * @param options + * Request options for the {@code /api/device/authorization} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handle( AuthleteApi api, MultivaluedMap parameters, String authorization, - String[] clientCertificatePath) + String[] clientCertificatePath, Options options) { try { @@ -83,7 +124,7 @@ public Response handle( DeviceAuthorizationRequestHandler handler = new DeviceAuthorizationRequestHandler(api); // Delegate the task to the handler. - return handler.handle(parameters, authorization, clientCertificatePath); + return handler.handle(parameters, authorization, clientCertificatePath, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java b/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java index a6ea4a6..faee98e 100644 --- a/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019-2022 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.spi.DeviceCompleteRequestHandlerSpi; @@ -33,14 +34,43 @@ */ public class BaseDeviceCompleteEndpoint extends BaseEndpoint { + /** + * Handle a device complete request. This method is an alias of {@link + * #handle(AuthleteApi, DeviceCompleteRequestHandlerSpi, String, String[], Options)}{@code + * (api, spi, userCode, claimNames, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link DeviceCompleteRequestHandlerSpi}. + * + * @param userCode + * The user code that the end-user input. + * + * @param claimNames + * Names of requested claims. Use the value of the {@code claimNames} + * parameter in a response from Authlete's {@code /api/device/verification} API. + * + * @return + * A response that should be returned to the end-user. + */ + public Response handle( + AuthleteApi api, DeviceCompleteRequestHandlerSpi spi, String userCode, + String[] claimNames) + { + return handle(api, spi, userCode, claimNames, null); + } + + /** * Handle a device complete request. * *

    * This method internally creates a {@link DeviceCompleteRequestHandler} instance and - * calls its {@link DeviceCompleteRequestHandler#handle(String, String[])} method. - * Then, this method uses the value returned from the {@code handle()} method - * as a response from this method. + * calls its {@link DeviceCompleteRequestHandler#handle(String, String[], Options)} + * method. Then, this method uses the value returned from the {@code handle()} + * method as a response from this method. *

    * *

    @@ -65,12 +95,17 @@ public class BaseDeviceCompleteEndpoint extends BaseEndpoint * Names of requested claims. Use the value of the {@code claimNames} * parameter in a response from Authlete's {@code /api/device/verification} API. * + * @param options + * Request options for the {@code /api/device/authorization/complete} API. + * * @return * A response that should be returned to the end-user. + * + * @since 2.82 */ public Response handle( AuthleteApi api, DeviceCompleteRequestHandlerSpi spi, String userCode, - String[] claimNames) + String[] claimNames, Options options) { try { @@ -78,7 +113,7 @@ public Response handle( DeviceCompleteRequestHandler handler = new DeviceCompleteRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(userCode, claimNames); + return handler.handle(userCode, claimNames, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java index 94d2bd8..24ce3b8 100644 --- a/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.spi.DeviceVerificationRequestHandlerSpi; @@ -32,20 +33,39 @@ */ public class BaseDeviceVerificationEndpoint extends BaseEndpoint { + /** + * Handle a device verification request. This method is an alias of {@link + * #handle(AuthleteApi, DeviceVerificationRequestHandlerSpi, Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link DeviceVerificationRequestHandlerSpi}. + * + * @return + * A response that should be returned to the end-user. + */ + public Response handle(AuthleteApi api, DeviceVerificationRequestHandlerSpi spi) + { + return handle(api, spi, null); + } + + /** * Handle a device verification request. * *

    * This method internally creates a {@link DeviceVerificationRequestHandler} - * instance and calls its {@link DeviceVerificationRequestHandler#handle()} + * instance and calls its {@link DeviceVerificationRequestHandler#handle(Options)} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    * *

    * When {@code DeviceVerificationRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You can override the method as necessary. After calling * {@code onError()} method, this method calls {@code getResponse()} method of * the exception and uses the returned value as a response from this method. @@ -57,10 +77,16 @@ public class BaseDeviceVerificationEndpoint extends BaseEndpoint * @param spi * An implementation of {@link DeviceVerificationRequestHandlerSpi}. * + * @param options + * Request options for the {@code /api/device/authorization/verification} API. + * * @return * A response that should be returned to the end-user. + * + * @since 2.82 */ - public Response handle(AuthleteApi api, DeviceVerificationRequestHandlerSpi spi) + public Response handle( + AuthleteApi api, DeviceVerificationRequestHandlerSpi spi, Options options) { try { @@ -68,7 +94,7 @@ public Response handle(AuthleteApi api, DeviceVerificationRequestHandlerSpi spi) DeviceVerificationRequestHandler handler = new DeviceVerificationRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(); + return handler.handle(options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java index 916e2eb..6576605 100644 --- a/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022 Authlete, Inc. + * Copyright (C) 2022-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.FederationConfigurationRequest; @@ -57,23 +58,82 @@ */ public class BaseFederationConfigurationEndpoint extends BaseEndpoint { + /** + * Handle a request to the entity configuration endpoint. This method is an alias + * of {@link #handle(AuthleteApi, FederationConfigurationRequest)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @return + * A response that should be returned from the entity configuration + * endpoint. + */ + public Response handle(AuthleteApi api) + { + return handle(api, new FederationConfigurationRequest()); + } + + + /** + * Handle a request to the entity configuration endpoint. This method is an + * alias of {@link #handle(AuthleteApi, FederationConfigurationRequest, Options)} + * method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param options + * Request options for the {@code /api/federation/configuration} API. + * + * @return + * A response that should be returned from the entity configuration + * endpoint. + * + * @since 2.82 + */ + public Response handle(AuthleteApi api, Options options) + { + return handle(api, new FederationConfigurationRequest(), null); + } + + + /** + * Handle a request to the entity configuration endpoint. This method is an + * alias of {@link #handle(AuthleteApi, FederationConfigurationRequest, Options) + * handle}{@code (api, request, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param request + * Request parameters for Authlete's {@code /api/federation/configuration} API. + * + * @return + * A response that should be returned from the entity configuration + * endpoint. + */ + public Response handle(AuthleteApi api, FederationConfigurationRequest request) + { + return handle(api, request, null); + } + + /** * Handle a request to the entity configuration endpoint. * *

    * This method internally creates a {@link FederationConfigurationRequestHandler} * instance and calls its {@link - * FederationConfigurationRequestHandler#handle(FederationConfigurationRequest) - * handle}({@link FederationConfigurationRequest}) method. - * Then, this method uses the value returned from the handler's method as a - * response from this method. + * FederationConfigurationRequestHandler#handle(FederationConfigurationRequest, Options)} + * method. Then, this method uses the value returned from the handler's method + * as a response from this method. *

    * *

    * When the handler's method raises a {@link WebApplicationException}, this - * method calls {@link #onError(WebApplicationException) - * onError(WebApplicationException)} method with the exception. The default - * implementation of {@code onError()} does nothing. You can override the + * method calls {@link #onError(WebApplicationException) onError()} method with the exception. + * The default implementation of {@code onError()} does nothing. You can override the * method as necessary. After calling {@code onError()} method, this method * calls {@code getResponse()} method of the exception and uses the returned * value as a response from this method. @@ -82,11 +142,20 @@ public class BaseFederationConfigurationEndpoint extends BaseEndpoint * @param api * An implementation of {@link AuthleteApi}. * + * @param request + * Request parameters for Authlete's {@code /api/federation/configuration} API. + * + * @param options + * Request options for the {@code /api/federation/configuration} API. + * * @return * A response that should be returned from the entity configuration * endpoint. + * + * @since 2.82 */ - public Response handle(AuthleteApi api, FederationConfigurationRequest request) + public Response handle( + AuthleteApi api, FederationConfigurationRequest request, Options options) { try { @@ -95,7 +164,7 @@ public Response handle(AuthleteApi api, FederationConfigurationRequest request) new FederationConfigurationRequestHandler(api); // Delegate the task to the handler. - return handler.handle(request); + return handler.handle(request, options); } catch (WebApplicationException e) { @@ -106,26 +175,4 @@ public Response handle(AuthleteApi api, FederationConfigurationRequest request) return e.getResponse(); } } - - - /** - * Handle a request to the entity configuration endpoint. - * - *

    - * This method is an alias of {@link - * #handle(AuthleteApi, FederationConfigurationRequest) - * handle}{@code (api, new FederationConfigurationRequest())} - *

    - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @return - * A response that should be returned from the entity configuration - * endpoint. - */ - public Response handle(AuthleteApi api) - { - return handle(api, new FederationConfigurationRequest()); - } } diff --git a/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java index f1eb7ce..ff3895e 100644 --- a/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022 Authlete, Inc. + * Copyright (C) 2022-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.FederationRegistrationRequest; @@ -80,36 +81,63 @@ */ public class BaseFederationRegistrationEndpoint extends BaseEndpoint { + /** + * Handle a request to the federation registration endpoint. This method is an alias + * of {@link #handle(AuthleteApi, FederationRegistrationRequest, Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param request + * Request parameters for Authlete's {@code /api/federation/registration} API. + * + * @return + * A response that should be returned from the federation + * registration endpoint. + */ + public Response handle(AuthleteApi api, FederationRegistrationRequest request) + { + return handle(api, request, null); + } + + /** * Handle a request to the federation registration endpoint. * *

    * This method internally creates a {@link FederationRegistrationRequestHandler} * instance and calls its {@link - * FederationRegistrationRequestHandler#handle(FederationRegistrationRequest) - * handle}({@link FederationRegistrationRequest}) method. - * Then, this method uses the value returned from the handler's method as a - * response from this method. + * FederationRegistrationRequestHandler#handle(FederationRegistrationRequest, Options)} + * method. Then, this method uses the value returned from the handler's method + * as a response from this method. *

    * *

    * When the handler's method raises a {@link WebApplicationException}, this - * method calls {@link #onError(WebApplicationException) - * onError(WebApplicationException)} method with the exception. The default - * implementation of {@code onError()} does nothing. You can override the - * method as necessary. After calling {@code onError()} method, this method - * calls {@code getResponse()} method of the exception and uses the returned - * value as a response from this method. + * method calls {@link #onError(WebApplicationException) onError()} method with + * the exception. The default implementation of {@code onError()} does nothing. + * You can override the method as necessary. After calling {@code onError()} + * method, this method calls {@code getResponse()} method of the exception and + * uses the returned value as a response from this method. *

    * * @param api * An implementation of {@link AuthleteApi}. * + * @param request + * Request parameters for Authlete's {@code /api/federation/registration} API. + * + * @param options + * Request options for the {@code /api/federation/configuration} API. + * * @return * A response that should be returned from the federation * registration endpoint. + * + * @since 2.82 */ - public Response handle(AuthleteApi api, FederationRegistrationRequest request) + public Response handle( + AuthleteApi api, FederationRegistrationRequest request, Options options) { try { @@ -118,7 +146,7 @@ public Response handle(AuthleteApi api, FederationRegistrationRequest request) new FederationRegistrationRequestHandler(api); // Delegate the task to the handler. - return handler.handle(request); + return handler.handle(request, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java b/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java index c9e46ea..e36f97d 100644 --- a/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021 Authlete, Inc. + * Copyright (C) 2021-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,6 +22,7 @@ import jakarta.ws.rs.core.HttpHeaders; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.GMRequest; import com.authlete.common.types.GMAction; @@ -36,13 +37,41 @@ */ public class BaseGrantManagementEndpoint extends BaseResourceEndpoint { + /** + * Handle a grant management request. This method is an alias of {@link + * #handle(AuthleteApi, HttpServletRequest, String, Options)}{@code + * (api, req, grantId, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param req + * An HTTP request that the grant management endpoint received. + * Its HTTP method must be either {@code GET} or {@code DELETE}. + * + * @param grantId + * The grant ID included in the API call to the grant management + * endpoint. The last part of the path of the URL. + * + * @return + * A response that should be returned to the client application. + * + * @throws WebApplicationException + * An exception generated by {@link GMRequestHandler}. + */ + public Response handle( + AuthleteApi api, HttpServletRequest req, String grantId) throws WebApplicationException + { + return handle(api, req, grantId, null); + } + + /** * Handle a grant management request. * *

    * This method internally creates a {@link GMRequestHandler} instance and - * calls its {@link GMRequestHandler#handle(GMRequest) handle}({@link - * GMRequest}) method. + * calls its {@link GMRequestHandler#handle(GMRequest, Options)} method. *

    * * @param api @@ -56,15 +85,19 @@ public class BaseGrantManagementEndpoint extends BaseResourceEndpoint * The grant ID included in the API call to the grant management * endpoint. The last part of the path of the URL. * + * @param options + * Request options for the {@code /api/gm} API. + * * @return * A response that should be returned to the client application. * * @throws WebApplicationException * An exception generated by {@link GMRequestHandler}. + * + * @since 2.82 */ public Response handle( - AuthleteApi api, HttpServletRequest req, String grantId) - throws WebApplicationException + AuthleteApi api, HttpServletRequest req, String grantId, Options options) throws WebApplicationException { // Construct request parameters for an API call to the /api/gm API. GMRequest request = buildRequest(req, grantId); @@ -73,7 +106,7 @@ public Response handle( GMRequestHandler handler = new GMRequestHandler(api); // Call the /api/gm API and handle the response. - return handler.handle(request); + return handler.handle(request, options); } diff --git a/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java index b3bb9d3..e775fb0 100644 --- a/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2017-2023 Authlete, Inc. + * Copyright (C) 2017-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.IntrospectionRequestHandler.Params; @@ -39,10 +40,8 @@ public class BaseIntrospectionEndpoint extends BaseEndpoint { /** - * Handle an introspection request. - * - * This method is an alias of the {@link #handle(AuthleteApi, - * IntrospectionRequestHandler.Params)} method. + * Handle an introspection request. This method is an alias of {@link + * #handle(AuthleteApi, MultivaluedMap, Options) handle}{@code (api, parameters, null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -54,6 +53,31 @@ public class BaseIntrospectionEndpoint extends BaseEndpoint * A response that should be returned to the resource server. */ public Response handle(AuthleteApi api, MultivaluedMap parameters) + { + return handle(api, parameters, null); + } + + + /** + * Handle an introspection request. This method is an alias of the {@link + * #handle(AuthleteApi, IntrospectionRequestHandler.Params, Options)} method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param parameters + * Request parameters of an introspection request. + * + * @param options + * Request options for the {@code /api/auth/introspection} API. + * + * @return + * A response that should be returned to the resource server. + * + * @since 2.82 + */ + public Response handle( + AuthleteApi api, MultivaluedMap parameters, Options options) { Params params = new Params() .setParameters(parameters) @@ -63,13 +87,36 @@ public Response handle(AuthleteApi api, MultivaluedMap parameter } + /** + * Handle an introspection request. This method is an alias of {@link + * #handle(AuthleteApi, IntrospectionRequestHandler.Params, Options) + * handle}{@code (api, params, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param params + * Parameters needed to handle the introspection request. + * + * @return + * A response that should be returned to the resource server. + * + * @since 2.63 + */ + public Response handle(AuthleteApi api, Params params) + { + return handle(api, params, null); + } + + /** * Handle an introspection request. * *

    * This method internally creates an {@link IntrospectionRequestHandler} - * instance and calls its {@link IntrospectionRequestHandler#handle(IntrospectionRequestHandler.Params) - * handle()} method with the {@code params} argument. Then, this + * instance and calls its {@link + * IntrospectionRequestHandler#handle(IntrospectionRequestHandler.Params, Options)} + * method with the {@code params} argument. Then, this * method uses the value returned from the {@code handle()} method * as a response from this method. *

    @@ -91,12 +138,15 @@ public Response handle(AuthleteApi api, MultivaluedMap parameter * @param params * Parameters needed to handle the introspection request. * + * @param options + * Request options for the {@code /api/auth/introspection} API. + * * @return * A response that should be returned to the resource server. * - * @since 2.63 + * @since 2.82 */ - public Response handle(AuthleteApi api, Params params) + public Response handle(AuthleteApi api, Params params, Options options) { try { @@ -104,7 +154,7 @@ public Response handle(AuthleteApi api, Params params) IntrospectionRequestHandler handler = new IntrospectionRequestHandler(api); // Delegate the task to the handler. - return handler.handle(params); + return handler.handle(params, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java b/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java index 7e4fc71..c082f42 100644 --- a/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2020 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; /** @@ -51,6 +52,22 @@ */ public class BaseJwksEndpoint extends BaseEndpoint { + /** + * Handle a request for a JWK Set document. This method is an alias of {@link + * #handle(AuthleteApi, Options) handle}{@code (api, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle(AuthleteApi api) + { + return handle(api, null); + } + + /** * Handle a request for a JWK Set document. * @@ -63,8 +80,8 @@ public class BaseJwksEndpoint extends BaseEndpoint * *

    * When {@code JwksRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You * can override the method as necessary. After calling {@code onError()} method, * this method calls {@code getResponse()} method of the exception and uses the @@ -74,10 +91,15 @@ public class BaseJwksEndpoint extends BaseEndpoint * @param api * An implementation of {@link AuthleteApi}. * + * @param options + * Request options for the {@code /api/service/jwks/get} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ - public Response handle(AuthleteApi api) + public Response handle(AuthleteApi api, Options options) { try { @@ -85,7 +107,7 @@ public Response handle(AuthleteApi api) JwksRequestHandler handler = new JwksRequestHandler(api); // Delegate the task to the handler. - return handler.handle(); + return handler.handle(options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java b/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java index 265ffaa..2aef04c 100644 --- a/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019-2023 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.PushedAuthReqHandler.Params; @@ -37,23 +38,37 @@ public class BasePushedAuthReqEndpoint extends BaseEndpoint { /** - * Handle a pushed authorization request. + * Handle a pushed authorization request. This method is an alias of {@link + * #handle(AuthleteApi, MultivaluedMap, String, String[], Options) handle}{@code + * (api, parameters, authorization, clientCertificates, null)}. * - *

    - * This method internally creates a {@link PushedAuthReqHandler} instance - * and calls its {@link PushedAuthReqHandler#handle(MultivaluedMap, String, String[])} - * method. Then, this method uses the value returned from the {@code handle()} - * method as a response from this method. - *

    + * @param api + * An implementation of {@link AuthleteApi}. * - *

    - * When {@code PushedAuthReqHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} - * does nothing. You can override the method as necessary. After calling - * {@code onError()} method, this method calls {@code getResponse()} method of - * the exception and uses the returned value as a response from this method. - *

    + * @param parameters + * Request parameters of the pushed authorization request. + * + * @param authorization + * The value of {@code Authorization} header of the pushed authorization request. + * + * @param clientCertificates + * The certificate path used in mutual TLS authentication, in PEM format. The + * client's own certificate is the first in this array. Can be {@code null}. + * + * @return + * A response that should be returned to the client application. + */ + protected Response handle( + AuthleteApi api, MultivaluedMap parameters, + String authorization, String[] clientCertificates) + { + return handle(api, parameters, authorization, clientCertificates, null); + } + + + /** + * Handle a pushed authorization request. This method is an alias of the {@link + * #handle(AuthleteApi, Params, Options)} method. * * @param api * An implementation of {@link AuthleteApi}. @@ -68,12 +83,17 @@ public class BasePushedAuthReqEndpoint extends BaseEndpoint * The certificate path used in mutual TLS authentication, in PEM format. The * client's own certificate is the first in this array. Can be {@code null}. * + * @param options + * Request options for the {@code /api/pushed_auth_req} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ protected Response handle( AuthleteApi api, MultivaluedMap parameters, - String authorization, String[] clientCertificates) + String authorization, String[] clientCertificates, Options options) { Params params = new Params() .setParameters(parameters) @@ -81,7 +101,28 @@ protected Response handle( .setClientCertificatePath(clientCertificates) ; - return handle(api, params); + return handle(api, params, options); + } + + + /** + * Handle a PAR request. This method is an alias of the {@link + * #handle(AuthleteApi, Params, Options) handle}{@code (api, params, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param params + * Parameters needed to handle the PAR request. + * + * @return + * A response that should be returned to the client application. + * + * @since 2.70 + */ + public Response handle(AuthleteApi api, Params params) + { + return handle(api, params, null); } @@ -90,15 +131,15 @@ protected Response handle( * *

    * This method internally creates a {@link PushedAuthReqHandler} instance and - * calls its {@link PushedAuthReqHandler#handle(PushedAuthReqHandler.Params) - * handle(Params)} method. Then, this method uses the value returned from - * the {@code handle()} method as a response from this method. + * calls its {@link PushedAuthReqHandler#handle(PushedAuthReqHandler.Params, Options)} + * method. Then, this method uses the value returned from the {@code handle()} + * method as a response from this method. *

    * *

    * When {@code PushedAuthReqHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You can override the method as necessary. After calling * {@code onError()} method, this method calls {@code getResponse()} method of * the exception and uses the returned value as a response from this method. @@ -110,12 +151,15 @@ protected Response handle( * @param params * Parameters needed to handle the PAR request. * + * @param options + * Request options for the {@code /api/pushed_auth_req} API. + * * @return * A response that should be returned to the client application. * - * @since 2.70 + * @since 2.82 */ - public Response handle(AuthleteApi api, Params params) + public Response handle(AuthleteApi api, Params params, Options options) { try { @@ -123,7 +167,7 @@ public Response handle(AuthleteApi api, Params params) PushedAuthReqHandler handler = new PushedAuthReqHandler(api); // Delegate the task to the handler. - return handler.handle(params); + return handler.handle(params, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java b/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java index 6c6ad5c..8ce143b 100644 --- a/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2023 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,6 +19,7 @@ import jakarta.ws.rs.WebApplicationException; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.IntrospectionRequest; import com.authlete.common.dto.IntrospectionResponse; import com.authlete.common.web.BearerToken; @@ -87,7 +88,8 @@ public String extractAccessToken(String authorization, String accessTokenInReque /** * Validate an access token. This method is an alias of {@link - * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params)}. + * #validateAccessToken(AuthleteApi, String, Options) validateAccessToken}{@code + * (api, accessToken, (Options)null)}. * * @param api * Implementation of {@link AuthleteApi} interface. @@ -105,17 +107,44 @@ public String extractAccessToken(String authorization, String accessTokenInReque public AccessTokenInfo validateAccessToken( AuthleteApi api, String accessToken) throws WebApplicationException { - Params params = new Params() - .setAccessToken(accessToken) - ; + return validateAccessToken(api, accessToken, (Options)null); + } + - return validateAccessToken(api, params); + /** + * Validate an access token. This method is an alias of {@link + * #validateAccessToken(AuthleteApi, String, String[], Options) validateAccessToken}{@code + * (api, accessToken, null, options)}. + * + * @param api + * Implementation of {@link AuthleteApi} interface. + * + * @param accessToken + * An access token to validate. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, the access + * token does not exist or it has expired. + * + * @since 2.82 + */ + public AccessTokenInfo validateAccessToken( + AuthleteApi api, String accessToken, Options options) throws WebApplicationException + { + return validateAccessToken(api, accessToken, null, options); } /** * Validate an access token. This method is an alias of {@link - * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params)}. + * #validateAccessToken(AuthleteApi, String, String[], Options) validateAccessToken}{@code + * (api, accessToken, requiredScopes, (Options)null)}. * * @param api * Implementation of {@link AuthleteApi} interface. @@ -142,18 +171,54 @@ public AccessTokenInfo validateAccessToken( public AccessTokenInfo validateAccessToken( AuthleteApi api, String accessToken, String[] requiredScopes) throws WebApplicationException { - Params params = new Params() - .setAccessToken(accessToken) - .setRequiredScopes(requiredScopes) - ; + return validateAccessToken(api, accessToken, requiredScopes, (Options)null); + } + - return validateAccessToken(api, params); + /** + * Validate an access token. This method is an alias of {@link + * #validateAccessToken(AuthleteApi, String, String[], String, Options) + * validateAccessToken}{@code (api, accessToken, requiredScopes, null, options)}. + * + * @param api + * Implementation of {@link AuthleteApi} interface. + * + * @param accessToken + * An access token to validate. + * + * @param requiredScopes + * Scopes that must be associated with the access token. + * {@code null} is okay. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, one or more of + * the following conditions meet. + *

      + *
    1. The access token does not exist. + *
    2. The access token has expired. + *
    3. The access token does not cover the required scopes. + *
    + * + * @since 2.82 + */ + public AccessTokenInfo validateAccessToken( + AuthleteApi api, String accessToken, String[] requiredScopes, Options options) + throws WebApplicationException + { + return validateAccessToken(api, accessToken, requiredScopes, null, options); } /** * Validate an access token. This method is an alias of {@link - * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params)}. + * #validateAccessToken(AuthleteApi, String, String[], String, Options)}{@code + * (api, accessToken, requiredScopes, requiredSubject, (Options)null)}. * * @param api * Implementation of {@link AuthleteApi} interface. @@ -185,19 +250,60 @@ public AccessTokenInfo validateAccessToken( AuthleteApi api, String accessToken, String[] requiredScopes, String requiredSubject) throws WebApplicationException { - Params params = new Params() - .setAccessToken(accessToken) - .setRequiredScopes(requiredScopes) - .setRequiredSubject(requiredSubject) - ; + return validateAccessToken( + api, accessToken, requiredScopes, requiredSubject, (Options)null); + } + - return validateAccessToken(api, params); + /** + * Validate an access token. This method is an alias of {@link + * #validateAccessToken(AuthleteApi, String, String[], String, String, Options) + * validateAccessToken}{@code (api, accessToken, requiredScopes, requiredSubject, null, null)}. + * + * @param api + * Implementation of {@link AuthleteApi} interface. + * + * @param accessToken + * An access token to validate. + * + * @param requiredScopes + * Scopes that must be associated with the access token. + * {@code null} is okay. + * + * @param requiredSubject + * Subject (= user's unique identifier) that must be associated + * with the access token. {@code null} is okay. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, one or more of + * the following conditions meet. + *
      + *
    1. The access token does not exist. + *
    2. The access token has expired. + *
    3. The access token does not cover the required scopes. + *
    + * + * @since 2.82 + */ + public AccessTokenInfo validateAccessToken( + AuthleteApi api, String accessToken, + String[] requiredScopes, String requiredSubject, Options options) throws WebApplicationException + { + return validateAccessToken( + api, accessToken, requiredScopes, requiredSubject, null, null); } /** * Validate an access token. This method is an alias of {@link - * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params)}. + * #validateAccessToken(AuthleteApi, String, String[], String, String, Options) + * validateAccessToken}{@code (api, accessToken, requiredScopes, requiredSubject, clientCertificate, null)}. * * @param api * Implementation of {@link AuthleteApi} interface. @@ -238,6 +344,59 @@ public AccessTokenInfo validateAccessToken( public AccessTokenInfo validateAccessToken( AuthleteApi api, String accessToken, String[] requiredScopes, String requiredSubject, String clientCertificate) throws WebApplicationException + { + return validateAccessToken( + api, accessToken, requiredScopes, requiredSubject, clientCertificate, null); + } + + + /** + * Validate an access token. This method is an alias of {@link + * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params, Options)} + * method. + * + * @param api + * Implementation of {@link AuthleteApi} interface. + * + * @param accessToken + * An access token to validate. + * + * @param requiredScopes + * Scopes that must be associated with the access token. + * {@code null} is okay. + * + * @param requiredSubject + * Subject (= user's unique identifier) that must be associated + * with the access token. {@code null} is okay. + * + * @param clientCertificate + * TLS Certificate of the client presented during a call to + * the resource server, used with TLS-bound access tokens. + * Can be {@code null} if no certificate is presented. + * + * @param options + * Request options for {@code /api/auth/introspection} API. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The access token is invalid. To be concrete, one or more of + * the following conditions meet. + *
      + *
    1. The access token does not exist. + *
    2. The access token has expired. + *
    3. The access token does not cover the required scopes. + *
    4. The access token is not associated with the required subject. + *
    5. The access token is bound to a client certificate, but the + * given one does not match. + *
    + * + * @since 2.82 + */ + public AccessTokenInfo validateAccessToken( + AuthleteApi api, String accessToken, String[] requiredScopes, + String requiredSubject, String clientCertificate, Options options) throws WebApplicationException { Params params = new Params() .setAccessToken(accessToken) @@ -246,7 +405,34 @@ public AccessTokenInfo validateAccessToken( .setClientCertificate(clientCertificate) ; - return validateAccessToken(api, params); + return validateAccessToken(api, params, options); + } + + + /** + * Validate an access token. This method is an alias of {@link + * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params, Options) + * validateAccessToken}{@code (api, params, null)}. + * . + * + * @param api + * Implementation of {@link AuthleteApi} interface. + * + * @param params + * Parameters needed for access token validation. + * + * @return + * Information about the access token. + * + * @throws WebApplicationException + * The Access Token is invalid. + * + * @since 2.27 + */ + public AccessTokenInfo validateAccessToken( + AuthleteApi api, Params params) throws WebApplicationException + { + return validateAccessToken(api, params, null); } @@ -278,21 +464,24 @@ public AccessTokenInfo validateAccessToken( * @param params * Parameters needed for access token validation. * + * @param options + * Request options for {@code /api/auth/introspection} API. + * * @return * Information about the access token. * * @throws WebApplicationException * The Access Token is invalid. * - * @since 2.27 + * @since 2.82 */ public AccessTokenInfo validateAccessToken( - AuthleteApi api, Params params) throws WebApplicationException + AuthleteApi api, Params params, Options options) throws WebApplicationException { try { // Validate the access token and obtain the information about it. - return new AccessTokenValidator(api).validate(params); + return new AccessTokenValidator(api).validate(params, options); } catch (WebApplicationException e) { @@ -306,11 +495,18 @@ public AccessTokenInfo validateAccessToken( public IntrospectionResponse validateAccessToken( AuthleteApi api, IntrospectionRequest request) throws WebApplicationException + { + return validateAccessToken(api, request, null); + } + + + public IntrospectionResponse validateAccessToken( + AuthleteApi api, IntrospectionRequest request, Options options) throws WebApplicationException { try { // Validate the access token and obtain the information about it. - return new AccessTokenValidator(api).validate(request); + return new AccessTokenValidator(api).validate(request, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java index 99387da..45e190b 100644 --- a/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2020 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; /** @@ -37,21 +38,45 @@ */ public class BaseRevocationEndpoint extends BaseEndpoint { + /** + * Handle a revocation request. This method is an alias of {@link + * #handle(AuthleteApi, MultivaluedMap, String, Options) handle}{@code + * (api, parameters, authorization, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param parameters + * Request parameters of a revocation request. + * + * @param authorization + * The value of {@code Authorization} header. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle( + AuthleteApi api, MultivaluedMap parameters, String authorization) + { + return handle(api, parameters, authorization, null); + } + + /** * Handle a revocation request. * *

    * This method internally creates a {@link RevocationRequestHandler} instance - * and calls its {@link RevocationRequestHandler#handle(MultivaluedMap, String) - * handle()} method with the {@code parameters} argument and the {@code authorization} + * and calls its {@link RevocationRequestHandler#handle(MultivaluedMap, String, Options)} + * method with the {@code parameters} argument and the {@code authorization} * argument. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    * *

    * When {@code RevocationRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You * can override the method as necessary. After calling {@code onError()} method, * this method calls {@code getResponse()} method of the exception and uses the @@ -67,10 +92,17 @@ public class BaseRevocationEndpoint extends BaseEndpoint * @param authorization * The value of {@code Authorization} header. * + * @param options + * Request options for {@code /api/auth/revocation} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ - public Response handle(AuthleteApi api, MultivaluedMap parameters, String authorization) + public Response handle( + AuthleteApi api, MultivaluedMap parameters, String authorization, + Options options) { try { @@ -78,7 +110,7 @@ public Response handle(AuthleteApi api, MultivaluedMap parameter RevocationRequestHandler handler = new RevocationRequestHandler(api); // Delegate the task to the handler. - return handler.handle(parameters, authorization); + return handler.handle(parameters, authorization, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java index 980813d..93ef025 100644 --- a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2022 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.TokenRequestHandler.Params; import com.authlete.jakarta.spi.TokenRequestHandlerSpi; @@ -41,10 +42,9 @@ public class BaseTokenEndpoint extends BaseEndpoint { /** - * Handle a token request. - * - * This method is an alias of the {@link #handle(AuthleteApi, - * TokenRequestHandlerSpi, TokenRequestHandler.Params)} method. + * Handle a token request. This method is an alias of {@link #handle(AuthleteApi, + * TokenRequestHandlerSpi, MultivaluedMap, String, Options, Options, Options) + * handle}{@code (api, spi, parameters, authorization, null, null, null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -65,20 +65,55 @@ public Response handle( AuthleteApi api, TokenRequestHandlerSpi spi, MultivaluedMap parameters, String authorization) { - Params params = new Params() - .setParameters(parameters) - .setAuthorization(authorization) - ; - - return handle(api, spi, params); + return handle(api, spi, parameters, authorization, null, null, null); } /** - * Handle a token request. + * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi, + * TokenRequestHandlerSpi, MultivaluedMap, String, String[], Options) handle}{@code + * (api, spi, parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link TokenRequestHandlerSpi}. + * + * @param parameters + * Request parameters of the token request. + * + * @param authorization + * The value of {@code Authorization} header of the token request. + * + * @param tokenOpts + * Request options for the {@code /api/auth/token} API. * - * This method is an alias of the {@link #handle(AuthleteApi, - * TokenRequestHandlerSpi, TokenRequestHandler.Params)} method. + * @param tokenIssueOpts + * Request options for the {@code /api/auth/token/issue} API. + * + * @param tokenFailOpts + * Request options for the {@code /api/auth/token/fail} API. + * + * @return + * A response that should be returned to the client application. + * + * @since 2.82 + */ + public Response handle( + AuthleteApi api, TokenRequestHandlerSpi spi, + MultivaluedMap parameters, String authorization, + Options tokenOpts, Options tokenIssueOpts, Options tokenFailOpts) + { + return handle( + api, spi, parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts); + } + + + /** + * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi, + * TokenRequestHandlerSpi, MultivaluedMap, String, String[], Options, Options, Options) + * handle}{@code (api, spi, parameters, authorization, clientCertificatePath, null, null, null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -105,6 +140,53 @@ public Response handle( public Response handle( AuthleteApi api, TokenRequestHandlerSpi spi, MultivaluedMap parameters, String authorization, String[] clientCertificatePath) + { + return handle( + api, spi, parameters, authorization, clientCertificatePath, null, null, null); + } + + + /** + * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi, + * TokenRequestHandlerSpi, TokenRequestHandler.Params, Options, Options, Options)} + * method. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link TokenRequestHandlerSpi}. + * + * @param parameters + * Request parameters of the token request. + * + * @param authorization + * The value of {@code Authorization} header of the token request. + * + * @param clientCertificatePath + * The certificate path used in mutual TLS authentication, each in + * PEM format. The client's own certificate is the first in this + * array. Can be {@code null}. + * + * @param tokenOpts + * Request options for the {@code /api/auth/token} API. + * + * @param tokenIssueOpts + * Request options for the {@code /api/auth/token/issue} API. + * + * @param tokenFailOpts + * Request options for the {@code /api/auth/token/fail} API. + * + * @return + * A response that should be returned to the client application. + * + * @since 2.82 + */ + public Response handle( + AuthleteApi api, TokenRequestHandlerSpi spi, + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath, Options tokenOpts, Options tokenIssueOpts, + Options tokenFailOpts) { Params params = new Params() .setParameters(parameters) @@ -112,7 +194,33 @@ public Response handle( .setClientCertificatePath(clientCertificatePath) ; - return handle(api, spi, params); + return handle(api, spi, params, tokenOpts, tokenIssueOpts, tokenFailOpts); + } + + + /** + * Handle a token request. This method is an alias of {@link #handle(AuthleteApi, + * TokenRequestHandlerSpi, TokenRequestHandler.Params, Options, Options, Options) + * handle}{@code (api, spi, params, null, null, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link TokenRequestHandlerSpi}. + * + * @param params + * Parameters needed to handle the token request. + * + * @return + * A response that should be returned to the client application. + * + * @since 2.27 + */ + public Response handle( + AuthleteApi api, TokenRequestHandlerSpi spi, Params params) + { + return handle(api, spi, params, null, null, null); } @@ -121,15 +229,15 @@ public Response handle( * *

    * This method internally creates a {@link TokenRequestHandler} instance and - * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params) - * handle(Params)} method. Then, this method uses the value returned from - * the {@code handle()} method as a response from this method. + * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params, Options)} + * method. Then, this method uses the value returned from the {@code handle()} + * method as a response from this method. *

    * *

    * When {@code TokenRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) - * onError()} method with the exception. The default implementation of {@code onError()} + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} + * method with the exception. The default implementation of {@code onError()} * does nothing. You can override the method as necessary. After calling * {@code onError()} method, this method calls {@code getResponse()} method of * the exception and uses the returned value as a response from this method. @@ -144,13 +252,23 @@ public Response handle( * @param params * Parameters needed to handle the token request. * + * @param tokenOpts + * Request options for the {@code /api/auth/token} API. + * + * @param tokenIssueOpts + * Request options for the {@code /api/auth/token/issue} API. + * + * @param tokenFailOpts + * Request options for the {@code /api/auth/token/fail} API. + * * @return * A response that should be returned to the client application. * - * @since 2.27 + * @since 2.82 */ public Response handle( - AuthleteApi api, TokenRequestHandlerSpi spi, Params params) + AuthleteApi api, TokenRequestHandlerSpi spi, Params params, Options tokenOpts, + Options tokenIssueOpts, Options tokenFailOpts) { try { @@ -158,7 +276,7 @@ public Response handle( TokenRequestHandler handler = new TokenRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(params); + return handler.handle(params, tokenOpts, tokenIssueOpts, tokenFailOpts); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java index c60e031..3275c63 100644 --- a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.jakarta.UserInfoRequestHandler.Params; import com.authlete.jakarta.spi.UserInfoRequestHandlerSpi; @@ -36,11 +37,35 @@ */ public class BaseUserInfoEndpoint extends BaseResourceEndpoint { + /** + * Handle a userinfo request. This method is an alias of {@link + * #handle(AuthleteApi, UserInfoRequestHandlerSpi, UserInfoRequestHandler.Params) + * handle}{@code (api, spi, accessToken, null, null)}. + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link UserInfoRequestHandlerSpi}. + * + * @param accessToken + * An access token. + * + * @return + * A response that should be returned to the client application. + */ + public Response handle( + AuthleteApi api, UserInfoRequestHandlerSpi spi, String accessToken) + { + return handle(api, spi, accessToken, null, null); + } + + /** * Handle a userinfo request. * - * This method is an alias of the {@link #handle(AuthleteApi, - * UserInfoRequestHandlerSpi, UserInfoRequestHandler.Params)} method. + * This method is an alias of the {@link #handle(AuthleteApi, UserInfoRequestHandlerSpi, + * UserInfoRequestHandler.Params)} method. * * @param api * An implementation of {@link AuthleteApi}. @@ -51,17 +76,26 @@ public class BaseUserInfoEndpoint extends BaseResourceEndpoint * @param accessToken * An access token. * + * @param userInfoOpts + * Request options for the {@code /api/auth/userinfo} API. + * + * @param userInfoIssueOpts + * Request options for the {@code /api/auth/userinfo/issue} API. + * * @return * A response that should be returned to the client application. + * + * @since 2.82 */ public Response handle( - AuthleteApi api, UserInfoRequestHandlerSpi spi, String accessToken) + AuthleteApi api, UserInfoRequestHandlerSpi spi, String accessToken, + Options userInfoOpts, Options userInfoIssueOpts) { Params params = new Params() .setAccessToken(accessToken) ; - return handle(api, spi, params); + return handle(api, spi, params, userInfoOpts, userInfoIssueOpts); } @@ -102,6 +136,55 @@ public Response handle( */ public Response handle( AuthleteApi api, UserInfoRequestHandlerSpi spi, Params params) + { + return handle(api, spi, params, null, null); + } + + + /** + * Handle a userinfo request. + * + *

    + * This method internally creates a {@link UserInfoRequestHandler} instance + * and calls its + * {@link UserInfoRequestHandler#handle(UserInfoRequestHandler.Params) + * handle(Params)} method. Then, this method uses the value returned from + * the {@code handle()} method as a response from this method. + *

    + * + *

    + * When {@code UserInfoRequestHandler.handle()} method raises a {@link + * WebApplicationException}, this method calls {@link + * #onError(WebApplicationException) onError()} method with the exception. + * The default implementation of {@code onError()} does nothing. You can + * override the method as necessary. After calling {@code onError()} + * method, this method calls {@code getResponse()} method of the exception + * and uses the returned value as a response from this method. + *

    + * + * @param api + * An implementation of {@link AuthleteApi}. + * + * @param spi + * An implementation of {@link UserInfoRequestHandlerSpi}. + * + * @param params + * Parameters needed to handle the userinfo request. + * + * @param userInfoOpts + * Request options for the {@code /api/auth/userinfo} API. + * + * @param userInfoIssueOpts + * Request options for the {@code /api/auth/userinfo/issue} API. + * + * @return + * A response that should be returned to the client application. + * + * @since 2.82 + */ + public Response handle( + AuthleteApi api, UserInfoRequestHandlerSpi spi, Params params, Options userInfoOpts, + Options userInfoIssueOpts) { try { @@ -109,7 +192,7 @@ public Response handle( UserInfoRequestHandler handler = new UserInfoRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(params); + return handler.handle(params, userInfoOpts, userInfoIssueOpts); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java b/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java index 6f514dc..8b3fbfc 100644 --- a/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019-2021 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.ClientRegistrationResponse; import com.authlete.common.dto.ClientRegistrationResponse.Action; import com.authlete.common.web.BearerToken; @@ -89,7 +90,8 @@ public ClientRegistrationRequestHandler(AuthleteApi api) /** - * Handle a dynamic client registration request. + * Handle a dynamic client registration request. This method is an alias of + * {@link #handleRegister(String, String, Options)}{@code (json, authorization, null)}. * * @param json * The serialized JSON body of the client registration request. @@ -105,13 +107,40 @@ public ClientRegistrationRequestHandler(AuthleteApi api) * An error occurred. */ public Response handleRegister(String json, String authorization) + { + return handleRegister(json, authorization, null); + } + + + /** + * Handle a dynamic client registration request. + * + * @param json + * The serialized JSON body of the client registration request. + * + * @param authorization + * The value of {@code Authorization} header of the token request. + * This is optional. + * + * @param options + * Request options for the {@code /api/client/registration} API. + * + * @return + * A response that should be returned to the client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handleRegister(String json, String authorization, Options options) { String initialAccessToken = BearerToken.parse(authorization); try { ClientRegistrationResponse response = getApiCaller().callClientRegistration( - json, initialAccessToken); + json, initialAccessToken, options); return process(response); } catch (WebApplicationException e) @@ -126,7 +155,8 @@ public Response handleRegister(String json, String authorization) /** - * Handle a dynamic client management GET request. + * Handle a dynamic client management GET request. This method is an alias of + * the {@link #handleGet(String, String, Options)}{@code (clientId, authorization, null)}. * * @param clientId * The client ID as determined by the incoming request. @@ -142,13 +172,40 @@ public Response handleRegister(String json, String authorization) * An error occurred. */ public Response handleGet(String clientId, String authorization) + { + return handleGet(clientId, authorization, null); + } + + + /** + * Handle a dynamic client management GET request. + * + * @param clientId + * The client ID as determined by the incoming request. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @param options + * Request options for the {@code /api/client/registration} API. + * + * @return + * A response that should be returned to the client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handleGet(String clientId, String authorization, Options options) { String registrationAccessToken = BearerToken.parse(authorization); try { ClientRegistrationResponse response = getApiCaller().callClientRegistrationGet( - clientId, registrationAccessToken); + clientId, registrationAccessToken, options); return process(response); } catch (WebApplicationException e) @@ -163,7 +220,8 @@ public Response handleGet(String clientId, String authorization) /** - * Handle a dynamic client management PUT request. + * Handle a dynamic client management PUT request. This method is an alias of + * {@link #handleUpdate(String, String, String, Options)}{@code (clientId, json, authorization, null)}. * * @param clientId * The client ID as determined by the incoming request. @@ -182,13 +240,44 @@ public Response handleGet(String clientId, String authorization) * An error occurred. */ public Response handleUpdate(String clientId, String json, String authorization) + { + return handleUpdate(clientId, json, authorization, null); + } + + + /** + * Handle a dynamic client management PUT request. + * + * @param clientId + * The client ID as determined by the incoming request. + * + * @param json + * The serialized JSON body of the client update request. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @param options + * Request options for the {@code /api/client/registration} API. + * + * @return + * A response that should be returned to the client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handleUpdate( + String clientId, String json, String authorization, Options options) { String registrationAccessToken = BearerToken.parse(authorization); try { ClientRegistrationResponse response = getApiCaller().callClientRegistrationUpdate( - clientId, json, registrationAccessToken); + clientId, json, registrationAccessToken, options); return process(response); } catch (WebApplicationException e) @@ -203,7 +292,8 @@ public Response handleUpdate(String clientId, String json, String authorization) /** - * Handle a dynamic client management DELETE request. + * Handle a dynamic client management DELETE request. This method is an alias + * of {@link #handleDelete(String, String, Options)}{@code (clientId, authorization, null)}. * * @param clientId * The client ID as determined by the incoming request. @@ -219,13 +309,40 @@ public Response handleUpdate(String clientId, String json, String authorization) * An error occurred. */ public Response handleDelete(String clientId, String authorization) + { + return handleDelete(clientId, authorization, null); + } + + + /** + * Handle a dynamic client management DELETE request. + * + * @param clientId + * The client ID as determined by the incoming request. + * + * @param authorization + * The value of {@code Authorization} header of the registration request. + * This is optional. + * + * @param options + * Request options for the {@code /api/client/registration} API. + * + * @return + * A response that should be returned to the client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handleDelete(String clientId, String authorization, Options options) { String registrationAccessToken = BearerToken.parse(authorization); try { ClientRegistrationResponse response = getApiCaller().callClientRegistrationDelete( - clientId, registrationAccessToken); + clientId, registrationAccessToken, options); return process(response); } catch (WebApplicationException e) diff --git a/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java b/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java index 7fd916d..1e0ae95 100644 --- a/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2022 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.ServiceConfigurationRequest; @@ -102,6 +103,48 @@ public Response handle() throws WebApplicationException } + /** + * Handle a request to an OpenID Provider configuration endpoint. This + * method is an alias of {@link #handle(boolean, Options) handle}{@code (true, options)}. + * + * @param options + * Request options to the Authlete API. + * + * @return + * A response that should be returned from the endpoint to + * the client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle(Options options) throws WebApplicationException + { + return handle(true, options); + } + + + /** + * Handle a request to an OpenID Provider configuration endpoint. This + * method is an alias of {@link #handle(boolean, Options) handle}{@code (pretty, null)}. + * + * @param pretty + * {@code true} to return the output JSON in pretty format. + * + * @return + * A response that should be returned from the endpoint to + * the client application. + * + * @throws WebApplicationException + * An error occurred. + */ + public Response handle(boolean pretty) throws WebApplicationException + { + return handle(pretty, null); + } + + /** * Handle a request to an OpenID Provider configuration endpoint. This * method internally calls Authlete's {@code /api/service/configuration} @@ -110,21 +153,26 @@ public Response handle() throws WebApplicationException * @param pretty * {@code true} to return the output JSON in pretty format. * + * @param options + * Request options to the Authlete API. + * * @return * A response that should be returned from the endpoint to * the client application. * * @throws WebApplicationException * An error occurred. + * + * @since 2.82 */ - public Response handle(boolean pretty) throws WebApplicationException + public Response handle(boolean pretty, Options options) throws WebApplicationException { try { // Call Authlete's /api/service/configuration API. // The API returns a JSON that complies with // OpenID Connect Discovery 1.0. - String json = getApiCaller().callServiceConfiguration(pretty); + String json = getApiCaller().callServiceConfiguration(pretty, options); // Response as "application/json;charset=UTF-8" with 200 OK. return ResponseUtil.ok(json); @@ -144,8 +192,8 @@ public Response handle(boolean pretty) throws WebApplicationException /** * Handle a request to an OpenID Provider configuration endpoint. This - * method internally calls Authlete's {@code /api/service/configuration} - * API. + * method is an alias of {@link + * #handle(ServiceConfigurationRequest, Options) handle}{@code (request, null)}. * * @param request * Request parameters to the Authlete API. @@ -159,13 +207,39 @@ public Response handle(boolean pretty) throws WebApplicationException * @since 2.50 */ public Response handle(ServiceConfigurationRequest request) throws WebApplicationException + { + return handle(request, null); + } + + + /** + * Handle a request to an OpenID Provider configuration endpoint. This + * method internally calls Authlete's {@code /api/service/configuration} + * API. + * + * @param request + * Request parameters to the Authlete API. + * + * @param options + * Request options to the Authlete API. + * + * @return + * A response that should be returned from the discovery endpoint. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + ServiceConfigurationRequest request, Options options) throws WebApplicationException { try { // Call Authlete's /api/service/configuration API. // The API returns a JSON that complies with // OpenID Connect Discovery 1.0. - String json = getApiCaller().callServiceConfiguration(request); + String json = getApiCaller().callServiceConfiguration(request, options); // Response as "application/json;charset=UTF-8" with 200 OK. return ResponseUtil.ok(json); diff --git a/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java b/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java index fb17283..355cd5e 100644 --- a/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.CredentialIssuerMetadataRequest; import com.authlete.common.dto.CredentialIssuerMetadataResponse; import com.authlete.common.dto.CredentialIssuerMetadataResponse.Action; @@ -53,23 +54,50 @@ public CredentialIssuerMetadataRequestHandler(AuthleteApi api) } + /** + * Handle a request to the credential issuer metadata endpoint. This method + * is an alias of the {@link + * #handle(CredentialIssuerMetadataRequest, Options)}{@code (request, null)}. + * + * @param request + * A credential issuer metadata request. + * + * @return + * A response that should be returned from the credential issuer + * metadata endpoint. + * + * @throws WebApplicationException + */ + public Response handle( + CredentialIssuerMetadataRequest request) throws WebApplicationException + { + return handle(request, null); + } + + /** * Handle a request to the credential issuer metadata endpoint. * * @param request * A credential issuer metadata request. * + * @param options + * Request options for the {@code /api/vci/metadata} API. + * * @return * A response that should be returned from the credential issuer * metadata endpoint. * * @throws WebApplicationException + * + * @since 2.82 */ - public Response handle(CredentialIssuerMetadataRequest request) throws WebApplicationException + public Response handle( + CredentialIssuerMetadataRequest request, Options options) throws WebApplicationException { // Call Authlete's /vci/metadata API. CredentialIssuerMetadataResponse response = - getApiCaller().callCredentialIssuerMetadata(request); + getApiCaller().callCredentialIssuerMetadata(request, options); // 'action' in the response denotes the next action which // the implementation of the endpoint should take. diff --git a/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java b/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java index 9eb0462..0f262fc 100644 --- a/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.CredentialJwtIssuerMetadataRequest; import com.authlete.common.dto.CredentialJwtIssuerMetadataResponse; import com.authlete.common.dto.CredentialJwtIssuerMetadataResponse.Action; @@ -54,7 +55,9 @@ public CredentialJwtIssuerMetadataRequestHandler(AuthleteApi api) /** - * Handle a request to the JWT issuer metadata endpoint. + * Handle a request to the JWT issuer metadata endpoint. This method + * is an alias of {@link #handle(CredentialJwtIssuerMetadataRequest, Options) + * handle}{@code (request, null)}. * * @param request * A JWT issuer metadata request. @@ -66,10 +69,32 @@ public CredentialJwtIssuerMetadataRequestHandler(AuthleteApi api) * @throws WebApplicationException */ public Response handle(CredentialJwtIssuerMetadataRequest request) throws WebApplicationException + { + return handle(request, null); + } + + + /** + * Handle a request to the JWT issuer metadata endpoint. + * + * @param request + * A JWT issuer metadata request. + * + * @param options + * Request options for the {@code /api/vci/jwtissuer} API. + * + * @return + * A response that should be returned from the JWT issuer + * metadata endpoint. + * + * @throws WebApplicationException + */ + public Response handle( + CredentialJwtIssuerMetadataRequest request, Options options) throws WebApplicationException { // Call Authlete's /vci/jwtissuer API. CredentialJwtIssuerMetadataResponse response = - getApiCaller().callCredentialJwtIssuerMetadata(request); + getApiCaller().callCredentialJwtIssuerMetadata(request, options); // 'action' in the response denotes the next action which // the implementation of the endpoint should take. diff --git a/src/main/java/com/authlete/jakarta/CredentialOfferUriRequestHandler.java b/src/main/java/com/authlete/jakarta/CredentialOfferUriRequestHandler.java index ab1cd6b..d422b5d 100644 --- a/src/main/java/com/authlete/jakarta/CredentialOfferUriRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/CredentialOfferUriRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2023 Authlete, Inc. + * Copyright (C) 2023-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.CredentialOfferInfoRequest; import com.authlete.common.dto.CredentialOfferInfoResponse; @@ -33,10 +34,17 @@ public CredentialOfferUriRequestHandler(final AuthleteApi api) public Response handle(final CredentialOfferInfoRequest request) + { + return handle(request, null); + } + + + public Response handle(final CredentialOfferInfoRequest request, Options options) { try { - final CredentialOfferInfoResponse response = getApiCaller().callCredentialOfferInfo(request); + final CredentialOfferInfoResponse response = + getApiCaller().callCredentialOfferInfo(request, options); return process(response); } catch (WebApplicationException e) diff --git a/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java b/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java index 985c6fb..69cd016 100644 --- a/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,6 +22,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.DeviceAuthorizationResponse; import com.authlete.common.dto.DeviceAuthorizationResponse.Action; import com.authlete.common.web.BasicCredentials; @@ -66,7 +67,8 @@ public DeviceAuthorizationRequestHandler(AuthleteApi api) /** * Handler for device authorization requests in OAuth 2.0 Device Authorization - * Grant (Device Flow). + * Grant (Device Flow). This method is an alias of {@link #handle(MultivaluedMap, String, String[], Options) + * handle}{@code (parameters, authorization, clientCertificatePath, null)}. * * @param parameters * Request parameters of a device authorization request. @@ -93,6 +95,45 @@ public DeviceAuthorizationRequestHandler(AuthleteApi api) public Response handle( MultivaluedMap parameters, String authorization, String[] clientCertificatePath) throws WebApplicationException + { + return handle(parameters, authorization, clientCertificatePath, null); + } + + + /** + * Handler for device authorization requests in OAuth 2.0 Device Authorization + * Grant (Device Flow). + * + * @param parameters + * Request parameters of a device authorization request. + * + * @param authorization + * The value of {@code Authorization} header in the device authorization + * request. A client application may embed its pair of client ID and + * client secret in a device authorization request using Basic + * Authentication. + * + * @param clientCertificatePath + * The path of the client's certificate, each in PEM format. The first + * item in the array is the client's certificate itself. May be {@code null} + * if the client did not send a certificate or path. + * + * @param options + * Request options for the {@code /api/device/authorization} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath, Options options) throws WebApplicationException { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -106,7 +147,7 @@ public Response handle( try { // Process the given parameters. - return process(parameters, clientId, clientSecret, clientCertificatePath); + return process(parameters, clientId, clientSecret, clientCertificatePath, options); } catch (WebApplicationException e) { @@ -125,7 +166,7 @@ public Response handle( */ private Response process( MultivaluedMap parameters, String clientId, - String clientSecret, String[] clientCertificatePath) + String clientSecret, String[] clientCertificatePath, Options options) { // TODO: Duplicate code. String clientCertificate = null; @@ -144,7 +185,7 @@ private Response process( // Call Authlete's /api/device/authorization API. DeviceAuthorizationResponse response = getApiCaller().callDeviceAuthorization( - parameters, clientId, clientSecret, clientCertificate, clientCertificatePath); + parameters, clientId, clientSecret, clientCertificate, clientCertificatePath, options); // 'action' in the response denotes the next action which // this service implementation should take. diff --git a/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java b/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java index e7a9e9f..c21895d 100644 --- a/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019-2022 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,6 +23,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.DeviceCompleteRequest; import com.authlete.common.dto.DeviceCompleteRequest.Result; import com.authlete.common.dto.DeviceCompleteResponse; @@ -76,7 +77,8 @@ public DeviceCompleteRequestHandler(AuthleteApi api, DeviceCompleteRequestHandle /** * Handle the result of end-user authentication and authorization in OAuth - * 2.0 Device Authorization Grant (Device Flow). + * 2.0 Device Authorization Grant (Device Flow). This method is an alias of + * the {@link #handle(String, String[], Options)} method. * * @param userCode * The user code that the end-user input. @@ -93,11 +95,41 @@ public DeviceCompleteRequestHandler(AuthleteApi api, DeviceCompleteRequestHandle * An error occurred. */ public Response handle(String userCode, String[] claimNames) throws WebApplicationException + { + return handle(userCode, claimNames, null); + } + + + /** + * Handle the result of end-user authentication and authorization in OAuth + * 2.0 Device Authorization Grant (Device Flow). + * + * @param userCode + * The user code that the end-user input. + * + * @param claimNames + * Names of requested claims. Use the value of the {@code claimNames} + * parameter in a response from Authlete's {@code /api/device/verification} + * API. + * + * @param options + * Request options for the {@code /api/client/registration} API. + * + * @return + * A response that should be returned to the end-user. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + String userCode, String[] claimNames, Options options) throws WebApplicationException { try { // Process the given parameters. - return process(userCode, claimNames); + return process(userCode, claimNames, options); } catch (WebApplicationException e) { @@ -111,10 +143,10 @@ public Response handle(String userCode, String[] claimNames) throws WebApplicati } - private Response process(String userCode, String[] claimNames) + private Response process(String userCode, String[] claimNames, Options options) { // Call Authlete's /api/device/complete API. - DeviceCompleteResponse response = complete(userCode, claimNames); + DeviceCompleteResponse response = complete(userCode, claimNames, options); // 'action' in the response denotes the next action which // this service implementation should take. @@ -150,7 +182,7 @@ private Response process(String userCode, String[] claimNames) } - private DeviceCompleteResponse complete(String userCode, String[] claimNames) + private DeviceCompleteResponse complete(String userCode, String[] claimNames, Options options) { // Get the result of end-user authentication and authorization. Result result = mSpi.getResult(); @@ -165,7 +197,7 @@ private DeviceCompleteResponse complete(String userCode, String[] claimNames) // The end-user has not successfully authorized the client. // Then, complete the process with failure. - return fail(userCode, result, errorDescription, errorUri); + return fail(userCode, result, errorDescription, errorUri, options); } // OK. The end-user has successfully authorized the client. @@ -192,7 +224,8 @@ private DeviceCompleteResponse complete(String userCode, String[] claimNames) Property[] properties = mSpi.getProperties(); // Complete the process with successful authorization. - return authorize(userCode, subject, authTime, acr, claims, properties, scopes); + return authorize( + userCode, subject, authTime, acr, claims, properties, scopes, options); } @@ -236,30 +269,31 @@ private Map collectClaims(String[] requestedClaimNames) private DeviceCompleteResponse authorize( String userCode, String subject, long authTime, String acr, Map claims, - Property[] properties, String[] scopes) + Property[] properties, String[] scopes, Options options) { return callDeviceComlete( userCode, subject, Result.AUTHORIZED, authTime, acr, claims, - properties, scopes, null, null); + properties, scopes, null, null, options); } private DeviceCompleteResponse fail( - String userCode, Result result, String errorDescription, URI errorUri) + String userCode, Result result, String errorDescription, URI errorUri, + Options options) { return callDeviceComlete( userCode, null, result, 0, null, null, null, null, errorDescription, - errorUri); + errorUri, options); } private DeviceCompleteResponse callDeviceComlete( String userCode, String subject, DeviceCompleteRequest.Result result, long authTime, String acr, Map claims, Property[] properties, - String[] scopes, String errorDescription, URI errorUri) + String[] scopes, String errorDescription, URI errorUri, Options options) { return getApiCaller().callDeviceComplete( userCode, subject, result, authTime, acr, claims, properties, scopes, - errorDescription, errorUri); + errorDescription, errorUri, options); } } diff --git a/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java b/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java index 0b4b344..066cc77 100644 --- a/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019-2022 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.DeviceVerificationResponse; import com.authlete.common.dto.DeviceVerificationResponse.Action; import com.authlete.jakarta.spi.DeviceVerificationRequestHandlerSpi; @@ -71,7 +72,8 @@ public DeviceVerificationRequestHandler(AuthleteApi api, DeviceVerificationReque /** * Handle information associated with a user code that the end-user * input at the verification endpoint in OAuth 2.0 Device Authorization Grant - * (Device Flow). + * (Device Flow). This method is an alias of {@link #handle(Options) handle}{@code + * (null)}. * * @return * A response that should be returned to the end-user. @@ -80,11 +82,31 @@ public DeviceVerificationRequestHandler(AuthleteApi api, DeviceVerificationReque * An error occurred. */ public Response handle() throws WebApplicationException + { + return handle(null); + } + + + /** + * Handle information associated with a user code that the end-user + * input at the verification endpoint in OAuth 2.0 Device Authorization Grant + * (Device Flow). + * + * @param options + * Request options for the {@code /api/device/verification} API. + * + * @return + * A response that should be returned to the end-user. + * + * @throws WebApplicationException + * An error occurred. + */ + public Response handle(Options options) throws WebApplicationException { try { // Process the given parameters. - return process(); + return process(null); } catch (WebApplicationException e) { @@ -98,10 +120,11 @@ public Response handle() throws WebApplicationException } - private Response process() + private Response process(Options options) { // Call Authlete's /api/device/verification API. - DeviceVerificationResponse response = getApiCaller().callDeviceVerification(mSpi.getUserCode()); + DeviceVerificationResponse response = + getApiCaller().callDeviceVerification(mSpi.getUserCode(), options); // 'action' in the response denotes the next action which // this service implementation should take. diff --git a/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java b/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java index 941f576..bd9849b 100644 --- a/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022 Authlete, Inc. + * Copyright (C) 2022-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.FederationConfigurationRequest; import com.authlete.common.dto.FederationConfigurationResponse; import com.authlete.common.dto.FederationConfigurationResponse.Action; @@ -54,7 +55,9 @@ public FederationConfigurationRequestHandler(AuthleteApi api) /** - * Handle a request to the entity configuration endpoint. + * Handle a request to the entity configuration endpoint. This method is an + * alias of {@link #handle(FederationConfigurationRequest, Options) handle}{@code + * (request, null)}. * * @param request * An entity configuration request. @@ -66,10 +69,34 @@ public FederationConfigurationRequestHandler(AuthleteApi api) * @throws WebApplicationException */ public Response handle(FederationConfigurationRequest request) throws WebApplicationException + { + return handle(request, null); + } + + + /** + * Handle a request to the entity configuration endpoint. + * + * @param request + * An entity configuration request. + * + * @param options + * Request options for the {@code /api/federation/configuration} API. + * + * @return + * A response that should be returned from the entity configuration + * endpoint. + * + * @throws WebApplicationException + * + * @since 2.82 + */ + public Response handle( + FederationConfigurationRequest request, Options options) throws WebApplicationException { // Call Authlete's /api/federation/configuration API. FederationConfigurationResponse response = - getApiCaller().callFederationConfiguration(request); + getApiCaller().callFederationConfiguration(request, options); // 'action' in the response denotes the next action which // the implementation of the endpoint should take. diff --git a/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java b/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java index b89161c..7300703 100644 --- a/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022 Authlete, Inc. + * Copyright (C) 2022-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.FederationRegistrationRequest; import com.authlete.common.dto.FederationRegistrationResponse; import com.authlete.common.dto.FederationRegistrationResponse.Action; @@ -54,7 +55,9 @@ public FederationRegistrationRequestHandler(AuthleteApi api) /** - * Handle a request to the federation registration endpoint. + * Handle a request to the federation registration endpoint. This method is + * an alias of {@link #handle(FederationRegistrationRequest, Options) handle}{@code + * (request, null)}. * * @param request * An "explicit" client registration request. @@ -66,10 +69,34 @@ public FederationRegistrationRequestHandler(AuthleteApi api) * @throws WebApplicationException */ public Response handle(FederationRegistrationRequest request) throws WebApplicationException + { + return handle(request, null); + } + + + /** + * Handle a request to the federation registration endpoint. + * + * @param request + * An "explicit" client registration request. + * + * @param options + * Request options for the {@code /api/federation/registration} API. + * + * @return + * A response that should be returned from the federation + * registration endpoint. + * + * @throws WebApplicationException + * + * @since 2.82 + */ + public Response handle( + FederationRegistrationRequest request, Options options) throws WebApplicationException { // Call Authlete's /api/federation/registration API. FederationRegistrationResponse response = - getApiCaller().callFederationRegistration(request); + getApiCaller().callFederationRegistration(request, options); // 'action' in the response denotes the next action which // the implementation of the endpoint should take. diff --git a/src/main/java/com/authlete/jakarta/GMRequestHandler.java b/src/main/java/com/authlete/jakarta/GMRequestHandler.java index cf371e8..c6f9c3a 100644 --- a/src/main/java/com/authlete/jakarta/GMRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/GMRequestHandler.java @@ -22,6 +22,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.GMRequest; import com.authlete.common.dto.GMResponse; import com.authlete.common.dto.GMResponse.Action; @@ -54,7 +55,8 @@ public GMRequestHandler(AuthleteApi api) /** - * Handle a grant management request. + * Handle a grant management request. This method is an alias of the {@link + * #handle(GMRequest, Options) handle}{@code (request, null)}. * * @param request * A grant management request. @@ -66,9 +68,33 @@ public GMRequestHandler(AuthleteApi api) * @throws WebApplicationException */ public Response handle(GMRequest request) throws WebApplicationException + { + return handle(request, null); + } + + + /** + * Handle a grant management request. + * + * @param request + * A grant management request. + * + * @param options + * Request options for the {@code /api/gm} API. + * + * @return + * A response that should be returned from the grant management + * endpoint to the client application. + * + * @throws WebApplicationException + * + * @since 2.82 + */ + public Response handle( + GMRequest request, Options options) throws WebApplicationException { // Call Authlete's /api/gm API. - GMResponse response = getApiCaller().callGm(request); + GMResponse response = getApiCaller().callGm(request, options); // 'action' in the response denotes the next action which // the implementation of grant management endpoint should take. diff --git a/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java b/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java index 5094516..7b765ee 100644 --- a/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2017-2023 Authlete, Inc. + * Copyright (C) 2017-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,6 +23,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.StandardIntrospectionResponse; import com.authlete.common.dto.StandardIntrospectionResponse.Action; import com.authlete.common.types.JWEAlg; @@ -468,33 +469,61 @@ public IntrospectionRequestHandler(AuthleteApi api) /** * Handle an introspection request (RFC 7662). + * >RFC 7662). This method is an alias of {@link #handle(MultivaluedMap, Options) + * handle}{@code (parameters, null)}. * - * This method is an alias of the {@link #handle(Params)} method. + * @param parameters + * Request parameters of an introspection request. + * + * @return + * A response that should be returned from the endpoint to + * the resource server. + * + * @throws WebApplicationException + * An error occurred. + */ + public Response handle( + MultivaluedMap parameters) throws WebApplicationException + { + return handle(parameters, null); + } + + + /** + * Handle an introspection request (RFC 7662). This method is an alias of the {@link #handle(Params, Options)} + * method. * * @param parameters * Request parameters of an introspection request. * + * @param options + * Request options for the {@code /api/auth/introspection/standard} API. + * * @return * A response that should be returned from the endpoint to * the resource server. * * @throws WebApplicationException * An error occurred. + * + * @since 2.82 */ - public Response handle(MultivaluedMap parameters) throws WebApplicationException + public Response handle( + MultivaluedMap parameters, Options options) throws WebApplicationException { Params params = new Params() .setParameters(parameters) ; - return handle(params); + return handle(params, options); } /** * Handle an introspection request (RFC 7662). + * >RFC 7662). This method is an alias of {@link #handle(Params, Options) + * handle}{@code (params, null)}. * * @param params * Parameters needed to handle the introspection request. @@ -510,6 +539,32 @@ public Response handle(MultivaluedMap parameters) throws WebAppl * @since 2.63 */ public Response handle(Params params) throws WebApplicationException + { + return handle(params, null); + } + + + /** + * Handle an introspection request (RFC 7662). + * + * @param params + * Parameters needed to handle the introspection request. + * Must not be {@code null}. + * + * @param options + * Request options for the {@code /api/auth/introspection/standard} API. + * + * @return + * A response that should be returned from the endpoint to + * the resource server. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle(Params params, Options options) throws WebApplicationException { try { @@ -524,7 +579,8 @@ public Response handle(Params params) throws WebApplicationException params.getIntrospectionEncryptionEnc(), params.getSharedKeyForSign(), params.getSharedKeyForEncryption(), - params.getPublicKeyForEncryption() + params.getPublicKeyForEncryption(), + options ); } catch (WebApplicationException e) @@ -545,13 +601,13 @@ public Response handle(Params params) throws WebApplicationException private Response process( MultivaluedMap parameters, boolean withHiddenProperties, String httpAcceptHeader, URI rsUri, JWSAlg introspectionSignAlg, JWEAlg introspectionEncAlg, JWEEnc introspectionEncEnc, - String sharedKeyForSign, String sharedKeyForEncryption, String publicKeyForEncryption) + String sharedKeyForSign, String sharedKeyForEncryption, String publicKeyForEncryption, Options options) { // Call Authlete's /api/auth/introspection/standard API. StandardIntrospectionResponse response = getApiCaller().callStandardIntrospection( parameters, withHiddenProperties, httpAcceptHeader, rsUri, introspectionSignAlg, introspectionEncAlg, introspectionEncEnc, sharedKeyForSign, sharedKeyForEncryption, - publicKeyForEncryption); + publicKeyForEncryption, options); // 'action' in the response denotes the next action which // this service implementation should take. diff --git a/src/main/java/com/authlete/jakarta/JwksRequestHandler.java b/src/main/java/com/authlete/jakarta/JwksRequestHandler.java index e241397..b858066 100644 --- a/src/main/java/com/authlete/jakarta/JwksRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/JwksRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +20,7 @@ import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; /** @@ -57,7 +58,7 @@ public JwksRequestHandler(AuthleteApi api) /** * Handle a request to a JWK Set endpoint. This method is an alias - * of {@link #handle(boolean) handle}{@code (true)}. + * of {@link #handle(Options) handle}{@code (null)}. * * @return * A response that should be returned from the endpoint to @@ -68,7 +69,49 @@ public JwksRequestHandler(AuthleteApi api) */ public Response handle() throws WebApplicationException { - return handle(true); + return handle(null); + } + + + /** + * Handle a request to a JWK Set endpoint. This method is an alias + * of {@link #handle(boolean, Options) handle}{@code (true, options)}. + * + * @param options + * Request options for the {@code /api/service/jwks/get} API. + * + * @return + * A response that should be returned from the endpoint to + * the client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle(Options options) throws WebApplicationException + { + return handle(true, options); + } + + + /** + * Handle a request to a JWK Set endpoint. This method is an alias + * of {@link #handle(boolean, Options) handle}{@code (pretty, null)}. + * + * @param pretty + * {@code true} to return the output JSON in pretty format. + * + * @return + * A response that should be returned from the endpoint to + * the client application. + * + * @throws WebApplicationException + * An error occurred. + */ + public Response handle(boolean pretty) throws WebApplicationException + { + return handle(pretty, null); } @@ -79,20 +122,25 @@ public Response handle() throws WebApplicationException * @param pretty * {@code true} to return the output JSON in pretty format. * + * @param options + * Request options for the {@code /api/service/jwks/get} API. + * * @return * A response that should be returned from the endpoint to * the client application. * * @throws WebApplicationException * An error occurred. + * + * @since 2.82 */ - public Response handle(boolean pretty) throws WebApplicationException + public Response handle(boolean pretty, Options options) throws WebApplicationException { try { // Call Authlete's /api/service/jwks/get API. It returns the JWK Set // of the service. Of course, private keys are not included. - return getApiCaller().serviceJwksGet(pretty, false); + return getApiCaller().serviceJwksGet(pretty, false, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java b/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java index 4afa3d8..a78cbbd 100644 --- a/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java +++ b/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019-2023 Authlete, Inc. + * Copyright (C) 2019-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,6 +25,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.PushedAuthReqResponse; import com.authlete.common.dto.PushedAuthReqResponse.Action; import com.authlete.common.web.BasicCredentials; @@ -310,7 +311,9 @@ public PushedAuthReqHandler(AuthleteApi api) /** - * Handle a pushed authorization request. + * Handle a pushed authorization request. This method is an alias + * of {@link #handle(MultivaluedMap, String, String[], Options) handle}{@code + * (parameters, authorization, clientCertificatePath, null)}. * * @param parameters * Request parameters of a pushed authorization request. @@ -337,6 +340,45 @@ public PushedAuthReqHandler(AuthleteApi api) public Response handle( MultivaluedMap parameters, String authorization, String[] clientCertificatePath) throws WebApplicationException + { + return handle(parameters, authorization, clientCertificatePath, null); + } + + + /** + * Handle a pushed authorization request. This method is an alias of the {@link + * #handle(Params, Options)} method. + * + * @param parameters + * Request parameters of a pushed authorization request. + * + * @param authorization + * The value of {@code Authorization} header in the pushed + * authorization request. A client application may embed its + * pair of client ID and client secret in a pushed authorization + * request using Basic Authentication. + * + * @param clientCertificatePath + * The path of the client's certificate, each in PEM format. + * The first item in the array is the client's certificate itself. + * May be {@code null} if the client did not send a certificate or path. + * + * @param options + * Request options for the {@code /api/pushed_auth_req} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath, Options options) throws WebApplicationException { Params params = new Params() .setParameters(parameters) @@ -344,12 +386,13 @@ public Response handle( .setClientCertificatePath(clientCertificatePath) ; - return handle(params); + return handle(params, options); } /** - * Handle a PAR request. + * Handle a PAR request. This method is an alias of {@link #handle(Params, Options) + * handle}{@code (params, null)}. * * @param params * Parameters needed to handle the PAR request. @@ -365,6 +408,31 @@ public Response handle( * @since 2.69 */ public Response handle(Params params) + { + return handle(params, null); + } + + + /** + * Handle a PAR request. + * + * @param params + * Parameters needed to handle the PAR request. + * Must not be {@code null}. + * + * @param options + * Request options for the {@code /api/pushed_auth_req} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle(Params params, Options options) { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -385,7 +453,8 @@ public Response handle(Params params) params.getClientCertificatePath(), params.getDpop(), params.getHtm(), - params.getHtu() + params.getHtu(), + options ); } catch (WebApplicationException e) @@ -406,7 +475,7 @@ public Response handle(Params params) private Response process( MultivaluedMap parameters, String clientId, String clientSecret, String[] clientCertificatePath, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options options) { String clientCertificate = null; if (clientCertificatePath != null && clientCertificatePath.length > 0) @@ -424,7 +493,7 @@ private Response process( PushedAuthReqResponse response = getApiCaller().callPushedAuthReq( parameters, clientId, clientSecret, - clientCertificate, clientCertificatePath, dpop, htm, htu); + clientCertificate, clientCertificatePath, dpop, htm, htu, options); // 'action' in the response denotes the next action which // this service implementation should take. diff --git a/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java b/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java index c804b47..9001b92 100644 --- a/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015-2016 Authlete, Inc. + * Copyright (C) 2015-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.RevocationResponse; import com.authlete.common.dto.RevocationResponse.Action; import com.authlete.common.web.BasicCredentials; @@ -62,6 +63,35 @@ public RevocationRequestHandler(AuthleteApi api) } + /** + * Handle a token revocation request (RFC 7009). This method is an alias of {@link #handle(MultivaluedMap, String, Options) + * handle}{@code (parameters, authorization, null)}. + * + * @param parameters + * Request parameters of a token revocation request. + * + * @param authorization + * The value of {@code Authorization} header in the token revocation + * request. A client application may embed its pair of client ID and + * client secret in a token revocation request using Basic + * Authentication. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + */ + public Response handle( + MultivaluedMap parameters, String authorization) throws WebApplicationException + { + return handle(parameters, authorization, null); + } + + /** * Handle a token revocation request (RFC 7009). @@ -76,14 +106,21 @@ public RevocationRequestHandler(AuthleteApi api) * "https://tools.ietf.org/html/rfc2617#section-2">Basic * Authentication. * + * @param options + * Request options for the {@code /api/auth/revocation} API. + * * @return * A response that should be returned from the endpoint to the * client application. * * @throws WebApplicationException * An error occurred. + * + * @since 2.82 */ - public Response handle(MultivaluedMap parameters, String authorization) throws WebApplicationException + public Response handle( + MultivaluedMap parameters, String authorization, + Options options) throws WebApplicationException { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -97,7 +134,7 @@ public Response handle(MultivaluedMap parameters, String authori try { // Process the given parameters. - return process(parameters, clientId, clientSecret); + return process(parameters, clientId, clientSecret, options); } catch (WebApplicationException e) { @@ -114,10 +151,12 @@ public Response handle(MultivaluedMap parameters, String authori /** * Process the parameters of the revocation request. */ - private Response process(MultivaluedMap parameters, String clientId, String clientSecret) + private Response process( + MultivaluedMap parameters, String clientId, String clientSecret, Options options) { // Call Authlete's /api/auth/revocation API. - RevocationResponse response = getApiCaller().callRevocation(parameters, clientId, clientSecret); + RevocationResponse response = getApiCaller() + .callRevocation(parameters, clientId, clientSecret, options); // 'action' in the response denotes the next action which // this service implementation should take. diff --git a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java index 9823d4b..a23ad4f 100644 --- a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015-2023 Authlete, Inc. + * Copyright (C) 2015-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,6 +25,7 @@ import jakarta.ws.rs.core.MultivaluedMap; import jakarta.ws.rs.core.Response; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.dto.Property; import com.authlete.common.dto.TokenFailRequest.Reason; import com.authlete.common.dto.TokenResponse; @@ -322,9 +323,9 @@ public TokenRequestHandler(AuthleteApi api, TokenRequestHandlerSpi spi) /** - * Handle a token request. - * - * This method is an alias of the {@link #handle(Params)} method. + * Handle a token request. This method is an alias of {@link + * #handle(MultivaluedMap, String, Options, Options, Options) handle}{@code + * (parameters, authorization, null, null, null)}. * * @param parameters * Request parameters of a token request. @@ -346,19 +347,55 @@ public TokenRequestHandler(AuthleteApi api, TokenRequestHandlerSpi spi) public Response handle( MultivaluedMap parameters, String authorization) throws WebApplicationException { - Params params = new Params() - .setParameters(parameters) - .setAuthorization(authorization) - ; - - return handle(params); + return handle(parameters, authorization, null, null, null); } /** - * Handle a token request. + * Handle a token request. This method is an alias of {@link + * #handle(MultivaluedMap, String, String[], Options, Options, Options) handle}{@code + * (parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts)}. + * + * @param parameters + * Request parameters of a token request. + * + * @param authorization + * The value of {@code Authorization} header in the token request. + * A client application may embed its pair of client ID and client + * secret in a token request using Basic + * Authentication. * - * This method is an alias of the {@link #handle(Params)} method. + * @param tokenOpts + * Request options for the {@code /api/auth/token} API. + * + * @param tokenIssueOpts + * Request options for the {@code /api/auth/token/issue} API. + * + * @param tokenFailOpts + * Request options for the {@code /api/auth/token/fail} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + MultivaluedMap parameters, String authorization, + Options tokenOpts, Options tokenIssueOpts, Options tokenFailOpts) + throws WebApplicationException + { + return handle(parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts); + } + + + /** + * Handle a token request. This method is an alias of {@link #handle(MultivaluedMap, String, String[], Options, Options, Options) + * handle}{@code (parameters, authorization, clientCertificatePath, null, null, null)}. * * @param parameters * Request parameters of a token request. @@ -387,6 +424,52 @@ public Response handle( public Response handle( MultivaluedMap parameters, String authorization, String[] clientCertificatePath) throws WebApplicationException + { + return handle(parameters, authorization, clientCertificatePath, null, null, null); + } + + + /** + * Handle a token request. This method is an alias of the {@link #handle(Params, + * Options, Options, Options)} method. + * + * @param parameters + * Request parameters of a token request. + * + * @param authorization + * The value of {@code Authorization} header in the token request. + * A client application may embed its pair of client ID and client + * secret in a token request using Basic + * Authentication. + * + * @param clientCertificatePath + * The path of the client's certificate, each in PEM format. The first + * item in the array is the client's certificate itself. May be {@code null} if + * the client did not send a certificate or path. + * + * @param tokenOpts + * Request options for the {@code /api/auth/token} API. + * + * @param tokenIssueOpts + * Request options for the {@code /api/auth/token/issue} API. + * + * @param tokenFailOpts + * Request options for the {@code /api/auth/token/fail} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + MultivaluedMap parameters, String authorization, + String[] clientCertificatePath, Options tokenOpts, Options tokenIssueOpts, + Options tokenFailOpts) throws WebApplicationException { Params params = new Params() .setParameters(parameters) @@ -394,12 +477,13 @@ public Response handle( .setClientCertificatePath(clientCertificatePath) ; - return handle(params); + return handle(params, tokenOpts, tokenIssueOpts, tokenFailOpts); } /** - * Handle a token request. + * Handle a token request. This method is an alias of the {@link #handle(Params, + * Options, Options, Options) handle}{@code (params, null, null, null)}. * * @param params * Parameters needed to handle the token request. @@ -415,6 +499,39 @@ public Response handle( * @since 2.27 */ public Response handle(Params params) throws WebApplicationException + { + return handle(params, null, null, null); + } + + + /** + * Handle a token request. + * + * @param params + * Parameters needed to handle the token request. + * Must not be {@code null}. + * + * @param tokenOpts + * Request options for the {@code /api/auth/token} API. + * + * @param tokenIssueOpts + * Request options for the {@code /api/auth/token/issue} API. + * + * @param tokenFailOpts + * Request options for the {@code /api/auth/token/fail} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + Params params, Options tokenOpts, Options tokenIssueOpts, Options tokenFailOpts) + throws WebApplicationException { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -435,7 +552,10 @@ public Response handle(Params params) throws WebApplicationException params.getClientCertificatePath(), params.getDpop(), params.getHtm(), - params.getHtu() + params.getHtu(), + tokenOpts, + tokenIssueOpts, + tokenFailOpts ); } catch (WebApplicationException e) @@ -456,7 +576,8 @@ public Response handle(Params params) throws WebApplicationException private Response process( MultivaluedMap parameters, String clientId, String clientSecret, String[] clientCertificatePath, - String dpop, String htm, String htu) + String dpop, String htm, String htu, Options tokenOpts, Options tokenIssueOpts, + Options tokenFailOpts) { // Extra properties to associate with an access token. Property[] properties = mSpi.getProperties(); @@ -478,7 +599,7 @@ private Response process( // Call Authlete's /api/auth/token API. TokenResponse response = getApiCaller().callToken( parameters, clientId, clientSecret, properties, - clientCertificate, clientCertificatePath, dpop, htm, htu); + clientCertificate, clientCertificatePath, dpop, htm, htu, tokenOpts); // 'action' in the response denotes the next action which // this service implementation should take. @@ -507,7 +628,7 @@ private Response process( case PASSWORD: // Process the token request whose flow is "Resource Owner Password Credentials". - return handlePassword(response, headers); + return handlePassword(response, headers, tokenIssueOpts, tokenFailOpts); case OK: // 200 OK @@ -552,7 +673,9 @@ private static Map prepareHeaders(TokenResponse response) /** * Process the token request whose flow is "Resource Owner Password Credentials". */ - private Response handlePassword(TokenResponse response, Map headers) + private Response handlePassword( + TokenResponse response, Map headers, Options tokenIssueOpts, + Options tokenFailOpts) { // The credentials of the resource owner. String username = response.getUsername(); @@ -571,13 +694,14 @@ private Response handlePassword(TokenResponse response, Map head { // Issue an access token and optionally an ID token. return getApiCaller().tokenIssue( - ticket, subject, properties, headers); + ticket, subject, properties, headers, tokenIssueOpts); } else { // The credentials are invalid. An access token is not issued. throw getApiCaller().tokenFail( - ticket, Reason.INVALID_RESOURCE_OWNER_CREDENTIALS, headers); + ticket, Reason.INVALID_RESOURCE_OWNER_CREDENTIALS, headers, + tokenFailOpts); } } diff --git a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java index f338b57..93c90af 100644 --- a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2023 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,6 +25,7 @@ import jakarta.ws.rs.core.Response; import jakarta.ws.rs.core.Response.Status; import com.authlete.common.api.AuthleteApi; +import com.authlete.common.api.Options; import com.authlete.common.assurance.VerifiedClaims; import com.authlete.common.assurance.constraint.VerifiedClaimsConstraint; import com.authlete.common.assurance.constraint.VerifiedClaimsContainerConstraint; @@ -418,7 +419,8 @@ public UserInfoRequestHandler(AuthleteApi api, UserInfoRequestHandlerSpi spi) * "http://openid.net/specs/openid-connect-core-1_0.html#UserInfo" * >UserInfo Endpoint defined in OpenID Connect - * Core 1.0. + * Core 1.0. This method is an alias of {@link #handle(String, Options, Options) + * handle}{@code (accessToken, null, null)}. * * @param accessToken * An access token. @@ -431,17 +433,52 @@ public UserInfoRequestHandler(AuthleteApi api, UserInfoRequestHandlerSpi spi) * An error occurred. */ public Response handle(String accessToken) throws WebApplicationException + { + return handle(accessToken, null, null); + } + + + /** + * Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect + * Core 1.0. This method is an alias of the {@link + * #handle(Params, Options, Options)} method. + * + * @param accessToken + * An access token. + * + * @param userInfoOpts + * Request options for the {@code /api/auth/userinfo} API. + * + * @param userInfoIssueOpts + * Request options for the {@code /api/auth/userinfo/issue} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + String accessToken, Options userInfoOpts, Options userInfoIssueOpts) + throws WebApplicationException { Params params = new Params() .setAccessToken(accessToken) ; - return handle(params); + return handle(params, userInfoOpts, userInfoIssueOpts); } /** - * Handle a userinfo request. + * Handle a userinfo request. This method is an alias of {@link #handle(Params, Options, Options) + * handle}{@code (params, null, null)}. * * @param params * Parameters needed to handle the userinfo request. @@ -454,6 +491,35 @@ public Response handle(String accessToken) throws WebApplicationException * An error occurred. */ public Response handle(Params params) throws WebApplicationException + { + return handle(params, null, null); + } + + + /** + * Handle a userinfo request. + * + * @param params + * Parameters needed to handle the userinfo request. + * + * @param userInfoOpts + * Request options for the {@code /api/auth/userinfo} API. + * + * @param userInfoIssueOpts + * Request options for the {@code /api/auth/userinfo/issue} API. + * + * @return + * A response that should be returned from the endpoint to the + * client application. + * + * @throws WebApplicationException + * An error occurred. + * + * @since 2.82 + */ + public Response handle( + Params params, Options userInfoOpts, Options userInfoIssueOpts) + throws WebApplicationException { // If an access token is not available. if (params == null || params.getAccessToken() == null) @@ -466,7 +532,7 @@ public Response handle(Params params) throws WebApplicationException try { // Process the userinfo request. - return process(params); + return process(params, userInfoOpts, userInfoIssueOpts); } catch (WebApplicationException e) { @@ -483,7 +549,7 @@ public Response handle(Params params) throws WebApplicationException /** * Process the userinfo request with the access token. */ - private Response process(Params params) + private Response process(Params params, Options userInfoOpts, Options userInfoIssueOpts) { // Call Authlete's /api/auth/userinfo API. UserInfoResponse response = getApiCaller().callUserInfo( @@ -491,7 +557,8 @@ private Response process(Params params) params.getClientCertificate(), params.getDpop(), params.getHtm(), - params.getHtu() + params.getHtu(), + userInfoOpts ); // 'action' in the response denotes the next action which @@ -525,7 +592,7 @@ private Response process(Params params) case OK: // Return the user information. - return getUserInfo(params, response, headers); + return getUserInfo(params, response, headers, userInfoIssueOpts); default: // This never happens. @@ -554,7 +621,8 @@ private static Map prepareHeaders(UserInfoResponse response) * Authlete's {@code /api/auth/userinfo/issue} API. */ private Response getUserInfo( - Params params, UserInfoResponse response, Map headers) + Params params, UserInfoResponse response, Map headers, + Options options) { String subject = response.getSubject(); @@ -592,7 +660,7 @@ private Response getUserInfo( // Generate a JSON or a JWT containing user information // by calling Authlete's /api/auth/userinfo/issue API. return getApiCaller().userInfoIssue( - response.getToken(), claims, claimsForTx, verifiedClaimsForTx, headers); + response.getToken(), claims, claimsForTx, verifiedClaimsForTx, headers, options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/api/AuthleteApiImpl.java b/src/main/java/com/authlete/jakarta/api/AuthleteApiImpl.java index 966e18a..ba702f2 100644 --- a/src/main/java/com/authlete/jakarta/api/AuthleteApiImpl.java +++ b/src/main/java/com/authlete/jakarta/api/AuthleteApiImpl.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2014-2023 Authlete, Inc. + * Copyright (C) 2014-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,10 +21,12 @@ import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON_TYPE; import java.util.LinkedHashMap; import java.util.Map; +import jakarta.ws.rs.client.Invocation.Builder; import jakarta.ws.rs.client.WebTarget; import jakarta.ws.rs.core.GenericType; import com.authlete.common.api.AuthleteApi; import com.authlete.common.api.AuthleteApiException; +import com.authlete.common.api.Options; import com.authlete.common.conf.AuthleteApiVersion; import com.authlete.common.conf.AuthleteConfiguration; import com.authlete.common.dto.*; @@ -202,40 +204,40 @@ private String createServiceCredentials(AuthleteConfiguration configuration) private TResponse callServiceOwnerGetApi( - String path, Class responseClass, Map params) + String path, Class responseClass, Map params, Options options) { - return callGetApi(mServiceOwnerAuth, path, responseClass, params); + return callGetApi(mServiceOwnerAuth, path, responseClass, params, options); } private TResponse callServiceGetApi( - String path, Class responseClass, Map params) + String path, Class responseClass, Map params, Options options) { - return callGetApi(mServiceAuth, path, responseClass, params); + return callGetApi(mServiceAuth, path, responseClass, params, options); } - private Void callServiceOwnerDeleteApi(String path) + private Void callServiceOwnerDeleteApi(String path, Options options) { - return callDeleteApi(mServiceOwnerAuth, path); + return callDeleteApi(mServiceOwnerAuth, path, options); } - private Void callServiceDeleteApi(String path) + private Void callServiceDeleteApi(String path, Options options) { - return callDeleteApi(mServiceAuth, path); + return callDeleteApi(mServiceAuth, path, options); } - private TResponse callServiceOwnerPostApi(String path, Object request, Class responseClass) + private TResponse callServiceOwnerPostApi(String path, Object request, Class responseClass, Options options) { - return callPostApi(mServiceOwnerAuth, path, request, responseClass); + return callPostApi(mServiceOwnerAuth, path, request, responseClass, options); } - private TResponse callServicePostApi(String path, Object request, Class responseClass) + private TResponse callServicePostApi(String path, Object request, Class responseClass, Options options) { - return callPostApi(mServiceAuth, path, request, responseClass); + return callPostApi(mServiceAuth, path, request, responseClass, options); } @@ -245,6 +247,7 @@ private static abstract class ApiCaller implements AuthleteApiCall mResponseClass; protected final Map mParams = new LinkedHashMap<>(); + protected Options mOptions; ApiCaller(Class responseClass, Object request, String path) @@ -267,6 +270,14 @@ public ApiCaller addParam(String name, Object... values) return this; } + + + public ApiCaller setOptions(Options options) + { + mOptions = options; + + return this; + } } @@ -287,7 +298,7 @@ private class ServiceOwnerDeleteApiCaller extends ApiCaller @Override public Void call() { - return callServiceOwnerDeleteApi(mPath); + return callServiceOwnerDeleteApi(mPath, mOptions); } } @@ -309,7 +320,7 @@ private class ServiceOwnerGetApiCaller extends ApiCaller @Override public TResponse call() { - return callServiceOwnerGetApi(mPath, mResponseClass, mParams); + return callServiceOwnerGetApi(mPath, mResponseClass, mParams, mOptions); } } @@ -331,7 +342,7 @@ private class ServiceOwnerPostApiCaller extends ApiCaller @Override public TResponse call() { - return callServiceOwnerPostApi(mPath, mRequest, mResponseClass); + return callServiceOwnerPostApi(mPath, mRequest, mResponseClass, mOptions); } } @@ -353,7 +364,7 @@ private class ServiceDeleteApiCaller extends ApiCaller @Override public Void call() { - return callServiceDeleteApi(mPath); + return callServiceDeleteApi(mPath, mOptions); } } @@ -375,7 +386,7 @@ private class ServiceGetApiCaller extends ApiCaller @Override public TResponse call() { - return callServiceGetApi(mPath, mResponseClass, mParams); + return callServiceGetApi(mPath, mResponseClass, mParams, mOptions); } } @@ -397,7 +408,7 @@ private class ServicePostApiCaller extends ApiCaller @Override public TResponse call() { - return callServicePostApi(mPath, mRequest, mResponseClass); + return callServicePostApi(mPath, mRequest, mResponseClass, mOptions); } } @@ -406,11 +417,12 @@ public TResponse call() * Call {@code /api/auth/authorization} API. */ @Override - public AuthorizationResponse authorization(AuthorizationRequest request) throws AuthleteApiException + public AuthorizationResponse authorization(AuthorizationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - AuthorizationResponse.class, request, AUTH_AUTHORIZATION_API_PATH)); + AuthorizationResponse.class, request, AUTH_AUTHORIZATION_API_PATH) + .setOptions(options)); } @@ -418,11 +430,12 @@ public AuthorizationResponse authorization(AuthorizationRequest request) throws * Call {@code /api/auth/authorization/fail} API. */ @Override - public AuthorizationFailResponse authorizationFail(AuthorizationFailRequest request) throws AuthleteApiException + public AuthorizationFailResponse authorizationFail(AuthorizationFailRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - AuthorizationFailResponse.class, request, AUTH_AUTHORIZATION_FAIL_API_PATH)); + AuthorizationFailResponse.class, request, AUTH_AUTHORIZATION_FAIL_API_PATH) + .setOptions(options)); } @@ -430,11 +443,12 @@ public AuthorizationFailResponse authorizationFail(AuthorizationFailRequest requ * Call {@code /api/auth/authorization/issue} API. */ @Override - public AuthorizationIssueResponse authorizationIssue(AuthorizationIssueRequest request) throws AuthleteApiException + public AuthorizationIssueResponse authorizationIssue(AuthorizationIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - AuthorizationIssueResponse.class, request, AUTH_AUTHORIZATION_ISSUE_API_PATH)); + AuthorizationIssueResponse.class, request, AUTH_AUTHORIZATION_ISSUE_API_PATH) + .setOptions(options)); } @@ -442,11 +456,12 @@ public AuthorizationIssueResponse authorizationIssue(AuthorizationIssueRequest r * Call {@code /api/auth/token} API. */ @Override - public TokenResponse token(TokenRequest request) throws AuthleteApiException + public TokenResponse token(TokenRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - TokenResponse.class, request, AUTH_TOKEN_API_PATH)); + TokenResponse.class, request, AUTH_TOKEN_API_PATH) + .setOptions(options)); } @@ -454,11 +469,12 @@ public TokenResponse token(TokenRequest request) throws AuthleteApiException * Call {@code /api/auth/token/create} API. */ @Override - public TokenCreateResponse tokenCreate(TokenCreateRequest request) throws AuthleteApiException + public TokenCreateResponse tokenCreate(TokenCreateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - TokenCreateResponse.class, request, AUTH_TOKEN_CREATE_API_PATH)); + TokenCreateResponse.class, request, AUTH_TOKEN_CREATE_API_PATH) + .setOptions(options)); } @@ -466,11 +482,12 @@ public TokenCreateResponse tokenCreate(TokenCreateRequest request) throws Authle * Call /api/auth/token/delete/{token} API. */ @Override - public void tokenDelete(String token) throws AuthleteApiException + public void tokenDelete(String token, Options options) throws AuthleteApiException { executeApiCall( new ServiceDeleteApiCaller( - AUTH_TOKEN_DELETE_API_PATH, token)); + AUTH_TOKEN_DELETE_API_PATH, token) + .setOptions(options)); } @@ -478,11 +495,12 @@ public void tokenDelete(String token) throws AuthleteApiException * Call {@code /api/auth/token/fail} API. */ @Override - public TokenFailResponse tokenFail(TokenFailRequest request) throws AuthleteApiException + public TokenFailResponse tokenFail(TokenFailRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - TokenFailResponse.class, request, AUTH_TOKEN_FAIL_API_PATH)); + TokenFailResponse.class, request, AUTH_TOKEN_FAIL_API_PATH) + .setOptions(options)); } @@ -490,11 +508,12 @@ public TokenFailResponse tokenFail(TokenFailRequest request) throws AuthleteApiE * Call {@code /api/auth/token/issue} API. */ @Override - public TokenIssueResponse tokenIssue(TokenIssueRequest request) throws AuthleteApiException + public TokenIssueResponse tokenIssue(TokenIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - TokenIssueResponse.class, request, AUTH_TOKEN_ISSUE_API_PATH)); + TokenIssueResponse.class, request, AUTH_TOKEN_ISSUE_API_PATH) + .setOptions(options)); } @@ -502,11 +521,12 @@ public TokenIssueResponse tokenIssue(TokenIssueRequest request) throws AuthleteA * Call {@code /api/auth/token/revoke} API. */ @Override - public TokenRevokeResponse tokenRevoke(TokenRevokeRequest request) throws AuthleteApiException + public TokenRevokeResponse tokenRevoke(TokenRevokeRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - TokenRevokeResponse.class, request, AUTH_TOKEN_REVOKE_API_PATH)); + TokenRevokeResponse.class, request, AUTH_TOKEN_REVOKE_API_PATH) + .setOptions(options)); } @@ -514,87 +534,88 @@ public TokenRevokeResponse tokenRevoke(TokenRevokeRequest request) throws Authle * Call {@code /api/auth/token/update} API. */ @Override - public TokenUpdateResponse tokenUpdate(TokenUpdateRequest request) throws AuthleteApiException + public TokenUpdateResponse tokenUpdate(TokenUpdateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - TokenUpdateResponse.class, request, AUTH_TOKEN_UPDATE_API_PATH)); + TokenUpdateResponse.class, request, AUTH_TOKEN_UPDATE_API_PATH) + .setOptions(options)); } @Override - public TokenListResponse getTokenList() throws AuthleteApiException + public TokenListResponse getTokenList(Options options) throws AuthleteApiException { - return getTokenList(null, null, 0, 0, false, TokenStatus.ALL); + return getTokenList(null, null, 0, 0, false, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(null, null, 0, 0, false, tokenStatus); + return getTokenList(null, null, 0, 0, false, tokenStatus, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, 0, 0, false, TokenStatus.ALL); + return getTokenList(clientIdentifier, subject, 0, 0, false, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject, TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, 0, 0, false, tokenStatus); + return getTokenList(clientIdentifier, subject, 0, 0, false, tokenStatus, options); } @Override - public TokenListResponse getTokenList(int start, int end) throws AuthleteApiException + public TokenListResponse getTokenList(int start, int end, Options options) throws AuthleteApiException { - return getTokenList(null, null, start, end, true, TokenStatus.ALL); + return getTokenList(null, null, start, end, true, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(int start, int end, TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(int start, int end, TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(null, null, start, end, true, tokenStatus); + return getTokenList(null, null, start, end, true, tokenStatus, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, start, end, true, TokenStatus.ALL); + return getTokenList(clientIdentifier, subject, start, end, true, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end, TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end, TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, start, end, true, tokenStatus); + return getTokenList(clientIdentifier, subject, start, end, true, tokenStatus, options); } private TokenListResponse getTokenList( final String clientIdentifier, final String subject, - final int start, final int end, final boolean rangeGiven, TokenStatus tokenStatus) throws AuthleteApiException + final int start, final int end, final boolean rangeGiven, TokenStatus tokenStatus, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall() { @Override public TokenListResponse call() { - return callGetTokenList(clientIdentifier, subject, start, end, rangeGiven, tokenStatus); + return callGetTokenList(clientIdentifier, subject, start, end, rangeGiven, tokenStatus, options); } }); } private TokenListResponse callGetTokenList( - String clientIdentifier, String subject, int start, int end, boolean rangeGiven, TokenStatus tokenStatus) + String clientIdentifier, String subject, int start, int end, boolean rangeGiven, TokenStatus tokenStatus, Options options) { WebTarget target = getTarget().path(AUTH_TOKEN_GET_LIST_API_PATH); @@ -615,10 +636,13 @@ private TokenListResponse callGetTokenList( target = target.queryParam("tokenStatus", tokenStatus.toString()); - return wrapWithDpop(target + Builder builder = wrapWithDpop(target .request(APPLICATION_JSON_TYPE), AUTH_TOKEN_GET_LIST_API_PATH, "GET") - .header(AUTHORIZATION, mServiceAuth) - .get(TokenListResponse.class); + .header(AUTHORIZATION, mServiceAuth); + + setCustomRequestHeaders(builder, options); + + return builder.get(TokenListResponse.class); } @@ -626,11 +650,12 @@ private TokenListResponse callGetTokenList( * Call {@code /api/auth/revocation} API. */ @Override - public RevocationResponse revocation(RevocationRequest request) throws AuthleteApiException + public RevocationResponse revocation(RevocationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - RevocationResponse.class, request, AUTH_REVOCATION_API_PATH)); + RevocationResponse.class, request, AUTH_REVOCATION_API_PATH) + .setOptions(options)); } @@ -638,11 +663,12 @@ public RevocationResponse revocation(RevocationRequest request) throws AuthleteA * Call {@code /api/auth/userinfo} API. */ @Override - public UserInfoResponse userinfo(UserInfoRequest request) throws AuthleteApiException + public UserInfoResponse userinfo(UserInfoRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - UserInfoResponse.class, request, AUTH_USERINFO_API_PATH)); + UserInfoResponse.class, request, AUTH_USERINFO_API_PATH) + .setOptions(options)); } @@ -650,11 +676,12 @@ public UserInfoResponse userinfo(UserInfoRequest request) throws AuthleteApiExce * Call {@code /api/auth/userinfo/issue} API. */ @Override - public UserInfoIssueResponse userinfoIssue(UserInfoIssueRequest request) throws AuthleteApiException + public UserInfoIssueResponse userinfoIssue(UserInfoIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - UserInfoIssueResponse.class, request, AUTH_USERINFO_ISSUE_API_PATH)); + UserInfoIssueResponse.class, request, AUTH_USERINFO_ISSUE_API_PATH) + .setOptions(options)); } @@ -662,11 +689,12 @@ public UserInfoIssueResponse userinfoIssue(UserInfoIssueRequest request) throws * Call {@code /api/auth/introspection} API. */ @Override - public IntrospectionResponse introspection(IntrospectionRequest request) throws AuthleteApiException + public IntrospectionResponse introspection(IntrospectionRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - IntrospectionResponse.class, request, AUTH_INTROSPECTION_API_PATH)); + IntrospectionResponse.class, request, AUTH_INTROSPECTION_API_PATH) + .setOptions(options)); } @@ -675,11 +703,12 @@ public IntrospectionResponse introspection(IntrospectionRequest request) throws */ @Override public StandardIntrospectionResponse standardIntrospection( - StandardIntrospectionRequest request) throws AuthleteApiException + StandardIntrospectionRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - StandardIntrospectionResponse.class, request, AUTH_INTROSPECTION_STANDARD_API_PATH)); + StandardIntrospectionResponse.class, request, AUTH_INTROSPECTION_STANDARD_API_PATH) + .setOptions(options)); } @@ -687,11 +716,12 @@ public StandardIntrospectionResponse standardIntrospection( * Call {@code /api/service/create} API. */ @Override - public Service createService(Service service) throws AuthleteApiException + public Service createService(Service service, Options options) throws AuthleteApiException { return executeApiCall( new ServiceOwnerPostApiCaller( - Service.class, service, SERVICE_CREATE_API_PATH)); + Service.class, service, SERVICE_CREATE_API_PATH) + .setOptions(options)); } @@ -710,11 +740,12 @@ public Service createServie(Service service) throws AuthleteApiException * Call /api/service/delete/{serviceApiKey} API. */ @Override - public void deleteService(long apiKey) throws AuthleteApiException + public void deleteService(long apiKey, Options options) throws AuthleteApiException { executeApiCall( new ServiceOwnerDeleteApiCaller( - SERVICE_DELETE_API_PATH, apiKey)); + SERVICE_DELETE_API_PATH, apiKey) + .setOptions(options)); } @@ -722,11 +753,12 @@ public void deleteService(long apiKey) throws AuthleteApiException * Call /api/service/get/{serviceApiKey} API. */ @Override - public Service getService(long apiKey) throws AuthleteApiException + public Service getService(long apiKey, Options options) throws AuthleteApiException { return executeApiCall( new ServiceOwnerGetApiCaller( - Service.class, SERVICE_GET_API_PATH, apiKey)); + Service.class, SERVICE_GET_API_PATH, apiKey) + .setOptions(options)); } @@ -734,28 +766,28 @@ public Service getService(long apiKey) throws AuthleteApiException * Call {@code /api/service/get/list} API. */ @Override - public ServiceListResponse getServiceList() throws AuthleteApiException + public ServiceListResponse getServiceList(Options options) throws AuthleteApiException { - return getServiceList(0, 0, false); + return getServiceList(0, 0, false, options); } @Override - public ServiceListResponse getServiceList(int start, int end) throws AuthleteApiException + public ServiceListResponse getServiceList(int start, int end, Options options) throws AuthleteApiException { - return getServiceList(start, end, true); + return getServiceList(start, end, true, options); } private ServiceListResponse getServiceList( - final int start, final int end, final boolean rangeGiven) throws AuthleteApiException + final int start, final int end, final boolean rangeGiven, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall() { @Override public ServiceListResponse call() { - return callGetServiceList(start, end, rangeGiven); + return callGetServiceList(start, end, rangeGiven, options); } }); } @@ -764,7 +796,7 @@ public ServiceListResponse call() /** * Call /service/get/list. */ - private ServiceListResponse callGetServiceList(int start, int end, boolean rangeGiven) + private ServiceListResponse callGetServiceList(int start, int end, boolean rangeGiven, Options options) { WebTarget target = getTarget().path(SERVICE_GET_LIST_API_PATH); @@ -773,10 +805,13 @@ private ServiceListResponse callGetServiceList(int start, int end, boolean range target = target.queryParam("start", start).queryParam("end", end); } - return wrapWithDpop(target + Builder builder = wrapWithDpop(target .request(APPLICATION_JSON_TYPE), SERVICE_GET_LIST_API_PATH, "GET") - .header(AUTHORIZATION, mServiceOwnerAuth) - .get(ServiceListResponse.class); + .header(AUTHORIZATION, mServiceOwnerAuth); + + setCustomRequestHeaders(builder, options); + + return builder.get(ServiceListResponse.class); } @@ -784,11 +819,12 @@ private ServiceListResponse callGetServiceList(int start, int end, boolean range * Call /api/service/update/{serviceApiKey} API. */ @Override - public Service updateService(final Service service) throws AuthleteApiException + public Service updateService(final Service service, Options options) throws AuthleteApiException { return executeApiCall( new ServiceOwnerPostApiCaller( - Service.class, service, SERVICE_UPDATE_API_PATH, service.getApiKey())); + Service.class, service, SERVICE_UPDATE_API_PATH, service.getApiKey()) + .setOptions(options)); } @@ -796,11 +832,12 @@ public Service updateService(final Service service) throws AuthleteApiException * Call {@code /api/service/jwks/get} API */ @Override - public String getServiceJwks() throws AuthleteApiException + public String getServiceJwks(Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( - String.class, SERVICE_JWKS_GET_API_PATH)); + String.class, SERVICE_JWKS_GET_API_PATH) + .setOptions(options)); } @@ -808,13 +845,14 @@ public String getServiceJwks() throws AuthleteApiException * Call {@code /api/service/jwks/get} API */ @Override - public String getServiceJwks(boolean pretty, boolean includePrivateKeys) throws AuthleteApiException + public String getServiceJwks(boolean pretty, boolean includePrivateKeys, Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( String.class, SERVICE_JWKS_GET_API_PATH) .addParam("pretty", pretty) - .addParam("includePrivateKeys", includePrivateKeys)); + .addParam("includePrivateKeys", includePrivateKeys) + .setOptions(options)); } @@ -822,11 +860,12 @@ public String getServiceJwks(boolean pretty, boolean includePrivateKeys) throws * Call {@code /api/service/configuration} API */ @Override - public String getServiceConfiguration() throws AuthleteApiException + public String getServiceConfiguration(Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( - String.class, SERVICE_CONFIGURATION_API_PATH)); + String.class, SERVICE_CONFIGURATION_API_PATH) + .setOptions(options)); } @@ -834,12 +873,13 @@ public String getServiceConfiguration() throws AuthleteApiException * Call {@code /api/service/configuration} API */ @Override - public String getServiceConfiguration(boolean pretty) throws AuthleteApiException + public String getServiceConfiguration(boolean pretty, Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( String.class, SERVICE_CONFIGURATION_API_PATH) - .addParam("pretty", pretty)); + .addParam("pretty", pretty) + .setOptions(options)); } @@ -847,11 +887,12 @@ public String getServiceConfiguration(boolean pretty) throws AuthleteApiExceptio * Call {@code /api/service/configuration} API */ @Override - public String getServiceConfiguration(ServiceConfigurationRequest request) throws AuthleteApiException + public String getServiceConfiguration(ServiceConfigurationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - String.class, request, SERVICE_CONFIGURATION_API_PATH)); + String.class, request, SERVICE_CONFIGURATION_API_PATH) + .setOptions(options)); } @@ -859,11 +900,12 @@ public String getServiceConfiguration(ServiceConfigurationRequest request) throw * Call {@code /api/client/create} API. */ @Override - public Client createClient(Client client) throws AuthleteApiException + public Client createClient(Client client, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - Client.class, client, CLIENT_CREATE_API_PATH)); + Client.class, client, CLIENT_CREATE_API_PATH) + .setOptions(options)); } @@ -871,11 +913,12 @@ public Client createClient(Client client) throws AuthleteApiException * Call {@code /api/client/registration} API. */ @Override - public ClientRegistrationResponse dynamicClientRegister(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientRegister(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_API_PATH)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_API_PATH) + .setOptions(options)); } @@ -883,11 +926,12 @@ public ClientRegistrationResponse dynamicClientRegister(ClientRegistrationReques * Call {@code /api/client/registration/get} API. */ @Override - public ClientRegistrationResponse dynamicClientGet(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientGet(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_GET_API_PATH)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_GET_API_PATH) + .setOptions(options)); } @@ -895,11 +939,12 @@ public ClientRegistrationResponse dynamicClientGet(ClientRegistrationRequest req * Call {@code /api/client/registration/update} API. */ @Override - public ClientRegistrationResponse dynamicClientUpdate(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientUpdate(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_UPDATE_API_PATH)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_UPDATE_API_PATH) + .setOptions(options)); } @@ -907,11 +952,12 @@ public ClientRegistrationResponse dynamicClientUpdate(ClientRegistrationRequest * Call {@code /api/client/registration/delete} API. */ @Override - public ClientRegistrationResponse dynamicClientDelete(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientDelete(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_DELETE_API_PATH)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_DELETE_API_PATH) + .setOptions(options)); } @@ -919,9 +965,9 @@ public ClientRegistrationResponse dynamicClientDelete(ClientRegistrationRequest * Call /api/client/delete/{clientId} API. */ @Override - public void deleteClient(long clientId) throws AuthleteApiException + public void deleteClient(long clientId, Options options) throws AuthleteApiException { - deleteClient(String.valueOf(clientId)); + deleteClient(String.valueOf(clientId), options); } @@ -929,11 +975,12 @@ public void deleteClient(long clientId) throws AuthleteApiException * Call /api/client/delete/{clientId} API. */ @Override - public void deleteClient(String clientId) throws AuthleteApiException + public void deleteClient(String clientId, Options options) throws AuthleteApiException { executeApiCall( new ServiceDeleteApiCaller( - CLIENT_DELETE_API_PATH, clientId)); + CLIENT_DELETE_API_PATH, clientId) + .setOptions(options)); } @@ -941,9 +988,9 @@ public void deleteClient(String clientId) throws AuthleteApiException * Call /api/client/get/{clientId} API. */ @Override - public Client getClient(long clientId) throws AuthleteApiException + public Client getClient(long clientId, Options options) throws AuthleteApiException { - return getClient(String.valueOf(clientId)); + return getClient(String.valueOf(clientId), options); } @@ -951,11 +998,12 @@ public Client getClient(long clientId) throws AuthleteApiException * Call /api/client/get/{clientId} API. */ @Override - public Client getClient(String clientId) throws AuthleteApiException + public Client getClient(String clientId, Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( - Client.class, CLIENT_GET_API_PATH, clientId)); + Client.class, CLIENT_GET_API_PATH, clientId) + .setOptions(options)); } @@ -963,48 +1011,48 @@ public Client getClient(String clientId) throws AuthleteApiException * Call {@code /api/client/get/list} API. */ @Override - public ClientListResponse getClientList() throws AuthleteApiException + public ClientListResponse getClientList(Options options) throws AuthleteApiException { - return getClientList(null, 0, 0, false); + return getClientList(null, 0, 0, false, options); } @Override - public ClientListResponse getClientList(String developer) throws AuthleteApiException + public ClientListResponse getClientList(String developer, Options options) throws AuthleteApiException { - return getClientList(developer, 0, 0, false); + return getClientList(developer, 0, 0, false, options); } @Override - public ClientListResponse getClientList(int start, int end) throws AuthleteApiException + public ClientListResponse getClientList(int start, int end, Options options) throws AuthleteApiException { - return getClientList(null, start, end, true); + return getClientList(null, start, end, true, options); } @Override - public ClientListResponse getClientList(String developer, int start, int end) throws AuthleteApiException + public ClientListResponse getClientList(String developer, int start, int end, Options options) throws AuthleteApiException { - return getClientList(developer, start, end, true); + return getClientList(developer, start, end, true, options); } private ClientListResponse getClientList( - final String developer, final int start, final int end, final boolean rangeGiven) throws AuthleteApiException + final String developer, final int start, final int end, final boolean rangeGiven, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall() { @Override public ClientListResponse call() { - return callGetClientList(developer, start, end, rangeGiven); + return callGetClientList(developer, start, end, rangeGiven, options); } }); } - private ClientListResponse callGetClientList(String developer, int start, int end, boolean rangeGiven) + private ClientListResponse callGetClientList(String developer, int start, int end, boolean rangeGiven, Options options) { WebTarget target = getTarget().path(CLIENT_GET_LIST_API_PATH); @@ -1018,10 +1066,13 @@ private ClientListResponse callGetClientList(String developer, int start, int en target = target.queryParam("start", start).queryParam("end", end); } - return wrapWithDpop(target + Builder builder = wrapWithDpop(target .request(APPLICATION_JSON_TYPE), CLIENT_GET_LIST_API_PATH, "GET") - .header(AUTHORIZATION, mServiceAuth) - .get(ClientListResponse.class); + .header(AUTHORIZATION, mServiceAuth); + + setCustomRequestHeaders(builder, options); + + return builder.get(ClientListResponse.class); } @@ -1029,11 +1080,12 @@ private ClientListResponse callGetClientList(String developer, int start, int en * Call /api/client/update/{clientId} API. */ @Override - public Client updateClient(Client client) throws AuthleteApiException + public Client updateClient(Client client, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - Client.class, client, CLIENT_UPDATE_API_PATH, client.getClientId())); + Client.class, client, CLIENT_UPDATE_API_PATH, client.getClientId()) + .setOptions(options)); } @@ -1042,12 +1094,13 @@ public Client updateClient(Client client) throws AuthleteApiException * Call /api/client/extension/requestable_scopes/get/{clientId} API. */ @Override - public String[] getRequestableScopes(long clientId) throws AuthleteApiException + public String[] getRequestableScopes(long clientId, Options options) throws AuthleteApiException { // Call the API. RequestableScopes response = executeApiCall( new ServiceGetApiCaller( - RequestableScopes.class, REQUESTABLE_SCOPES_GET_API_PATH, clientId)); + RequestableScopes.class, REQUESTABLE_SCOPES_GET_API_PATH, clientId) + .setOptions(options)); if (response != null) { @@ -1062,7 +1115,7 @@ public String[] getRequestableScopes(long clientId) throws AuthleteApiException @Override - public String[] setRequestableScopes(long clientId, String[] scopes) throws AuthleteApiException + public String[] setRequestableScopes(long clientId, String[] scopes, Options options) throws AuthleteApiException { // Prepare a request body. RequestableScopes request = new RequestableScopes().setRequestableScopes(scopes); @@ -1088,16 +1141,17 @@ public String[] setRequestableScopes(long clientId, String[] scopes) throws Auth * Call /api/client/extension/requestable_scopes/delete/{clientId} API. */ @Override - public void deleteRequestableScopes(long clientId) throws AuthleteApiException + public void deleteRequestableScopes(long clientId, Options options) throws AuthleteApiException { executeApiCall( new ServiceDeleteApiCaller( - REQUESTABLE_SCOPES_DELETE_API_PATH, clientId)); + REQUESTABLE_SCOPES_DELETE_API_PATH, clientId) + .setOptions(options)); } @Override - public GrantedScopesGetResponse getGrantedScopes(long clientId, String subject) + public GrantedScopesGetResponse getGrantedScopes(long clientId, String subject, Options options) { // Prepare a request body. GrantedScopesRequest request = new GrantedScopesRequest(subject); @@ -1105,19 +1159,21 @@ public GrantedScopesGetResponse getGrantedScopes(long clientId, String subject) // Call the API. return executeApiCall( new ServicePostApiCaller( - GrantedScopesGetResponse.class, request, GRANTED_SCOPES_GET_API_PATH, clientId)); + GrantedScopesGetResponse.class, request, GRANTED_SCOPES_GET_API_PATH, clientId) + .setOptions(options)); } @Override - public void deleteGrantedScopes(long clientId, String subject) + public void deleteGrantedScopes(long clientId, String subject, Options options) { // Prepare a request body. GrantedScopesRequest request = new GrantedScopesRequest(subject); executeApiCall( new ServicePostApiCaller( - ApiResponse.class, request, GRANTED_SCOPES_DELETE_API_PATH, clientId)); + ApiResponse.class, request, GRANTED_SCOPES_DELETE_API_PATH, clientId) + .setOptions(options)); } @@ -1148,61 +1204,69 @@ public void setSubject(String subject) @Override - public void deleteClientAuthorization(long clientId, String subject) throws AuthleteApiException + public void deleteClientAuthorization(long clientId, String subject, Options options) throws AuthleteApiException { // Prepare a request body. ClientAuthorizationDeleteRequest request = new ClientAuthorizationDeleteRequest(subject); executeApiCall( new ServicePostApiCaller( - ApiResponse.class, request, CLIENT_AUTHORIZATION_DELETE_API_PATH, clientId)); + ApiResponse.class, request, CLIENT_AUTHORIZATION_DELETE_API_PATH, clientId) + .setOptions(options)); } @Override - public AuthorizedClientListResponse getClientAuthorizationList(ClientAuthorizationGetListRequest request) throws AuthleteApiException + public AuthorizedClientListResponse getClientAuthorizationList( + ClientAuthorizationGetListRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - AuthorizedClientListResponse.class, request, CLIENT_AUTHORIZATION_GET_LIST_API_PATH)); + AuthorizedClientListResponse.class, request, CLIENT_AUTHORIZATION_GET_LIST_API_PATH) + .setOptions(options)); } @Override - public void updateClientAuthorization(long clientId, ClientAuthorizationUpdateRequest request) throws AuthleteApiException + public void updateClientAuthorization( + long clientId, ClientAuthorizationUpdateRequest request, Options options) throws AuthleteApiException { executeApiCall( new ServicePostApiCaller( - ApiResponse.class, request, CLIENT_AUTHORIZATION_UPDATE_API_PATH, clientId)); + ApiResponse.class, request, CLIENT_AUTHORIZATION_UPDATE_API_PATH, clientId) + .setOptions(options)); } @Override - public ClientSecretRefreshResponse refreshClientSecret(long clientId) throws AuthleteApiException + public ClientSecretRefreshResponse refreshClientSecret(long clientId, Options options) throws AuthleteApiException { - return refreshClientSecret(String.valueOf(clientId)); + return refreshClientSecret(String.valueOf(clientId), options); } @Override - public ClientSecretRefreshResponse refreshClientSecret(String clientIdentifier) throws AuthleteApiException + public ClientSecretRefreshResponse refreshClientSecret(String clientIdentifier, Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( ClientSecretRefreshResponse.class, - CLIENT_SECRET_REFRESH_API_PATH, clientIdentifier)); + CLIENT_SECRET_REFRESH_API_PATH, clientIdentifier) + .setOptions(options)); } @Override - public ClientSecretUpdateResponse updateClientSecret(long clientId, String clientSecret) throws AuthleteApiException + public ClientSecretUpdateResponse updateClientSecret( + long clientId, String clientSecret, Options options) throws AuthleteApiException { - return updateClientSecret(String.valueOf(clientId), clientSecret); + return updateClientSecret(String.valueOf(clientId), clientSecret, options); } @Override - public ClientSecretUpdateResponse updateClientSecret(String clientIdentifier, String clientSecret) throws AuthleteApiException + public ClientSecretUpdateResponse updateClientSecret( + String clientIdentifier, String clientSecret, Options options) throws AuthleteApiException { // Prepare a request body. setClientSecret(String) method // throws IllegalArgumentException if the given client secret @@ -1213,7 +1277,8 @@ public ClientSecretUpdateResponse updateClientSecret(String clientIdentifier, St return executeApiCall( new ServicePostApiCaller( ClientSecretUpdateResponse.class, request, - CLIENT_SECRET_UPDATE_API_PATH, clientIdentifier)); + CLIENT_SECRET_UPDATE_API_PATH, clientIdentifier) + .setOptions(options)); } @@ -1221,11 +1286,12 @@ public ClientSecretUpdateResponse updateClientSecret(String clientIdentifier, St * Call {@code /api/jose/verify} API. */ @Override - public JoseVerifyResponse verifyJose(JoseVerifyRequest request) throws AuthleteApiException + public JoseVerifyResponse verifyJose(JoseVerifyRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - JoseVerifyResponse.class, request, JOSE_VERIFY_API_PATH)); + JoseVerifyResponse.class, request, JOSE_VERIFY_API_PATH) + .setOptions(options)); } @@ -1233,11 +1299,13 @@ public JoseVerifyResponse verifyJose(JoseVerifyRequest request) throws AuthleteA * Call {@code /api/backchannel/authentication} API. */ @Override - public BackchannelAuthenticationResponse backchannelAuthentication(BackchannelAuthenticationRequest request) throws AuthleteApiException + public BackchannelAuthenticationResponse backchannelAuthentication( + BackchannelAuthenticationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - BackchannelAuthenticationResponse.class, request, BACKCHANNEL_AUTHENTICATION_API_PATH)); + BackchannelAuthenticationResponse.class, request, BACKCHANNEL_AUTHENTICATION_API_PATH) + .setOptions(options)); } @@ -1245,11 +1313,13 @@ public BackchannelAuthenticationResponse backchannelAuthentication(BackchannelAu * Call {@code /api/backchannel/authentication/issue} API. */ @Override - public BackchannelAuthenticationIssueResponse backchannelAuthenticationIssue(BackchannelAuthenticationIssueRequest request) throws AuthleteApiException + public BackchannelAuthenticationIssueResponse backchannelAuthenticationIssue( + BackchannelAuthenticationIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - BackchannelAuthenticationIssueResponse.class, request, BACKCHANNEL_AUTHENTICATION_ISSUE_API_PATH)); + BackchannelAuthenticationIssueResponse.class, request, BACKCHANNEL_AUTHENTICATION_ISSUE_API_PATH) + .setOptions(options)); } @@ -1257,11 +1327,13 @@ public BackchannelAuthenticationIssueResponse backchannelAuthenticationIssue(Bac * Call {@code /api/backchannel/authentication/fail} API. */ @Override - public BackchannelAuthenticationFailResponse backchannelAuthenticationFail(BackchannelAuthenticationFailRequest request) throws AuthleteApiException + public BackchannelAuthenticationFailResponse backchannelAuthenticationFail( + BackchannelAuthenticationFailRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - BackchannelAuthenticationFailResponse.class, request, BACKCHANNEL_AUTHENTICATION_FAIL_API_PATH)); + BackchannelAuthenticationFailResponse.class, request, BACKCHANNEL_AUTHENTICATION_FAIL_API_PATH) + .setOptions(options)); } @@ -1269,11 +1341,13 @@ public BackchannelAuthenticationFailResponse backchannelAuthenticationFail(Backc * Call {@code /api/backchannel/authentication/complete} API. */ @Override - public BackchannelAuthenticationCompleteResponse backchannelAuthenticationComplete(BackchannelAuthenticationCompleteRequest request) throws AuthleteApiException + public BackchannelAuthenticationCompleteResponse backchannelAuthenticationComplete( + BackchannelAuthenticationCompleteRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - BackchannelAuthenticationCompleteResponse.class, request, BACKCHANNEL_AUTHENTICATION_COMPLETE_API_PATH)); + BackchannelAuthenticationCompleteResponse.class, request, BACKCHANNEL_AUTHENTICATION_COMPLETE_API_PATH) + .setOptions(options)); } @@ -1281,11 +1355,13 @@ public BackchannelAuthenticationCompleteResponse backchannelAuthenticationComple * Call {@code /api/device/authorization} API. */ @Override - public DeviceAuthorizationResponse deviceAuthorization(DeviceAuthorizationRequest request) throws AuthleteApiException + public DeviceAuthorizationResponse deviceAuthorization( + DeviceAuthorizationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - DeviceAuthorizationResponse.class, request, DEVICE_AUTHORIZATION_API_PATH)); + DeviceAuthorizationResponse.class, request, DEVICE_AUTHORIZATION_API_PATH) + .setOptions(options)); } @@ -1293,11 +1369,13 @@ public DeviceAuthorizationResponse deviceAuthorization(DeviceAuthorizationReques * Call {@code /api/device/complete} API. */ @Override - public DeviceCompleteResponse deviceComplete(DeviceCompleteRequest request) throws AuthleteApiException + public DeviceCompleteResponse deviceComplete( + DeviceCompleteRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - DeviceCompleteResponse.class, request, DEVICE_COMPLETE_API_PATH)); + DeviceCompleteResponse.class, request, DEVICE_COMPLETE_API_PATH) + .setOptions(options)); } @@ -1305,77 +1383,85 @@ public DeviceCompleteResponse deviceComplete(DeviceCompleteRequest request) thro * Call {@code /api/device/verification} API. */ @Override - public DeviceVerificationResponse deviceVerification(DeviceVerificationRequest request) throws AuthleteApiException + public DeviceVerificationResponse deviceVerification( + DeviceVerificationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - DeviceVerificationResponse.class, request, DEVICE_VERIFICATION_API_PATH)); + DeviceVerificationResponse.class, request, DEVICE_VERIFICATION_API_PATH) + .setOptions(options)); } @Override - public PushedAuthReqResponse pushAuthorizationRequest(PushedAuthReqRequest request) throws AuthleteApiException + public PushedAuthReqResponse pushAuthorizationRequest( + PushedAuthReqRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - PushedAuthReqResponse.class, request, PUSHED_AUTH_REQ_API_PATH)); + PushedAuthReqResponse.class, request, PUSHED_AUTH_REQ_API_PATH) + .setOptions(options)); } @Override - public HskResponse hskCreate(HskCreateRequest request) throws AuthleteApiException + public HskResponse hskCreate(HskCreateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - HskResponse.class, request, HSK_CREATE_API_PATH)); + HskResponse.class, request, HSK_CREATE_API_PATH) + .setOptions(options)); } @Override - public HskResponse hskDelete(String handle) throws AuthleteApiException + public HskResponse hskDelete(String handle, Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( HskResponse.class, - HSK_DELETE_API_PATH, handle)); + HSK_DELETE_API_PATH, handle) + .setOptions(options)); } @Override - public HskResponse hskGet(String handle) throws AuthleteApiException + public HskResponse hskGet(String handle, Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( HskResponse.class, - HSK_GET_API_PATH, handle)); + HSK_GET_API_PATH, handle) + .setOptions(options)); } @Override - public HskListResponse hskGetList() throws AuthleteApiException + public HskListResponse hskGetList(Options options) throws AuthleteApiException { return executeApiCall( new ServiceGetApiCaller( HskListResponse.class, - HSK_GET_LIST_API_PATH)); + HSK_GET_LIST_API_PATH) + .setOptions(options)); } @Override - public Map echo(Map parameters) throws AuthleteApiException + public Map echo(Map parameters, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall>() { @Override public Map call() { - return callEcho(parameters); + return callEcho(parameters, options); } }); } - private Map callEcho(Map parameters) + private Map callEcho(Map parameters, Options options) { WebTarget target = getTarget().path(ECHO_API_PATH); @@ -1390,24 +1476,27 @@ private Map callEcho(Map parameters) // The API does not require any authentication, so the code below // does not include '.header(AUTHORIZATION, ...)'. - return target - .request(APPLICATION_JSON_TYPE) - .get(new GenericType>(){}); + Builder builder = target.request(APPLICATION_JSON_TYPE); + + setCustomRequestHeaders(builder, options); + + return builder.get(new GenericType>(){}); } @Override - public GMResponse gm(GMRequest request) throws AuthleteApiException + public GMResponse gm(GMRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( - GMResponse.class, request, GM_API_PATH)); + GMResponse.class, request, GM_API_PATH) + .setOptions(options)); } @Override public void updateClientLockFlag( - String clientIdentifier, boolean clientLocked) throws AuthleteApiException + String clientIdentifier, boolean clientLocked, Options options) throws AuthleteApiException { // Prepare a request body. ClientLockFlagUpdateRequest request = @@ -1416,35 +1505,38 @@ public void updateClientLockFlag( executeApiCall( new ServicePostApiCaller( ApiResponse.class, request, - CLIENT_LOCK_FLAG_UPDATE_API_PATH, clientIdentifier)); + CLIENT_LOCK_FLAG_UPDATE_API_PATH, clientIdentifier) + .setOptions(options)); } @Override public FederationConfigurationResponse federationConfiguration( - FederationConfigurationRequest request) throws AuthleteApiException + FederationConfigurationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( FederationConfigurationResponse.class, request, - FEDERATION_CONFIGURATION_API_PATH)); + FEDERATION_CONFIGURATION_API_PATH) + .setOptions(options)); } @Override public FederationRegistrationResponse federationRegistration( - FederationRegistrationRequest request) throws AuthleteApiException + FederationRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( FederationRegistrationResponse.class, request, - FEDERATION_REGISTRATION_API_PATH)); + FEDERATION_REGISTRATION_API_PATH) + .setOptions(options)); } @Override public CredentialIssuerMetadataResponse credentialIssuerMetadata( - CredentialIssuerMetadataRequest request) throws AuthleteApiException + CredentialIssuerMetadataRequest request, Options options) throws AuthleteApiException { // Note that the /vci/metadata API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1452,13 +1544,14 @@ public CredentialIssuerMetadataResponse credentialIssuerMetadata( return executeApiCall( new ServicePostApiCaller( CredentialIssuerMetadataResponse.class, request, - VCI_METADATA_API_PATH)); + VCI_METADATA_API_PATH) + .setOptions(options)); } @Override public CredentialJwtIssuerMetadataResponse credentialJwtIssuerMetadata( - CredentialJwtIssuerMetadataRequest request) throws AuthleteApiException + CredentialJwtIssuerMetadataRequest request, Options options) throws AuthleteApiException { // Note that the /vci/jwtissuer API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1466,13 +1559,14 @@ public CredentialJwtIssuerMetadataResponse credentialJwtIssuerMetadata( return executeApiCall( new ServicePostApiCaller( CredentialJwtIssuerMetadataResponse.class, request, - VCI_JWT_ISSUER_API_PATH)); + VCI_JWT_ISSUER_API_PATH) + .setOptions(options)); } @Override public CredentialIssuerJwksResponse credentialIssuerJwks( - CredentialIssuerJwksRequest request) throws AuthleteApiException + CredentialIssuerJwksRequest request, Options options) throws AuthleteApiException { // Note that the /vci/jwks API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1480,13 +1574,14 @@ public CredentialIssuerJwksResponse credentialIssuerJwks( return executeApiCall( new ServicePostApiCaller( CredentialIssuerJwksResponse.class, request, - VCI_JWKS_API_PATH)); + VCI_JWKS_API_PATH) + .setOptions(options)); } @Override public CredentialOfferCreateResponse credentialOfferCreate( - CredentialOfferCreateRequest request) throws AuthleteApiException + CredentialOfferCreateRequest request, Options options) throws AuthleteApiException { // Note that the /vci/offer/create API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1494,13 +1589,14 @@ public CredentialOfferCreateResponse credentialOfferCreate( return executeApiCall( new ServicePostApiCaller( CredentialOfferCreateResponse.class, request, - VCI_OFFER_CREATE_API_PATH)); + VCI_OFFER_CREATE_API_PATH) + .setOptions(options)); } @Override public CredentialOfferInfoResponse credentialOfferInfo( - CredentialOfferInfoRequest request) throws AuthleteApiException + CredentialOfferInfoRequest request, Options options) throws AuthleteApiException { // Note that the /vci/offer/info API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1508,13 +1604,14 @@ public CredentialOfferInfoResponse credentialOfferInfo( return executeApiCall( new ServicePostApiCaller( CredentialOfferInfoResponse.class, request, - VCI_OFFER_INFO_API_PATH)); + VCI_OFFER_INFO_API_PATH) + .setOptions(options)); } @Override public CredentialSingleParseResponse credentialSingleParse( - CredentialSingleParseRequest request) throws AuthleteApiException + CredentialSingleParseRequest request, Options options) throws AuthleteApiException { // Note that the /vci/single/parse API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1522,13 +1619,14 @@ public CredentialSingleParseResponse credentialSingleParse( return executeApiCall( new ServicePostApiCaller( CredentialSingleParseResponse.class, request, - VCI_SINGLE_PARSE_API_PATH)); + VCI_SINGLE_PARSE_API_PATH) + .setOptions(options)); } @Override public CredentialSingleIssueResponse credentialSingleIssue( - CredentialSingleIssueRequest request) throws AuthleteApiException + CredentialSingleIssueRequest request, Options options) throws AuthleteApiException { // Note that the /vci/single/issue API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1536,13 +1634,14 @@ public CredentialSingleIssueResponse credentialSingleIssue( return executeApiCall( new ServicePostApiCaller( CredentialSingleIssueResponse.class, request, - VCI_SINGLE_ISSUE_API_PATH)); + VCI_SINGLE_ISSUE_API_PATH) + .setOptions(options)); } @Override public CredentialBatchParseResponse credentialBatchParse( - CredentialBatchParseRequest request) throws AuthleteApiException + CredentialBatchParseRequest request, Options options) throws AuthleteApiException { // Note that the /vci/batch/parse API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1550,13 +1649,14 @@ public CredentialBatchParseResponse credentialBatchParse( return executeApiCall( new ServicePostApiCaller( CredentialBatchParseResponse.class, request, - VCI_BATCH_PARSE_API_PATH)); + VCI_BATCH_PARSE_API_PATH) + .setOptions(options)); } @Override public CredentialBatchIssueResponse credentialBatchIssue( - CredentialBatchIssueRequest request) throws AuthleteApiException + CredentialBatchIssueRequest request, Options options) throws AuthleteApiException { // Note that the /vci/batch/issue API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1564,13 +1664,14 @@ public CredentialBatchIssueResponse credentialBatchIssue( return executeApiCall( new ServicePostApiCaller( CredentialBatchIssueResponse.class, request, - VCI_BATCH_ISSUE_API_PATH)); + VCI_BATCH_ISSUE_API_PATH) + .setOptions(options)); } @Override public CredentialDeferredParseResponse credentialDeferredParse( - CredentialDeferredParseRequest request) throws AuthleteApiException + CredentialDeferredParseRequest request, Options options) throws AuthleteApiException { // Note that the /vci/deferred/parse API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1578,13 +1679,14 @@ public CredentialDeferredParseResponse credentialDeferredParse( return executeApiCall( new ServicePostApiCaller( CredentialDeferredParseResponse.class, request, - VCI_DEFERRED_PARSE_API_PATH)); + VCI_DEFERRED_PARSE_API_PATH) + .setOptions(options)); } @Override public CredentialDeferredIssueResponse credentialDeferredIssue( - CredentialDeferredIssueRequest request) throws AuthleteApiException + CredentialDeferredIssueRequest request, Options options) throws AuthleteApiException { // Note that the /vci/deferred/issue API is not available in Authlete 2.x, // so the executeApiCall below will throw an exception. @@ -1592,24 +1694,26 @@ public CredentialDeferredIssueResponse credentialDeferredIssue( return executeApiCall( new ServicePostApiCaller( CredentialDeferredIssueResponse.class, request, - VCI_DEFERRED_ISSUE_API_PATH)); + VCI_DEFERRED_ISSUE_API_PATH) + .setOptions(options)); } @Override public IDTokenReissueResponse idTokenReissue( - IDTokenReissueRequest request) throws AuthleteApiException + IDTokenReissueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new ServicePostApiCaller( IDTokenReissueResponse.class, request, - ID_TOKEN_REISSUE_API_PATH)); + ID_TOKEN_REISSUE_API_PATH) + .setOptions(options)); } @Override public AuthorizationTicketInfoResponse authorizationTicketInfo( - AuthorizationTicketInfoRequest request) throws AuthleteApiException + AuthorizationTicketInfoRequest request, Options options) throws AuthleteApiException { // Note that the /auth/authorization/ticket/info API is not available // in Authlete 2.x, so the executeApiCall below will throw an exception. @@ -1617,13 +1721,14 @@ public AuthorizationTicketInfoResponse authorizationTicketInfo( return executeApiCall( new ServicePostApiCaller( AuthorizationTicketInfoResponse.class, request, - AUTH_AUTHORIZATION_TICKET_INFO_API_PATH)); + AUTH_AUTHORIZATION_TICKET_INFO_API_PATH) + .setOptions(options)); } @Override public AuthorizationTicketUpdateResponse authorizationTicketUpdate( - AuthorizationTicketUpdateRequest request) throws AuthleteApiException + AuthorizationTicketUpdateRequest request, Options options) throws AuthleteApiException { // Note that the /auth/authorization/ticket/update API is not available // in Authlete 2.x, so the executeApiCall below will throw an exception. @@ -1631,13 +1736,14 @@ public AuthorizationTicketUpdateResponse authorizationTicketUpdate( return executeApiCall( new ServicePostApiCaller( AuthorizationTicketUpdateResponse.class, request, - AUTH_AUTHORIZATION_TICKET_UPDATE_API_PATH)); + AUTH_AUTHORIZATION_TICKET_UPDATE_API_PATH) + .setOptions(options)); } @Override public TokenCreateBatchResponse tokenCreateBatch( - TokenCreateRequest[] tokenCreateRequests, boolean dryRun) throws AuthleteApiException + TokenCreateRequest[] tokenCreateRequests, boolean dryRun, Options options) throws AuthleteApiException { throw new AuthleteApiException( "This method can't be invoked since the corresponding API is not supported."); @@ -1646,7 +1752,7 @@ public TokenCreateBatchResponse tokenCreateBatch( @Override public TokenCreateBatchStatusResponse getTokenCreateBatchStatus( - String requestId) throws AuthleteApiException + String requestId, Options options) throws AuthleteApiException { throw new AuthleteApiException( "This method can't be invoked since the corresponding API is not supported."); diff --git a/src/main/java/com/authlete/jakarta/api/AuthleteApiImplV3.java b/src/main/java/com/authlete/jakarta/api/AuthleteApiImplV3.java index 0972cce..8b52a93 100644 --- a/src/main/java/com/authlete/jakarta/api/AuthleteApiImplV3.java +++ b/src/main/java/com/authlete/jakarta/api/AuthleteApiImplV3.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2014-2023 Authlete, Inc. + * Copyright (C) 2014-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,10 +21,12 @@ import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON_TYPE; import java.util.LinkedHashMap; import java.util.Map; +import jakarta.ws.rs.client.Invocation.Builder; import jakarta.ws.rs.client.WebTarget; import jakarta.ws.rs.core.GenericType; import com.authlete.common.api.AuthleteApi; import com.authlete.common.api.AuthleteApiException; +import com.authlete.common.api.Options; import com.authlete.common.conf.AuthleteApiVersion; import com.authlete.common.conf.AuthleteConfiguration; import com.authlete.common.dto.*; @@ -181,21 +183,21 @@ private String createCredentials(AuthleteConfiguration configuration) private TResponse callGetApi( - String path, Class responseClass, Map params) + String path, Class responseClass, Map params, Options options) { - return callGetApi(mAuth, path, responseClass, params); + return callGetApi(mAuth, path, responseClass, params, options); } - private Void callDeleteApi(String path) + private Void callDeleteApi(String path, Options options) { - return callDeleteApi(mAuth, path); + return callDeleteApi(mAuth, path, options); } - private TResponse callPostApi(String path, Object request, Class responseClass) + private TResponse callPostApi(String path, Object request, Class responseClass, Options options) { - return callPostApi(mAuth, path, request, responseClass); + return callPostApi(mAuth, path, request, responseClass, options); } @@ -205,6 +207,7 @@ private static abstract class ApiCaller implements AuthleteApiCall mResponseClass; protected final Map mParams = new LinkedHashMap<>(); + protected Options mOptions; ApiCaller(Class responseClass, Object request, String path) @@ -227,6 +230,14 @@ public ApiCaller addParam(String name, Object... values) return this; } + + + public ApiCaller setOptions(Options options) + { + mOptions = options; + + return this; + } } @@ -247,7 +258,7 @@ private class DeleteApiCaller extends ApiCaller @Override public Void call() { - return callDeleteApi(mPath); + return callDeleteApi(mPath, mOptions); } } @@ -269,7 +280,7 @@ private class GetApiCaller extends ApiCaller @Override public TResponse call() { - return callGetApi(mPath, mResponseClass, mParams); + return callGetApi(mPath, mResponseClass, mParams, mOptions); } } @@ -291,7 +302,7 @@ private class PostApiCaller extends ApiCaller @Override public TResponse call() { - return callPostApi(mPath, mRequest, mResponseClass); + return callPostApi(mPath, mRequest, mResponseClass, mOptions); } } @@ -300,11 +311,12 @@ public TResponse call() * Call {@code /api/{serviceId}/auth/authorization} API. */ @Override - public AuthorizationResponse authorization(AuthorizationRequest request) throws AuthleteApiException + public AuthorizationResponse authorization(AuthorizationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - AuthorizationResponse.class, request, AUTH_AUTHORIZATION_API_PATH, mServiceId)); + AuthorizationResponse.class, request, AUTH_AUTHORIZATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -312,11 +324,12 @@ public AuthorizationResponse authorization(AuthorizationRequest request) throws * Call {@code /api/{serviceId}/auth/authorization/fail} API. */ @Override - public AuthorizationFailResponse authorizationFail(AuthorizationFailRequest request) throws AuthleteApiException + public AuthorizationFailResponse authorizationFail(AuthorizationFailRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - AuthorizationFailResponse.class, request, AUTH_AUTHORIZATION_FAIL_API_PATH, mServiceId)); + AuthorizationFailResponse.class, request, AUTH_AUTHORIZATION_FAIL_API_PATH, mServiceId) + .setOptions(options)); } @@ -324,11 +337,12 @@ public AuthorizationFailResponse authorizationFail(AuthorizationFailRequest requ * Call {@code /api/{serviceId}/auth/authorization/issue} API. */ @Override - public AuthorizationIssueResponse authorizationIssue(AuthorizationIssueRequest request) throws AuthleteApiException + public AuthorizationIssueResponse authorizationIssue(AuthorizationIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - AuthorizationIssueResponse.class, request, AUTH_AUTHORIZATION_ISSUE_API_PATH, mServiceId)); + AuthorizationIssueResponse.class, request, AUTH_AUTHORIZATION_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @@ -336,11 +350,12 @@ public AuthorizationIssueResponse authorizationIssue(AuthorizationIssueRequest r * Call {@code /api/{serviceId}/auth/token} API. */ @Override - public TokenResponse token(TokenRequest request) throws AuthleteApiException + public TokenResponse token(TokenRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - TokenResponse.class, request, AUTH_TOKEN_API_PATH, mServiceId)); + TokenResponse.class, request, AUTH_TOKEN_API_PATH, mServiceId) + .setOptions(options)); } @@ -348,11 +363,12 @@ public TokenResponse token(TokenRequest request) throws AuthleteApiException * Call {@code /api/{serviceId}/auth/token/create} API. */ @Override - public TokenCreateResponse tokenCreate(TokenCreateRequest request) throws AuthleteApiException + public TokenCreateResponse tokenCreate(TokenCreateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - TokenCreateResponse.class, request, AUTH_TOKEN_CREATE_API_PATH, mServiceId)); + TokenCreateResponse.class, request, AUTH_TOKEN_CREATE_API_PATH, mServiceId) + .setOptions(options)); } @@ -360,11 +376,12 @@ public TokenCreateResponse tokenCreate(TokenCreateRequest request) throws Authle * Call /api/{serviceId}/auth/token/delete/{token} API. */ @Override - public void tokenDelete(String token) throws AuthleteApiException + public void tokenDelete(String token, Options options) throws AuthleteApiException { executeApiCall( new DeleteApiCaller( - AUTH_TOKEN_DELETE_API_PATH, mServiceId, token)); + AUTH_TOKEN_DELETE_API_PATH, mServiceId, token) + .setOptions(options)); } @@ -372,11 +389,12 @@ public void tokenDelete(String token) throws AuthleteApiException * Call {@code /api/{serviceId}/auth/token/fail} API. */ @Override - public TokenFailResponse tokenFail(TokenFailRequest request) throws AuthleteApiException + public TokenFailResponse tokenFail(TokenFailRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - TokenFailResponse.class, request, AUTH_TOKEN_FAIL_API_PATH, mServiceId)); + TokenFailResponse.class, request, AUTH_TOKEN_FAIL_API_PATH, mServiceId) + .setOptions(options)); } @@ -384,11 +402,12 @@ public TokenFailResponse tokenFail(TokenFailRequest request) throws AuthleteApiE * Call {@code /api/{serviceId}/auth/token/issue} API. */ @Override - public TokenIssueResponse tokenIssue(TokenIssueRequest request) throws AuthleteApiException + public TokenIssueResponse tokenIssue(TokenIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - TokenIssueResponse.class, request, AUTH_TOKEN_ISSUE_API_PATH, mServiceId)); + TokenIssueResponse.class, request, AUTH_TOKEN_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @@ -396,11 +415,12 @@ public TokenIssueResponse tokenIssue(TokenIssueRequest request) throws AuthleteA * Call {@code /api/{serviceId}/auth/token/revoke} API. */ @Override - public TokenRevokeResponse tokenRevoke(TokenRevokeRequest request) throws AuthleteApiException + public TokenRevokeResponse tokenRevoke(TokenRevokeRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - TokenRevokeResponse.class, request, AUTH_TOKEN_REVOKE_API_PATH, mServiceId)); + TokenRevokeResponse.class, request, AUTH_TOKEN_REVOKE_API_PATH, mServiceId) + .setOptions(options)); } @@ -408,87 +428,90 @@ public TokenRevokeResponse tokenRevoke(TokenRevokeRequest request) throws Authle * Call {@code /api/{serviceId}/auth/token/update} API. */ @Override - public TokenUpdateResponse tokenUpdate(TokenUpdateRequest request) throws AuthleteApiException + public TokenUpdateResponse tokenUpdate(TokenUpdateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - TokenUpdateResponse.class, request, AUTH_TOKEN_UPDATE_API_PATH, mServiceId)); + TokenUpdateResponse.class, request, AUTH_TOKEN_UPDATE_API_PATH, mServiceId) + .setOptions(options)); } @Override - public TokenListResponse getTokenList() throws AuthleteApiException + public TokenListResponse getTokenList(Options options) throws AuthleteApiException { - return getTokenList(null, null, 0, 0, false, TokenStatus.ALL); + return getTokenList(null, null, 0, 0, false, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(null, null, 0, 0, false, tokenStatus); + return getTokenList(null, null, 0, 0, false, tokenStatus, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, 0, 0, false, TokenStatus.ALL); + return getTokenList(clientIdentifier, subject, 0, 0, false, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject, TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, 0, 0, false, tokenStatus); + return getTokenList(clientIdentifier, subject, 0, 0, false, tokenStatus, options); } @Override - public TokenListResponse getTokenList(int start, int end) throws AuthleteApiException + public TokenListResponse getTokenList(int start, int end, Options options) throws AuthleteApiException { - return getTokenList(null, null, start, end, true, TokenStatus.ALL); + return getTokenList(null, null, start, end, true, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(int start, int end, TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(int start, int end, TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(null, null, start, end, true, tokenStatus); + return getTokenList(null, null, start, end, true, tokenStatus, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, start, end, true, TokenStatus.ALL); + return getTokenList(clientIdentifier, subject, start, end, true, TokenStatus.ALL, options); } @Override - public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end, TokenStatus tokenStatus) throws AuthleteApiException + public TokenListResponse getTokenList(String clientIdentifier, String subject, int start, int end, TokenStatus tokenStatus, Options options) throws AuthleteApiException { - return getTokenList(clientIdentifier, subject, start, end, true, tokenStatus); + return getTokenList(clientIdentifier, subject, start, end, true, tokenStatus, options); } private TokenListResponse getTokenList( final String clientIdentifier, final String subject, - final int start, final int end, final boolean rangeGiven, TokenStatus tokenStatus) throws AuthleteApiException + final int start, final int end, final boolean rangeGiven, TokenStatus tokenStatus, + Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall() { @Override public TokenListResponse call() { - return callGetTokenList(clientIdentifier, subject, start, end, rangeGiven, tokenStatus); + return callGetTokenList(clientIdentifier, subject, start, end, rangeGiven, tokenStatus, options); } }); } private TokenListResponse callGetTokenList( - String clientIdentifier, String subject, int start, int end, boolean rangeGiven, TokenStatus tokenStatus) + String clientIdentifier, String subject, int start, int end, boolean rangeGiven, + TokenStatus tokenStatus, Options options) { String path = String.format(AUTH_TOKEN_GET_LIST_API_PATH, mServiceId); @@ -512,10 +535,13 @@ private TokenListResponse callGetTokenList( target = target.queryParam("tokenStatus", tokenStatus.toString()); // FIXME: it feels weird that this is in its own space instead of the caller classes, is there a reason for that? - return wrapWithDpop(target + Builder builder = wrapWithDpop(target .request(APPLICATION_JSON_TYPE), AUTH_TOKEN_GET_LIST_API_PATH, "GET") - .header(AUTHORIZATION, mAuth) - .get(TokenListResponse.class); + .header(AUTHORIZATION, mAuth); + + setCustomRequestHeaders(builder, options); + + return builder.get(TokenListResponse.class); } @@ -523,11 +549,12 @@ private TokenListResponse callGetTokenList( * Call {@code /api/{serviceId}/auth/revocation} API. */ @Override - public RevocationResponse revocation(RevocationRequest request) throws AuthleteApiException + public RevocationResponse revocation(RevocationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - RevocationResponse.class, request, AUTH_REVOCATION_API_PATH, mServiceId)); + RevocationResponse.class, request, AUTH_REVOCATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -535,11 +562,12 @@ public RevocationResponse revocation(RevocationRequest request) throws AuthleteA * Call {@code /api/{serviceId}/auth/userinfo} API. */ @Override - public UserInfoResponse userinfo(UserInfoRequest request) throws AuthleteApiException + public UserInfoResponse userinfo(UserInfoRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - UserInfoResponse.class, request, AUTH_USERINFO_API_PATH, mServiceId)); + UserInfoResponse.class, request, AUTH_USERINFO_API_PATH, mServiceId) + .setOptions(options)); } @@ -547,11 +575,12 @@ public UserInfoResponse userinfo(UserInfoRequest request) throws AuthleteApiExce * Call {@code /api/{serviceId}/auth/userinfo/issue} API. */ @Override - public UserInfoIssueResponse userinfoIssue(UserInfoIssueRequest request) throws AuthleteApiException + public UserInfoIssueResponse userinfoIssue(UserInfoIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - UserInfoIssueResponse.class, request, AUTH_USERINFO_ISSUE_API_PATH, mServiceId)); + UserInfoIssueResponse.class, request, AUTH_USERINFO_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @@ -559,11 +588,12 @@ public UserInfoIssueResponse userinfoIssue(UserInfoIssueRequest request) throws * Call {@code /api/{serviceId}/auth/introspection} API. */ @Override - public IntrospectionResponse introspection(IntrospectionRequest request) throws AuthleteApiException + public IntrospectionResponse introspection(IntrospectionRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - IntrospectionResponse.class, request, AUTH_INTROSPECTION_API_PATH, mServiceId)); + IntrospectionResponse.class, request, AUTH_INTROSPECTION_API_PATH, mServiceId) + .setOptions(options)); } @@ -572,11 +602,12 @@ public IntrospectionResponse introspection(IntrospectionRequest request) throws */ @Override public StandardIntrospectionResponse standardIntrospection( - StandardIntrospectionRequest request) throws AuthleteApiException + StandardIntrospectionRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - StandardIntrospectionResponse.class, request, AUTH_INTROSPECTION_STANDARD_API_PATH, mServiceId)); + StandardIntrospectionResponse.class, request, AUTH_INTROSPECTION_STANDARD_API_PATH, mServiceId) + .setOptions(options)); } @@ -584,11 +615,12 @@ public StandardIntrospectionResponse standardIntrospection( * Call {@code /api/service/create} API. */ @Override - public Service createService(Service service) throws AuthleteApiException + public Service createService(Service service, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - Service.class, service, SERVICE_CREATE_API_PATH)); + Service.class, service, SERVICE_CREATE_API_PATH) + .setOptions(options)); } @@ -607,11 +639,11 @@ public Service createServie(Service service) throws AuthleteApiException * Call /api/{serviceId}/service/delete/ API. */ @Override - public void deleteService(long apiKey) throws AuthleteApiException + public void deleteService(long apiKey, Options options) throws AuthleteApiException { executeApiCall( - new DeleteApiCaller( - SERVICE_DELETE_API_PATH, apiKey)); + new DeleteApiCaller(SERVICE_DELETE_API_PATH, apiKey) + .setOptions(options)); } @@ -619,11 +651,12 @@ public void deleteService(long apiKey) throws AuthleteApiException * Call /api/{serviceId}/service/get API. */ @Override - public Service getService(long apiKey) throws AuthleteApiException + public Service getService(long apiKey, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( - Service.class, SERVICE_GET_API_PATH, apiKey)); + Service.class, SERVICE_GET_API_PATH, apiKey) + .setOptions(options)); } @@ -631,28 +664,28 @@ public Service getService(long apiKey) throws AuthleteApiException * Call {@code /api/service/get/list} API. */ @Override - public ServiceListResponse getServiceList() throws AuthleteApiException + public ServiceListResponse getServiceList(Options options) throws AuthleteApiException { - return getServiceList(0, 0, false); + return getServiceList(0, 0, false, options); } @Override - public ServiceListResponse getServiceList(int start, int end) throws AuthleteApiException + public ServiceListResponse getServiceList(int start, int end, Options options) throws AuthleteApiException { - return getServiceList(start, end, true); + return getServiceList(start, end, true, options); } private ServiceListResponse getServiceList( - final int start, final int end, final boolean rangeGiven) throws AuthleteApiException + final int start, final int end, final boolean rangeGiven, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall() { @Override public ServiceListResponse call() { - return callGetServiceList(start, end, rangeGiven); + return callGetServiceList(start, end, rangeGiven, options); } }); } @@ -661,7 +694,7 @@ public ServiceListResponse call() /** * Call /service/get/list. */ - private ServiceListResponse callGetServiceList(int start, int end, boolean rangeGiven) + private ServiceListResponse callGetServiceList(int start, int end, boolean rangeGiven, Options options) { WebTarget target = getTarget().path(SERVICE_GET_LIST_API_PATH); @@ -671,10 +704,13 @@ private ServiceListResponse callGetServiceList(int start, int end, boolean range } // FIXME: it feels strange that this doesn't use the caller structures above - return wrapWithDpop(target + Builder builder = wrapWithDpop(target .request(APPLICATION_JSON_TYPE), SERVICE_GET_LIST_API_PATH, "GET") - .header(AUTHORIZATION, mAuth) - .get(ServiceListResponse.class); + .header(AUTHORIZATION, mAuth); + + setCustomRequestHeaders(builder, options); + + return builder.get(ServiceListResponse.class); } @@ -682,11 +718,12 @@ private ServiceListResponse callGetServiceList(int start, int end, boolean range * Call /api/{serviceId}/service/update/ API. */ @Override - public Service updateService(final Service service) throws AuthleteApiException + public Service updateService(final Service service, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - Service.class, service, SERVICE_UPDATE_API_PATH, service.getApiKey())); + Service.class, service, SERVICE_UPDATE_API_PATH, service.getApiKey()) + .setOptions(options)); } @@ -694,11 +731,12 @@ public Service updateService(final Service service) throws AuthleteApiException * Call {@code /api/{serviceId}/service/jwks/get} API */ @Override - public String getServiceJwks() throws AuthleteApiException + public String getServiceJwks(Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( - String.class, SERVICE_JWKS_GET_API_PATH, mServiceId)); + String.class, SERVICE_JWKS_GET_API_PATH, mServiceId) + .setOptions(options)); } @@ -706,13 +744,14 @@ public String getServiceJwks() throws AuthleteApiException * Call {@code /api/{serviceId}/service/jwks/get} API */ @Override - public String getServiceJwks(boolean pretty, boolean includePrivateKeys) throws AuthleteApiException + public String getServiceJwks(boolean pretty, boolean includePrivateKeys, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( String.class, SERVICE_JWKS_GET_API_PATH, mServiceId) .addParam("pretty", pretty) - .addParam("includePrivateKeys", includePrivateKeys)); + .addParam("includePrivateKeys", includePrivateKeys) + .setOptions(options)); } @@ -720,11 +759,12 @@ public String getServiceJwks(boolean pretty, boolean includePrivateKeys) throws * Call {@code /api/{serviceId}/service/configuration} API */ @Override - public String getServiceConfiguration() throws AuthleteApiException + public String getServiceConfiguration(Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( - String.class, SERVICE_CONFIGURATION_API_PATH, mServiceId)); + String.class, SERVICE_CONFIGURATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -732,12 +772,13 @@ public String getServiceConfiguration() throws AuthleteApiException * Call {@code /api/{serviceId}/service/configuration} API */ @Override - public String getServiceConfiguration(boolean pretty) throws AuthleteApiException + public String getServiceConfiguration(boolean pretty, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( String.class, SERVICE_CONFIGURATION_API_PATH, mServiceId) - .addParam("pretty", pretty)); + .addParam("pretty", pretty) + .setOptions(options)); } @@ -745,11 +786,12 @@ public String getServiceConfiguration(boolean pretty) throws AuthleteApiExceptio * Call {@code /api/{serviceId}/service/configuration} API */ @Override - public String getServiceConfiguration(ServiceConfigurationRequest request) throws AuthleteApiException + public String getServiceConfiguration(ServiceConfigurationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - String.class, request, SERVICE_CONFIGURATION_API_PATH, mServiceId)); + String.class, request, SERVICE_CONFIGURATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -757,11 +799,12 @@ public String getServiceConfiguration(ServiceConfigurationRequest request) throw * Call {@code /api/{serviceId}/client/create} API. */ @Override - public Client createClient(Client client) throws AuthleteApiException + public Client createClient(Client client, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - Client.class, client, CLIENT_CREATE_API_PATH, mServiceId)); + Client.class, client, CLIENT_CREATE_API_PATH, mServiceId) + .setOptions(options)); } @@ -769,11 +812,12 @@ public Client createClient(Client client) throws AuthleteApiException * Call {@code /api/{serviceId}/client/registration} API. */ @Override - public ClientRegistrationResponse dynamicClientRegister(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientRegister(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_API_PATH, mServiceId)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -781,11 +825,12 @@ public ClientRegistrationResponse dynamicClientRegister(ClientRegistrationReques * Call {@code /api/{serviceId}/client/registration/get} API. */ @Override - public ClientRegistrationResponse dynamicClientGet(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientGet(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_GET_API_PATH, mServiceId)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_GET_API_PATH, mServiceId) + .setOptions(options)); } @@ -793,11 +838,12 @@ public ClientRegistrationResponse dynamicClientGet(ClientRegistrationRequest req * Call {@code /api/{serviceId}/client/registration/update} API. */ @Override - public ClientRegistrationResponse dynamicClientUpdate(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientUpdate(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_UPDATE_API_PATH, mServiceId)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_UPDATE_API_PATH, mServiceId) + .setOptions(options)); } @@ -805,11 +851,12 @@ public ClientRegistrationResponse dynamicClientUpdate(ClientRegistrationRequest * Call {@code /api/{serviceId}/client/registration/delete} API. */ @Override - public ClientRegistrationResponse dynamicClientDelete(ClientRegistrationRequest request) throws AuthleteApiException + public ClientRegistrationResponse dynamicClientDelete(ClientRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_DELETE_API_PATH, mServiceId)); + ClientRegistrationResponse.class, request, CLIENT_REGISTRATION_DELETE_API_PATH, mServiceId) + .setOptions(options)); } @@ -817,9 +864,9 @@ public ClientRegistrationResponse dynamicClientDelete(ClientRegistrationRequest * Call /api/{serviceId}/client/delete/{clientId} API. */ @Override - public void deleteClient(long clientId) throws AuthleteApiException + public void deleteClient(long clientId, Options options) throws AuthleteApiException { - deleteClient(String.valueOf(clientId)); + deleteClient(String.valueOf(clientId), options); } @@ -827,11 +874,12 @@ public void deleteClient(long clientId) throws AuthleteApiException * Call /api/{serviceId}/client/delete/{clientId} API. */ @Override - public void deleteClient(String clientId) throws AuthleteApiException + public void deleteClient(String clientId, Options options) throws AuthleteApiException { executeApiCall( new DeleteApiCaller( - CLIENT_DELETE_API_PATH, mServiceId, clientId)); + CLIENT_DELETE_API_PATH, mServiceId, clientId) + .setOptions(options)); } @@ -839,9 +887,9 @@ public void deleteClient(String clientId) throws AuthleteApiException * Call /api/{serviceId}/client/get/{clientId} API. */ @Override - public Client getClient(long clientId) throws AuthleteApiException + public Client getClient(long clientId, Options options) throws AuthleteApiException { - return getClient(String.valueOf(clientId)); + return getClient(String.valueOf(clientId), options); } @@ -849,11 +897,12 @@ public Client getClient(long clientId) throws AuthleteApiException * Call /api/{serviceId}/client/get/{clientId} API. */ @Override - public Client getClient(String clientId) throws AuthleteApiException + public Client getClient(String clientId, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( - Client.class, CLIENT_GET_API_PATH, mServiceId, clientId)); + Client.class, CLIENT_GET_API_PATH, mServiceId, clientId) + .setOptions(options)); } @@ -861,48 +910,48 @@ public Client getClient(String clientId) throws AuthleteApiException * Call {@code /api/{serviceId}/client/get/list} API. */ @Override - public ClientListResponse getClientList() throws AuthleteApiException + public ClientListResponse getClientList(Options options) throws AuthleteApiException { - return getClientList(null, 0, 0, false); + return getClientList(null, 0, 0, false, options); } @Override - public ClientListResponse getClientList(String developer) throws AuthleteApiException + public ClientListResponse getClientList(String developer, Options options) throws AuthleteApiException { - return getClientList(developer, 0, 0, false); + return getClientList(developer, 0, 0, false, options); } @Override - public ClientListResponse getClientList(int start, int end) throws AuthleteApiException + public ClientListResponse getClientList(int start, int end, Options options) throws AuthleteApiException { - return getClientList(null, start, end, true); + return getClientList(null, start, end, true, options); } @Override - public ClientListResponse getClientList(String developer, int start, int end) throws AuthleteApiException + public ClientListResponse getClientList(String developer, int start, int end, Options options) throws AuthleteApiException { - return getClientList(developer, start, end, true); + return getClientList(developer, start, end, true, options); } private ClientListResponse getClientList( - final String developer, final int start, final int end, final boolean rangeGiven) throws AuthleteApiException + final String developer, final int start, final int end, final boolean rangeGiven, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall() { @Override public ClientListResponse call() { - return callGetClientList(developer, start, end, rangeGiven); + return callGetClientList(developer, start, end, rangeGiven, options); } }); } - private ClientListResponse callGetClientList(String developer, int start, int end, boolean rangeGiven) + private ClientListResponse callGetClientList(String developer, int start, int end, boolean rangeGiven, Options options) { String path = String.format(CLIENT_GET_LIST_API_PATH, mServiceId); @@ -919,10 +968,13 @@ private ClientListResponse callGetClientList(String developer, int start, int en } // FIXME: this seems weird that it's not the same caller structure as others - return wrapWithDpop(target + Builder builder = wrapWithDpop(target .request(APPLICATION_JSON_TYPE), CLIENT_GET_LIST_API_PATH, "GET") - .header(AUTHORIZATION, mAuth) - .get(ClientListResponse.class); + .header(AUTHORIZATION, mAuth); + + setCustomRequestHeaders(builder, options); + + return builder.get(ClientListResponse.class); } @@ -930,25 +982,26 @@ private ClientListResponse callGetClientList(String developer, int start, int en * Call /api/{serviceId}/client/update/{clientId} API. */ @Override - public Client updateClient(Client client) throws AuthleteApiException + public Client updateClient(Client client, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - Client.class, client, CLIENT_UPDATE_API_PATH, mServiceId, client.getClientId())); + Client.class, client, CLIENT_UPDATE_API_PATH, mServiceId, client.getClientId()) + .setOptions(options)); } - /** * Call /api/{serviceId}/client/extension/requestable_scopes/get/{clientId} API. */ @Override - public String[] getRequestableScopes(long clientId) throws AuthleteApiException + public String[] getRequestableScopes(long clientId, Options options) throws AuthleteApiException { // Call the API. RequestableScopes response = executeApiCall( new GetApiCaller( - RequestableScopes.class, REQUESTABLE_SCOPES_GET_API_PATH, mServiceId, clientId)); + RequestableScopes.class, REQUESTABLE_SCOPES_GET_API_PATH, mServiceId, clientId) + .setOptions(options)); if (response != null) { @@ -963,7 +1016,7 @@ public String[] getRequestableScopes(long clientId) throws AuthleteApiException @Override - public String[] setRequestableScopes(long clientId, String[] scopes) throws AuthleteApiException + public String[] setRequestableScopes(long clientId, String[] scopes, Options options) throws AuthleteApiException { // Prepare a request body. RequestableScopes request = new RequestableScopes().setRequestableScopes(scopes); @@ -971,7 +1024,8 @@ public String[] setRequestableScopes(long clientId, String[] scopes) throws Auth // Call the API. RequestableScopes response = executeApiCall( new PostApiCaller( - RequestableScopes.class, request, REQUESTABLE_SCOPES_UPDATE_API_PATH, mServiceId, clientId)); + RequestableScopes.class, request, REQUESTABLE_SCOPES_UPDATE_API_PATH, mServiceId, clientId) + .setOptions(options)); if (response != null) { @@ -989,16 +1043,17 @@ public String[] setRequestableScopes(long clientId, String[] scopes) throws Auth * Call /api/{serviceId}/client/extension/requestable_scopes/delete/{clientId} API. */ @Override - public void deleteRequestableScopes(long clientId) throws AuthleteApiException + public void deleteRequestableScopes(long clientId, Options options) throws AuthleteApiException { executeApiCall( new DeleteApiCaller( - REQUESTABLE_SCOPES_DELETE_API_PATH, mServiceId, clientId)); + REQUESTABLE_SCOPES_DELETE_API_PATH, mServiceId, clientId) + .setOptions(options)); } @Override - public GrantedScopesGetResponse getGrantedScopes(long clientId, String subject) + public GrantedScopesGetResponse getGrantedScopes(long clientId, String subject, Options options) { // Prepare a request body. GrantedScopesRequest request = new GrantedScopesRequest(subject); @@ -1006,19 +1061,21 @@ public GrantedScopesGetResponse getGrantedScopes(long clientId, String subject) // Call the API. return executeApiCall( new PostApiCaller( - GrantedScopesGetResponse.class, request, GRANTED_SCOPES_GET_API_PATH, mServiceId, clientId)); + GrantedScopesGetResponse.class, request, GRANTED_SCOPES_GET_API_PATH, mServiceId, clientId) + .setOptions(options)); } @Override - public void deleteGrantedScopes(long clientId, String subject) + public void deleteGrantedScopes(long clientId, String subject, Options options) { // Prepare a request body. GrantedScopesRequest request = new GrantedScopesRequest(subject); executeApiCall( new PostApiCaller( - ApiResponse.class, request, GRANTED_SCOPES_DELETE_API_PATH, mServiceId, clientId)); + ApiResponse.class, request, GRANTED_SCOPES_DELETE_API_PATH, mServiceId, clientId) + .setOptions(options)); } @@ -1049,61 +1106,68 @@ public void setSubject(String subject) @Override - public void deleteClientAuthorization(long clientId, String subject) throws AuthleteApiException + public void deleteClientAuthorization(long clientId, String subject, Options options) throws AuthleteApiException { // Prepare a request body. ClientAuthorizationDeleteRequest request = new ClientAuthorizationDeleteRequest(subject); executeApiCall( new PostApiCaller( - ApiResponse.class, request, CLIENT_AUTHORIZATION_DELETE_API_PATH, mServiceId, clientId)); + ApiResponse.class, request, CLIENT_AUTHORIZATION_DELETE_API_PATH, mServiceId, clientId) + .setOptions(options)); } @Override - public AuthorizedClientListResponse getClientAuthorizationList(ClientAuthorizationGetListRequest request) throws AuthleteApiException + public AuthorizedClientListResponse getClientAuthorizationList( + ClientAuthorizationGetListRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - AuthorizedClientListResponse.class, request, CLIENT_AUTHORIZATION_GET_LIST_API_PATH, mServiceId)); + AuthorizedClientListResponse.class, request, CLIENT_AUTHORIZATION_GET_LIST_API_PATH, mServiceId) + .setOptions(options)); } @Override - public void updateClientAuthorization(long clientId, ClientAuthorizationUpdateRequest request) throws AuthleteApiException + public void updateClientAuthorization( + long clientId, ClientAuthorizationUpdateRequest request, Options options) throws AuthleteApiException { executeApiCall( new PostApiCaller( - ApiResponse.class, request, CLIENT_AUTHORIZATION_UPDATE_API_PATH, mServiceId, clientId)); + ApiResponse.class, request, CLIENT_AUTHORIZATION_UPDATE_API_PATH, mServiceId, clientId) + .setOptions(options)); } @Override - public ClientSecretRefreshResponse refreshClientSecret(long clientId) throws AuthleteApiException + public ClientSecretRefreshResponse refreshClientSecret(long clientId, Options options) throws AuthleteApiException { - return refreshClientSecret(String.valueOf(clientId)); + return refreshClientSecret(String.valueOf(clientId), options); } @Override - public ClientSecretRefreshResponse refreshClientSecret(String clientIdentifier) throws AuthleteApiException + public ClientSecretRefreshResponse refreshClientSecret(String clientIdentifier, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( ClientSecretRefreshResponse.class, - CLIENT_SECRET_REFRESH_API_PATH, mServiceId, clientIdentifier)); + CLIENT_SECRET_REFRESH_API_PATH, mServiceId, clientIdentifier) + .setOptions(options)); } @Override - public ClientSecretUpdateResponse updateClientSecret(long clientId, String clientSecret) throws AuthleteApiException + public ClientSecretUpdateResponse updateClientSecret(long clientId, String clientSecret, Options options) throws AuthleteApiException { - return updateClientSecret(String.valueOf(clientId), clientSecret); + return updateClientSecret(String.valueOf(clientId), clientSecret, options); } @Override - public ClientSecretUpdateResponse updateClientSecret(String clientIdentifier, String clientSecret) throws AuthleteApiException + public ClientSecretUpdateResponse updateClientSecret( + String clientIdentifier, String clientSecret, Options options) throws AuthleteApiException { // Prepare a request body. setClientSecret(String) method // throws IllegalArgumentException if the given client secret @@ -1114,7 +1178,8 @@ public ClientSecretUpdateResponse updateClientSecret(String clientIdentifier, St return executeApiCall( new PostApiCaller( ClientSecretUpdateResponse.class, request, - CLIENT_SECRET_UPDATE_API_PATH, mServiceId, clientIdentifier)); + CLIENT_SECRET_UPDATE_API_PATH, mServiceId, clientIdentifier) + .setOptions(options)); } @@ -1122,11 +1187,12 @@ public ClientSecretUpdateResponse updateClientSecret(String clientIdentifier, St * Call {@code /api/{serviceId}/jose/verify} API. */ @Override - public JoseVerifyResponse verifyJose(JoseVerifyRequest request) throws AuthleteApiException + public JoseVerifyResponse verifyJose(JoseVerifyRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - JoseVerifyResponse.class, request, JOSE_VERIFY_API_PATH, mServiceId)); + JoseVerifyResponse.class, request, JOSE_VERIFY_API_PATH, mServiceId) + .setOptions(options)); } @@ -1134,11 +1200,13 @@ public JoseVerifyResponse verifyJose(JoseVerifyRequest request) throws AuthleteA * Call {@code /api/{serviceId}/backchannel/authentication} API. */ @Override - public BackchannelAuthenticationResponse backchannelAuthentication(BackchannelAuthenticationRequest request) throws AuthleteApiException + public BackchannelAuthenticationResponse backchannelAuthentication( + BackchannelAuthenticationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - BackchannelAuthenticationResponse.class, request, BACKCHANNEL_AUTHENTICATION_API_PATH, mServiceId)); + BackchannelAuthenticationResponse.class, request, BACKCHANNEL_AUTHENTICATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -1146,11 +1214,13 @@ public BackchannelAuthenticationResponse backchannelAuthentication(BackchannelAu * Call {@code /api/{serviceId}/backchannel/authentication/issue} API. */ @Override - public BackchannelAuthenticationIssueResponse backchannelAuthenticationIssue(BackchannelAuthenticationIssueRequest request) throws AuthleteApiException + public BackchannelAuthenticationIssueResponse backchannelAuthenticationIssue( + BackchannelAuthenticationIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - BackchannelAuthenticationIssueResponse.class, request, BACKCHANNEL_AUTHENTICATION_ISSUE_API_PATH, mServiceId)); + BackchannelAuthenticationIssueResponse.class, request, BACKCHANNEL_AUTHENTICATION_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @@ -1158,11 +1228,13 @@ public BackchannelAuthenticationIssueResponse backchannelAuthenticationIssue(Bac * Call {@code /api/{serviceId}/backchannel/authentication/fail} API. */ @Override - public BackchannelAuthenticationFailResponse backchannelAuthenticationFail(BackchannelAuthenticationFailRequest request) throws AuthleteApiException + public BackchannelAuthenticationFailResponse backchannelAuthenticationFail( + BackchannelAuthenticationFailRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - BackchannelAuthenticationFailResponse.class, request, BACKCHANNEL_AUTHENTICATION_FAIL_API_PATH, mServiceId)); + BackchannelAuthenticationFailResponse.class, request, BACKCHANNEL_AUTHENTICATION_FAIL_API_PATH, mServiceId) + .setOptions(options)); } @@ -1170,11 +1242,13 @@ public BackchannelAuthenticationFailResponse backchannelAuthenticationFail(Backc * Call {@code /api/{serviceId}/backchannel/authentication/complete} API. */ @Override - public BackchannelAuthenticationCompleteResponse backchannelAuthenticationComplete(BackchannelAuthenticationCompleteRequest request) throws AuthleteApiException + public BackchannelAuthenticationCompleteResponse backchannelAuthenticationComplete( + BackchannelAuthenticationCompleteRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - BackchannelAuthenticationCompleteResponse.class, request, BACKCHANNEL_AUTHENTICATION_COMPLETE_API_PATH, mServiceId)); + BackchannelAuthenticationCompleteResponse.class, request, BACKCHANNEL_AUTHENTICATION_COMPLETE_API_PATH, mServiceId) + .setOptions(options)); } @@ -1182,11 +1256,13 @@ public BackchannelAuthenticationCompleteResponse backchannelAuthenticationComple * Call {@code /api/{serviceId}/device/authorization} API. */ @Override - public DeviceAuthorizationResponse deviceAuthorization(DeviceAuthorizationRequest request) throws AuthleteApiException + public DeviceAuthorizationResponse deviceAuthorization( + DeviceAuthorizationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - DeviceAuthorizationResponse.class, request, DEVICE_AUTHORIZATION_API_PATH, mServiceId)); + DeviceAuthorizationResponse.class, request, DEVICE_AUTHORIZATION_API_PATH, mServiceId) + .setOptions(options)); } @@ -1194,11 +1270,13 @@ public DeviceAuthorizationResponse deviceAuthorization(DeviceAuthorizationReques * Call {@code /api/{serviceId}/device/complete} API. */ @Override - public DeviceCompleteResponse deviceComplete(DeviceCompleteRequest request) throws AuthleteApiException + public DeviceCompleteResponse deviceComplete( + DeviceCompleteRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - DeviceCompleteResponse.class, request, DEVICE_COMPLETE_API_PATH, mServiceId)); + DeviceCompleteResponse.class, request, DEVICE_COMPLETE_API_PATH, mServiceId) + .setOptions(options)); } @@ -1206,77 +1284,85 @@ public DeviceCompleteResponse deviceComplete(DeviceCompleteRequest request) thro * Call {@code /api/{serviceId}/device/verification} API. */ @Override - public DeviceVerificationResponse deviceVerification(DeviceVerificationRequest request) throws AuthleteApiException + public DeviceVerificationResponse deviceVerification( + DeviceVerificationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - DeviceVerificationResponse.class, request, DEVICE_VERIFICATION_API_PATH, mServiceId)); + DeviceVerificationResponse.class, request, DEVICE_VERIFICATION_API_PATH, mServiceId) + .setOptions(options)); } @Override - public PushedAuthReqResponse pushAuthorizationRequest(PushedAuthReqRequest request) throws AuthleteApiException + public PushedAuthReqResponse pushAuthorizationRequest( + PushedAuthReqRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - PushedAuthReqResponse.class, request, PUSHED_AUTH_REQ_API_PATH, mServiceId)); + PushedAuthReqResponse.class, request, PUSHED_AUTH_REQ_API_PATH, mServiceId) + .setOptions(options)); } @Override - public HskResponse hskCreate(HskCreateRequest request) throws AuthleteApiException + public HskResponse hskCreate(HskCreateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - HskResponse.class, request, HSK_CREATE_API_PATH, mServiceId)); + HskResponse.class, request, HSK_CREATE_API_PATH, mServiceId) + .setOptions(options)); } @Override - public HskResponse hskDelete(String handle) throws AuthleteApiException + public HskResponse hskDelete(String handle, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( HskResponse.class, - HSK_DELETE_API_PATH, mServiceId, handle)); + HSK_DELETE_API_PATH, mServiceId, handle) + .setOptions(options)); } @Override - public HskResponse hskGet(String handle) throws AuthleteApiException + public HskResponse hskGet(String handle, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( HskResponse.class, - HSK_GET_API_PATH, mServiceId, handle)); + HSK_GET_API_PATH, mServiceId, handle) + .setOptions(options)); } @Override - public HskListResponse hskGetList() throws AuthleteApiException + public HskListResponse hskGetList(Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( HskListResponse.class, - HSK_GET_LIST_API_PATH, mServiceId)); + HSK_GET_LIST_API_PATH, mServiceId) + .setOptions(options)); } @Override - public Map echo(Map parameters) throws AuthleteApiException + public Map echo(Map parameters, Options options) throws AuthleteApiException { return executeApiCall(new AuthleteApiCall>() { @Override public Map call() { - return callEcho(parameters); + return callEcho(parameters, options); } }); } - private Map callEcho(Map parameters) + private Map callEcho(Map parameters, Options options) { WebTarget target = getTarget().path(ECHO_API_PATH); @@ -1291,229 +1377,251 @@ private Map callEcho(Map parameters) // The API does not require any authentication, so the code below // does not include '.header(AUTHORIZATION, ...)'. - return target - .request(APPLICATION_JSON_TYPE) - .get(new GenericType>(){}); + Builder builder = target.request(APPLICATION_JSON_TYPE); + + setCustomRequestHeaders(builder, options); + + return builder.get(new GenericType>(){}); } @Override - public GMResponse gm(GMRequest request) throws AuthleteApiException + public GMResponse gm(GMRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( - GMResponse.class, request, GM_API_PATH, mServiceId)); + GMResponse.class, request, GM_API_PATH, mServiceId) + .setOptions(options)); } @Override public void updateClientLockFlag( - String clientIdentifier, boolean clientLocked) throws AuthleteApiException + String clientIdentifier, boolean clientLocked, Options options) throws AuthleteApiException { // Prepare a request body. ClientLockFlagUpdateRequest request = new ClientLockFlagUpdateRequest().setClientLocked(clientLocked); executeApiCall( new PostApiCaller( - ApiResponse.class, request, CLIENT_LOCK_FLAG_UPDATE_API_PATH, mServiceId, clientIdentifier)); + ApiResponse.class, request, CLIENT_LOCK_FLAG_UPDATE_API_PATH, mServiceId, clientIdentifier) + .setOptions(options)); } @Override public FederationConfigurationResponse federationConfiguration( - FederationConfigurationRequest request) throws AuthleteApiException + FederationConfigurationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( FederationConfigurationResponse.class, request, - FEDERATION_CONFIGURATION_API_PATH, mServiceId)); + FEDERATION_CONFIGURATION_API_PATH, mServiceId) + .setOptions(options)); } @Override public FederationRegistrationResponse federationRegistration( - FederationRegistrationRequest request) throws AuthleteApiException + FederationRegistrationRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( FederationRegistrationResponse.class, request, - FEDERATION_REGISTRATION_API_PATH, mServiceId)); + FEDERATION_REGISTRATION_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialIssuerMetadataResponse credentialIssuerMetadata( - CredentialIssuerMetadataRequest request) throws AuthleteApiException + CredentialIssuerMetadataRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialIssuerMetadataResponse.class, request, - VCI_METADATA_API_PATH, mServiceId)); + VCI_METADATA_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialJwtIssuerMetadataResponse credentialJwtIssuerMetadata( - CredentialJwtIssuerMetadataRequest request) throws AuthleteApiException + CredentialJwtIssuerMetadataRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialJwtIssuerMetadataResponse.class, request, - VCI_JWT_ISSUER_API_PATH, mServiceId)); + VCI_JWT_ISSUER_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialIssuerJwksResponse credentialIssuerJwks( - CredentialIssuerJwksRequest request) throws AuthleteApiException + CredentialIssuerJwksRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialIssuerJwksResponse.class, request, - VCI_JWKS_API_PATH, mServiceId)); + VCI_JWKS_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialOfferCreateResponse credentialOfferCreate( - CredentialOfferCreateRequest request) throws AuthleteApiException + CredentialOfferCreateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialOfferCreateResponse.class, request, - VCI_OFFER_CREATE_API_PATH, mServiceId)); + VCI_OFFER_CREATE_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialOfferInfoResponse credentialOfferInfo( - CredentialOfferInfoRequest request) throws AuthleteApiException + CredentialOfferInfoRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialOfferInfoResponse.class, request, - VCI_OFFER_INFO_API_PATH, mServiceId)); + VCI_OFFER_INFO_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialSingleParseResponse credentialSingleParse( - CredentialSingleParseRequest request) throws AuthleteApiException + CredentialSingleParseRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialSingleParseResponse.class, request, - VCI_SINGLE_PARSE_API_PATH, mServiceId)); + VCI_SINGLE_PARSE_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialSingleIssueResponse credentialSingleIssue( - CredentialSingleIssueRequest request) throws AuthleteApiException + CredentialSingleIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialSingleIssueResponse.class, request, - VCI_SINGLE_ISSUE_API_PATH, mServiceId)); + VCI_SINGLE_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialBatchParseResponse credentialBatchParse( - CredentialBatchParseRequest request) throws AuthleteApiException + CredentialBatchParseRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialBatchParseResponse.class, request, - VCI_BATCH_PARSE_API_PATH, mServiceId)); + VCI_BATCH_PARSE_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialBatchIssueResponse credentialBatchIssue( - CredentialBatchIssueRequest request) throws AuthleteApiException + CredentialBatchIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialBatchIssueResponse.class, request, - VCI_BATCH_ISSUE_API_PATH, mServiceId)); + VCI_BATCH_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialDeferredParseResponse credentialDeferredParse( - CredentialDeferredParseRequest request) throws AuthleteApiException + CredentialDeferredParseRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialDeferredParseResponse.class, request, - VCI_DEFERRED_PARSE_API_PATH, mServiceId)); + VCI_DEFERRED_PARSE_API_PATH, mServiceId) + .setOptions(options)); } @Override public CredentialDeferredIssueResponse credentialDeferredIssue( - CredentialDeferredIssueRequest request) throws AuthleteApiException + CredentialDeferredIssueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( CredentialDeferredIssueResponse.class, request, - VCI_DEFERRED_ISSUE_API_PATH, mServiceId)); + VCI_DEFERRED_ISSUE_API_PATH, mServiceId) + .setOptions(options)); } @Override public IDTokenReissueResponse idTokenReissue( - IDTokenReissueRequest request) throws AuthleteApiException + IDTokenReissueRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( IDTokenReissueResponse.class, request, - ID_TOKEN_REISSUE_API_PATH, mServiceId)); + ID_TOKEN_REISSUE_API_PATH, mServiceId) + .setOptions(options)); } @Override public AuthorizationTicketInfoResponse authorizationTicketInfo( - AuthorizationTicketInfoRequest request) throws AuthleteApiException + AuthorizationTicketInfoRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( AuthorizationTicketInfoResponse.class, request, - AUTH_AUTHORIZATION_TICKET_INFO_API_PATH, mServiceId)); + AUTH_AUTHORIZATION_TICKET_INFO_API_PATH, mServiceId) + .setOptions(options)); } @Override public AuthorizationTicketUpdateResponse authorizationTicketUpdate( - AuthorizationTicketUpdateRequest request) throws AuthleteApiException + AuthorizationTicketUpdateRequest request, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( AuthorizationTicketUpdateResponse.class, request, - AUTH_AUTHORIZATION_TICKET_UPDATE_API_PATH, mServiceId)); + AUTH_AUTHORIZATION_TICKET_UPDATE_API_PATH, mServiceId) + .setOptions(options)); } @Override public TokenCreateBatchResponse tokenCreateBatch( - TokenCreateRequest[] request, boolean dryRun) throws AuthleteApiException + TokenCreateRequest[] request, boolean dryRun, Options options) throws AuthleteApiException { return executeApiCall( new PostApiCaller( TokenCreateBatchResponse.class, request, TOKEN_CREATE_BATCH_API_PATH, mServiceId) - .addParam("dryRun", dryRun)); + .addParam("dryRun", dryRun) + .setOptions(options)); } @Override public TokenCreateBatchStatusResponse getTokenCreateBatchStatus( - String requestId) throws AuthleteApiException + String requestId, Options options) throws AuthleteApiException { return executeApiCall( new GetApiCaller( TokenCreateBatchStatusResponse.class, - TOKEN_CREATE_BATCH_STATUS_API_PATH, mServiceId, requestId)); + TOKEN_CREATE_BATCH_STATUS_API_PATH, mServiceId, requestId) + .setOptions(options)); } } diff --git a/src/main/java/com/authlete/jakarta/api/AuthleteApiJaxrsImpl.java b/src/main/java/com/authlete/jakarta/api/AuthleteApiJaxrsImpl.java index cfb28ae..001484e 100644 --- a/src/main/java/com/authlete/jakarta/api/AuthleteApiJaxrsImpl.java +++ b/src/main/java/com/authlete/jakarta/api/AuthleteApiJaxrsImpl.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2014-2022 Authlete, Inc. + * Copyright (C) 2014-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,17 +17,21 @@ package com.authlete.jakarta.api; +import static jakarta.ws.rs.core.HttpHeaders.ACCEPT; import static jakarta.ws.rs.core.HttpHeaders.AUTHORIZATION; +import static jakarta.ws.rs.core.HttpHeaders.CONTENT_TYPE; import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON_TYPE; import java.text.ParseException; import java.util.Date; import java.util.List; import java.util.Map; +import java.util.Map.Entry; import java.util.UUID; import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.client.ClientBuilder; import jakarta.ws.rs.client.Entity; import jakarta.ws.rs.client.Invocation; +import jakarta.ws.rs.client.Invocation.Builder; import jakarta.ws.rs.client.ResponseProcessingException; import jakarta.ws.rs.client.WebTarget; import jakarta.ws.rs.core.MediaType; @@ -35,6 +39,7 @@ import jakarta.ws.rs.core.Response.StatusType; import com.authlete.common.api.AuthleteApi; import com.authlete.common.api.AuthleteApiException; +import com.authlete.common.api.Options; import com.authlete.common.api.Settings; import com.authlete.common.conf.AuthleteConfiguration; import com.nimbusds.jose.JOSEException; @@ -406,7 +411,7 @@ private String extractResponseBody(Response response) protected TResponse callGetApi( - String auth, String path, Class responseClass, Map params) + String auth, String path, Class responseClass, Map params, Options options) { WebTarget webTarget = getTarget().path(path); @@ -418,32 +423,41 @@ protected TResponse callGetApi( } } - return wrapWithDpop(webTarget.request(APPLICATION_JSON_TYPE), path, "GET") - .header(AUTHORIZATION, auth) - .get(responseClass); + Builder builder = wrapWithDpop(webTarget.request(APPLICATION_JSON_TYPE), path, "GET") + .header(AUTHORIZATION, auth); + + setCustomRequestHeaders(builder, options); + + return builder.get(responseClass); } - protected Void callDeleteApi(String auth, String path) + protected Void callDeleteApi(String auth, String path, Options options) { - wrapWithDpop(getTarget() + Builder builder = wrapWithDpop(getTarget() .path(path) .request(), path, "DELETE") - .header(AUTHORIZATION, auth) - .delete(); + .header(AUTHORIZATION, auth); + + setCustomRequestHeaders(builder, options); + + builder.delete(); return null; } protected TResponse callPostApi( - String auth, String path, Object request, Class responseClass) + String auth, String path, Object request, Class responseClass, Options options) { - return wrapWithDpop(getTarget() + Builder builder = wrapWithDpop(getTarget() .path(path) .request(APPLICATION_JSON_TYPE), path, "POST") - .header(AUTHORIZATION, auth) - .post(Entity.entity(request, JSON_UTF8_TYPE), responseClass); + .header(AUTHORIZATION, auth); + + setCustomRequestHeaders(builder, options); + + return builder.post(Entity.entity(request, JSON_UTF8_TYPE), responseClass); } @@ -470,4 +484,45 @@ protected boolean isDpopEnabled() { return mDpopJwk != null; } + + + protected void setCustomRequestHeaders(Builder builder, Options options) + { + if (options == null) + { + return; + } + + // Custom request headers. + Map headers = options.getHeaders(); + + if (headers == null) + { + // No custom request header is specified. + return; + } + + // Add each custom request header to the builder. + for (Entry e : headers.entrySet()) + { + // The key of the header. + String key = e.getKey(); + + // Some header keys are reserved. + if (isReservedRequestHeader(key)) + { + continue; + } + + builder.header(key, e.getValue()); + } + } + + + private static boolean isReservedRequestHeader(String key) + { + return key.equalsIgnoreCase(ACCEPT) || + key.equalsIgnoreCase(AUTHORIZATION) || + key.equalsIgnoreCase(CONTENT_TYPE); + } } From 6c85ea23507d0d37b873470efe136b7e4d7ac4c6 Mon Sep 17 00:00:00 2001 From: Hideki Ikeda Date: Fri, 3 Jan 2025 03:30:25 +0900 Subject: [PATCH 2/4] Include options properties in Params classes. --- .../jakarta/AccessTokenValidator.java | 78 +++++---- .../jakarta/AuthorizationDecisionHandler.java | 159 ++++++++++++----- .../BaseAuthorizationDecisionEndpoint.java | 43 +---- .../jakarta/BaseIntrospectionEndpoint.java | 32 +--- .../jakarta/BasePushedAuthReqEndpoint.java | 35 +--- .../jakarta/BaseResourceEndpoint.java | 56 +----- .../authlete/jakarta/BaseTokenEndpoint.java | 58 ++----- .../jakarta/BaseUserInfoEndpoint.java | 64 +------ .../jakarta/IntrospectionRequestHandler.java | 73 ++++---- .../jakarta/PushedAuthReqHandler.java | 71 ++++---- .../authlete/jakarta/TokenRequestHandler.java | 160 +++++++++++++----- .../jakarta/UserInfoRequestHandler.java | 114 +++++++++---- 12 files changed, 474 insertions(+), 469 deletions(-) diff --git a/src/main/java/com/authlete/jakarta/AccessTokenValidator.java b/src/main/java/com/authlete/jakarta/AccessTokenValidator.java index d583897..447e9bc 100644 --- a/src/main/java/com/authlete/jakarta/AccessTokenValidator.java +++ b/src/main/java/com/authlete/jakarta/AccessTokenValidator.java @@ -47,7 +47,7 @@ public class AccessTokenValidator extends BaseHandler */ public static class Params implements Serializable { - private static final long serialVersionUID = 1L; + private static final long serialVersionUID = 2L; private String accessToken; @@ -57,6 +57,7 @@ public static class Params implements Serializable private String dpop; private String htm; private String htu; + private Options options; /** @@ -318,6 +319,39 @@ public Params setHtu(String htu) return this; } + + + /** + * Get the request options for {@code /api/auth/introspection} API. + * + * @return + * The request options for {@code /api/auth/introspection} API. + * + * @since 2.82 + */ + public Options getOptions() + { + return options; + } + + + /** + * Set the request options for {@code /api/auth/introspection} API. + * + * @param options + * The request options for {@code /api/auth/introspection} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setOptions(Options options) + { + this.options = options; + + return this; + } } @@ -493,8 +527,8 @@ public AccessTokenInfo validate( /** - * Validate an access token. This method is an alias of the - * {@link #validate(Params, Options)} method. + * Validate an access token. This method is an alias of the {@link #validate(Params)} + * method. * *

    * When the given access token is not valid, this method throws a @@ -538,7 +572,7 @@ public AccessTokenInfo validate( * presented one does not match. * * - * @since 2.82 + * @since 2.27 */ public AccessTokenInfo validate( String accessToken, String[] requiredScopes, @@ -550,15 +584,15 @@ public AccessTokenInfo validate( .setRequiredScopes(requiredScopes) .setRequiredSubject(requiredSubject) .setClientCertificate(clientCertificate) + .setOptions(options) ; - return validate(params, options); + return validate(params); } /** - * Validate an access token. This method is an alias of - * {@link #validate(Params, Options) validate}{@code (params, null)}. + * Validate an access token. * * @param params * Parameters needed for access token validation. @@ -572,29 +606,6 @@ public AccessTokenInfo validate( * @since 2.27 */ public AccessTokenInfo validate(Params params) throws WebApplicationException - { - return validate(params, null); - } - - - /** - * Validate an access token. - * - * @param params - * Parameters needed for access token validation. - * - * @param options - * Request options for {@code /api/auth/introspection} API. - * - * @return - * Information about the access token. - * - * @throws WebApplicationException - * The access token is invalid. - * - * @since 2.82 - */ - public AccessTokenInfo validate(Params params, Options options) throws WebApplicationException { if (params == null || params.getAccessToken() == null) { @@ -604,7 +615,7 @@ public AccessTokenInfo validate(Params params, Options options) throws WebApplic try { - return process(params, options); + return process(params); } catch (WebApplicationException e) { @@ -681,8 +692,7 @@ public IntrospectionResponse validate( } - - private AccessTokenInfo process(Params params, Options options) throws WebApplicationException + private AccessTokenInfo process(Params params) throws WebApplicationException { // Call Authlete's /api/auth/introspection API. IntrospectionResponse response = getApiCaller().callIntrospection( @@ -693,7 +703,7 @@ private AccessTokenInfo process(Params params, Options options) throws WebApplic params.getDpop(), params.getHtm(), params.getHtu(), - options + params.getOptions() ); // Handle the response from the /auth/introspection API. diff --git a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java index 72b9459..5f3323b 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java @@ -60,7 +60,7 @@ public class AuthorizationDecisionHandler extends BaseHandler */ public static class Params implements Serializable { - private static final long serialVersionUID = 3L; + private static final long serialVersionUID = 4L; private String ticket; @@ -70,6 +70,9 @@ public static class Params implements Serializable private String[] requestedClaimsForTx; private StringArray[] requestedVerifiedClaimsForTx; private boolean oldIdaFormatUsed; + private Options authzOptions; + private Options authzIssueOptions; + private Options authzFailOptions; /** @@ -430,12 +433,111 @@ public Params setOldIdaFormatUsed(boolean used) } + /** + * Get the request options for {@code /api/auth/authorization} API. + * + * @return + * The request options for {@code /api/auth/authorization} API. + * + * @since 2.82 + */ + public Options getAuthzOptions() + { + return authzOptions; + } + + + /** + * Set the request options for {@code /api/auth/authorization} API. + * + * @param options + * The request options for {@code /api/auth/authorization} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setAuthzOptions(Options options) + { + authzOptions = options; + + return this; + } + + + /** + * Get the request options for {@code /api/auth/authorization/issue} API. + * + * @return + * The request options for {@code /api/auth/authorization/issue} API. + * + * @since 2.82 + */ + public Options getAuthzIssueOptions() + { + return authzIssueOptions; + } + + + /** + * Set the request options for {@code /api/auth/authorization/issue} API. + * + * @param options + * The request options for {@code /api/auth/authorization/issue} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setAuthzIssueOptions(Options options) + { + authzIssueOptions = options; + + return this; + } + + + /** + * Get the request options for {@code /api/auth/authorization/fail} API. + * + * @return + * The request options for {@code /api/auth/authorization/fail} API. + * + * @since 2.82 + */ + public Options getAuthzFailOptions() + { + return authzFailOptions; + } + + + /** + * Set the request options for {@code /api/auth/authorization/fail} API. + * + * @param options + * The request options for {@code /api/auth/authorization/fail} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setAuthzFailOptions(Options options) + { + authzFailOptions = options; + + return this; + } + + /** * Create a {@link Params} instance from an instance of * {@link AuthorizationResponse}. * * @param response - * An response from Authlete's {@code /api/auth/authorization} API. + * An response from Authlete's {@code /api/auth/authorization/issue} API. * * @return * A new {@code Params} instance built from the response. @@ -510,7 +612,7 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales /** * Handle an end-user's decision on an authorization request. This method is - * an alias of the {@link #handle(Params, Options, Options)} method. + * an alias of the {@link #handle(Params)} method. * * @param ticket * A ticket that was issued by Authlete's {@code /api/auth/authorization} API. @@ -535,8 +637,6 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales * * @throws WebApplicationException * An error occurred. - * - * @since 2.82 */ public Response handle( String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOpts, @@ -546,15 +646,16 @@ public Response handle( .setTicket(ticket) .setClaimNames(claimNames) .setClaimLocales(claimLocales) + .setAuthzIssueOptions(authzFailOpts) + .setAuthzFailOptions(authzFailOpts) ; - return handle(params, authzIssueOpts, authzFailOpts); + return handle(params); } /** - * Handle an end-user's decision on an authorization request. This method is - * an alias of {@link #handle(Params, Options, Options) handle}{@code (params, null, null)}. + * Handle an end-user's decision on an authorization request. * * @param params * Parameters necessary to handle the decision. @@ -569,39 +670,11 @@ public Response handle( * @since 2.25 */ public Response handle(Params params) throws WebApplicationException - { - return handle(params, null, null); - } - - - /** - * Handle an end-user's decision on an authorization request. - * - * @param params - * Parameters necessary to handle the decision. - * - * @param authzIssueOpts - * Request options for the {@code /api/auth/authorization/issue} API. - * - * @param authzFailOpts - * Request options for the {@code /api/auth/authorization/fail} API. - * - * @return - * A response to the client application. Basically, the response - * will trigger redirection to the client's redirection endpoint. - * - * @throws WebApplicationException - * An error occurred. - * - * @since 2.82 - */ - public Response handle( - Params params, Options authzIssueOpts, Options authzFailOpts) throws WebApplicationException { try { // Process the end-user's decision. - return process(params, authzIssueOpts, authzFailOpts); + return process(params); } catch (WebApplicationException e) { @@ -618,13 +691,13 @@ public Response handle( /** * Process the end-user's decision. */ - private Response process(Params params, Options authzIssueOpts, Options authzFailOpts) + private Response process(Params params) { // If the end-user did not grant authorization to the client application. if (mSpi.isClientAuthorized() == false) { // The end-user denied the authorization request. - return fail(params.getTicket(), Reason.DENIED, authzFailOpts); + return fail(params.getTicket(), Reason.DENIED, params.getAuthzFailOptions()); } // The subject (= unique identifier) of the end-user. @@ -634,7 +707,7 @@ private Response process(Params params, Options authzIssueOpts, Options authzFai if (subject == null || subject.length() == 0) { // The end-user is not authenticated. - return fail(params.getTicket(), Reason.NOT_AUTHENTICATED, authzFailOpts); + return fail(params.getTicket(), Reason.NOT_AUTHENTICATED, params.getAuthzFailOptions()); } // the potentially pairwise subject of the end user @@ -689,7 +762,7 @@ private Response process(Params params, Options authzIssueOpts, Options authzFai // Authorize the authorization request. return authorize(params.getTicket(), subject, authTime, acr, claims, - properties, scopes, sub, claimsForTx, verifiedClaimsForTx, authzIssueOpts); + properties, scopes, sub, claimsForTx, verifiedClaimsForTx, params.getAuthzIssueOptions()); } @@ -1081,7 +1154,7 @@ private VerifiedClaimsCollector createVerifiedClaimsCollector() * {@code verified_claims/claims}. * * @param options - * Request options. + * Request options for {@code /auth/authorization/issue} API. * * @return * A response that should be returned to the client application. @@ -1123,7 +1196,7 @@ private Response authorize( * A reason of the failure of the authorization request. * * @param options - * Request options. + * Request options for {@code /auth/authorization/fail} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java index 9a773d0..0a43e80 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java @@ -109,35 +109,11 @@ public Response handle( .setTicket(ticket) .setClaimNames(claimNames) .setClaimLocales(claimLocales) + .setAuthzIssueOptions(authzFailOpts) + .setAuthzFailOptions(authzFailOpts) ; - return handle(api, spi, params, authzIssueOpts, authzFailOpts); - } - - - /** - * Handle an authorization decision request. This method is an alias of - * {@link #handle(AuthleteApi, AuthorizationDecisionHandlerSpi, Params, Options, - * Options) handle}{@code (api, spi, params, null, null)}. - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @param spi - * An implementation of {@link AuthorizationDecisionHandlerSpi}. - * - * @param params - * Parameters necessary to handle the decision. - * - * @return - * A response that should be returned to the client application. - * - * @since 2.26 - */ - public Response handle( - AuthleteApi api, AuthorizationDecisionHandlerSpi spi, Params params) - { - return handle(api, spi, params, null, null); + return handle(api, spi, params); } @@ -169,20 +145,13 @@ public Response handle( * @param params * Parameters necessary to handle the decision. * - * @param authzIssueOpts - * Request options for the {@code /api/auth/authorization/issue} API. - * - * @param authzFailOpts - * Request options for the {@code /api/auth/authorization/fail} API. - * * @return * A response that should be returned to the client application. * - * @since 2.82 + * @since 2.26 */ public Response handle( - AuthleteApi api, AuthorizationDecisionHandlerSpi spi, Params params, - Options authzIssueOpts, Options authzFailOpts) + AuthleteApi api, AuthorizationDecisionHandlerSpi spi, Params params) { try { @@ -190,7 +159,7 @@ public Response handle( AuthorizationDecisionHandler handler = new AuthorizationDecisionHandler(api, spi); // Delegate the task to the handler. - return handler.handle(params, authzIssueOpts, authzFailOpts); + return handler.handle(params); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java index e775fb0..60ea3e8 100644 --- a/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java @@ -81,34 +81,13 @@ public Response handle( { Params params = new Params() .setParameters(parameters) + .setOptions(options) ; return handle(api, params); } - /** - * Handle an introspection request. This method is an alias of {@link - * #handle(AuthleteApi, IntrospectionRequestHandler.Params, Options) - * handle}{@code (api, params, null)}. - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @param params - * Parameters needed to handle the introspection request. - * - * @return - * A response that should be returned to the resource server. - * - * @since 2.63 - */ - public Response handle(AuthleteApi api, Params params) - { - return handle(api, params, null); - } - - /** * Handle an introspection request. * @@ -138,15 +117,12 @@ public Response handle(AuthleteApi api, Params params) * @param params * Parameters needed to handle the introspection request. * - * @param options - * Request options for the {@code /api/auth/introspection} API. - * * @return * A response that should be returned to the resource server. * - * @since 2.82 + * @since 2.63 */ - public Response handle(AuthleteApi api, Params params, Options options) + public Response handle(AuthleteApi api, Params params) { try { @@ -154,7 +130,7 @@ public Response handle(AuthleteApi api, Params params, Options options) IntrospectionRequestHandler handler = new IntrospectionRequestHandler(api); // Delegate the task to the handler. - return handler.handle(params, options); + return handler.handle(params); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java b/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java index 2aef04c..37ee653 100644 --- a/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java @@ -67,8 +67,7 @@ protected Response handle( /** - * Handle a pushed authorization request. This method is an alias of the {@link - * #handle(AuthleteApi, Params, Options)} method. + * Handle a pushed authorization request. * * @param api * An implementation of {@link AuthleteApi}. @@ -99,9 +98,10 @@ protected Response handle( .setParameters(parameters) .setAuthorization(authorization) .setClientCertificatePath(clientCertificates) + .setOptions(options) ; - return handle(api, params, options); + return handle(api, params); } @@ -109,26 +109,6 @@ protected Response handle( * Handle a PAR request. This method is an alias of the {@link * #handle(AuthleteApi, Params, Options) handle}{@code (api, params, null)}. * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @param params - * Parameters needed to handle the PAR request. - * - * @return - * A response that should be returned to the client application. - * - * @since 2.70 - */ - public Response handle(AuthleteApi api, Params params) - { - return handle(api, params, null); - } - - - /** - * Handle a PAR request. - * *

    * This method internally creates a {@link PushedAuthReqHandler} instance and * calls its {@link PushedAuthReqHandler#handle(PushedAuthReqHandler.Params, Options)} @@ -151,15 +131,12 @@ public Response handle(AuthleteApi api, Params params) * @param params * Parameters needed to handle the PAR request. * - * @param options - * Request options for the {@code /api/pushed_auth_req} API. - * * @return * A response that should be returned to the client application. * - * @since 2.82 + * @since 2.70 */ - public Response handle(AuthleteApi api, Params params, Options options) + public Response handle(AuthleteApi api, Params params) { try { @@ -167,7 +144,7 @@ public Response handle(AuthleteApi api, Params params, Options options) PushedAuthReqHandler handler = new PushedAuthReqHandler(api); // Delegate the task to the handler. - return handler.handle(params, options); + return handler.handle(params); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java b/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java index 8ce143b..0b7227d 100644 --- a/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java @@ -403,17 +403,15 @@ public AccessTokenInfo validateAccessToken( .setRequiredScopes(requiredScopes) .setRequiredSubject(requiredSubject) .setClientCertificate(clientCertificate) + .setOptions(options) ; - return validateAccessToken(api, params, options); + return validateAccessToken(api, params); } /** - * Validate an access token. This method is an alias of {@link - * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params, Options) - * validateAccessToken}{@code (api, params, null)}. - * . + * Validate an access token. * * @param api * Implementation of {@link AuthleteApi} interface. @@ -431,57 +429,11 @@ public AccessTokenInfo validateAccessToken( */ public AccessTokenInfo validateAccessToken( AuthleteApi api, Params params) throws WebApplicationException - { - return validateAccessToken(api, params, null); - } - - - /** - * Validate an access token. - * - *

    - * This method internally creates an {@link AccessTokenValidator} instance - * and calls its {@link AccessTokenValidator#validate(Params) - * validate()} method. Then, this method uses the value returned from the - * {@code validate()} method as a response from this method. - *

    - * - *

    - * When {@code AccessTokenValidator.validate()} method raises a {@link - * WebApplicationException}, this method calls {@link - * #onError(WebApplicationException) onError()} method with the exception. - * The default implementation of {@code onError()} does nothing. You can - * override the method as necessary. After calling {@code onError()} - * method, this method re-throws the exception. The response contained in - * the exception complies with the requirements described in RFC 6750 (The OAuth 2.0 - * Authorization Framework: Bearer Token Usage). - *

    - * - * @param api - * Implementation of {@link AuthleteApi} interface. - * - * @param params - * Parameters needed for access token validation. - * - * @param options - * Request options for {@code /api/auth/introspection} API. - * - * @return - * Information about the access token. - * - * @throws WebApplicationException - * The Access Token is invalid. - * - * @since 2.82 - */ - public AccessTokenInfo validateAccessToken( - AuthleteApi api, Params params, Options options) throws WebApplicationException { try { // Validate the access token and obtain the information about it. - return new AccessTokenValidator(api).validate(params, options); + return new AccessTokenValidator(api).validate(params); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java index 93ef025..26d66bf 100644 --- a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java @@ -192,35 +192,12 @@ public Response handle( .setParameters(parameters) .setAuthorization(authorization) .setClientCertificatePath(clientCertificatePath) + .setTokenOptions(tokenOpts) + .setTokenIssueOptions(tokenIssueOpts) + .setTokenFailOptions(tokenFailOpts) ; - return handle(api, spi, params, tokenOpts, tokenIssueOpts, tokenFailOpts); - } - - - /** - * Handle a token request. This method is an alias of {@link #handle(AuthleteApi, - * TokenRequestHandlerSpi, TokenRequestHandler.Params, Options, Options, Options) - * handle}{@code (api, spi, params, null, null, null)}. - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @param spi - * An implementation of {@link TokenRequestHandlerSpi}. - * - * @param params - * Parameters needed to handle the token request. - * - * @return - * A response that should be returned to the client application. - * - * @since 2.27 - */ - public Response handle( - AuthleteApi api, TokenRequestHandlerSpi spi, Params params) - { - return handle(api, spi, params, null, null, null); + return handle(api, spi, params); } @@ -236,11 +213,12 @@ public Response handle( * *

    * When {@code TokenRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link #onError(WebApplicationException) onError()} - * method with the exception. The default implementation of {@code onError()} - * does nothing. You can override the method as necessary. After calling - * {@code onError()} method, this method calls {@code getResponse()} method of - * the exception and uses the returned value as a response from this method. + * WebApplicationException}, this method calls {@link #onError(WebApplicationException) + * onError()} method with the exception. The default implementation of {@code + * onError()} does nothing. You can override the method as necessary. After + * calling {@code onError()} method, this method calls {@code getResponse()} + * method of the exception and uses the returned value as a response from this + * method. *

    * * @param api @@ -252,23 +230,13 @@ public Response handle( * @param params * Parameters needed to handle the token request. * - * @param tokenOpts - * Request options for the {@code /api/auth/token} API. - * - * @param tokenIssueOpts - * Request options for the {@code /api/auth/token/issue} API. - * - * @param tokenFailOpts - * Request options for the {@code /api/auth/token/fail} API. - * * @return * A response that should be returned to the client application. * - * @since 2.82 + * @since 2.27 */ public Response handle( - AuthleteApi api, TokenRequestHandlerSpi spi, Params params, Options tokenOpts, - Options tokenIssueOpts, Options tokenFailOpts) + AuthleteApi api, TokenRequestHandlerSpi spi, Params params) { try { @@ -276,7 +244,7 @@ public Response handle( TokenRequestHandler handler = new TokenRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(params, tokenOpts, tokenIssueOpts, tokenFailOpts); + return handler.handle(params); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java index 3275c63..48f6904 100644 --- a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016-2022 Authlete, Inc. + * Copyright (C) 2016-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -62,10 +62,9 @@ public Response handle( /** - * Handle a userinfo request. - * - * This method is an alias of the {@link #handle(AuthleteApi, UserInfoRequestHandlerSpi, - * UserInfoRequestHandler.Params)} method. + * Handle a userinfo request. This method is an alias of the {@link + * #handle(AuthleteApi, UserInfoRequestHandlerSpi, UserInfoRequestHandler.Params)} + * method. * * @param api * An implementation of {@link AuthleteApi}. @@ -93,9 +92,11 @@ public Response handle( { Params params = new Params() .setAccessToken(accessToken) + .setUserInfoOptions(userInfoOpts) + .setUserInfoIssueOptions(userInfoIssueOpts) ; - return handle(api, spi, params, userInfoOpts, userInfoIssueOpts); + return handle(api, spi, params); } @@ -136,55 +137,6 @@ public Response handle( */ public Response handle( AuthleteApi api, UserInfoRequestHandlerSpi spi, Params params) - { - return handle(api, spi, params, null, null); - } - - - /** - * Handle a userinfo request. - * - *

    - * This method internally creates a {@link UserInfoRequestHandler} instance - * and calls its - * {@link UserInfoRequestHandler#handle(UserInfoRequestHandler.Params) - * handle(Params)} method. Then, this method uses the value returned from - * the {@code handle()} method as a response from this method. - *

    - * - *

    - * When {@code UserInfoRequestHandler.handle()} method raises a {@link - * WebApplicationException}, this method calls {@link - * #onError(WebApplicationException) onError()} method with the exception. - * The default implementation of {@code onError()} does nothing. You can - * override the method as necessary. After calling {@code onError()} - * method, this method calls {@code getResponse()} method of the exception - * and uses the returned value as a response from this method. - *

    - * - * @param api - * An implementation of {@link AuthleteApi}. - * - * @param spi - * An implementation of {@link UserInfoRequestHandlerSpi}. - * - * @param params - * Parameters needed to handle the userinfo request. - * - * @param userInfoOpts - * Request options for the {@code /api/auth/userinfo} API. - * - * @param userInfoIssueOpts - * Request options for the {@code /api/auth/userinfo/issue} API. - * - * @return - * A response that should be returned to the client application. - * - * @since 2.82 - */ - public Response handle( - AuthleteApi api, UserInfoRequestHandlerSpi spi, Params params, Options userInfoOpts, - Options userInfoIssueOpts) { try { @@ -192,7 +144,7 @@ public Response handle( UserInfoRequestHandler handler = new UserInfoRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(params, userInfoOpts, userInfoIssueOpts); + return handler.handle(params); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java b/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java index 7b765ee..8c90f77 100644 --- a/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java @@ -60,7 +60,7 @@ public class IntrospectionRequestHandler extends BaseHandler */ public static class Params implements Serializable { - private static final long serialVersionUID = 1L; + private static final long serialVersionUID = 2L; private MultivaluedMap parameters; @@ -73,6 +73,7 @@ public static class Params implements Serializable private String sharedKeyForSign; private String sharedKeyForEncryption; private String publicKeyForEncryption; + private Options options; /** @@ -452,6 +453,39 @@ public Params setPublicKeyForEncryption(String key) return this; } + + + /** + * Get the request options for {@code /api/auth/introspection} API. + * + * @return + * The request options for {@code /api/auth/introspection} API. + * + * @since 2.82 + */ + public Options getOptions() + { + return options; + } + + + /** + * Set the request options for {@code /api/auth/introspection} API. + * + * @param options + * The request options for {@code /api/auth/introspection} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setOptions(Options options) + { + this.options = options; + + return this; + } } @@ -491,8 +525,7 @@ public Response handle( /** * Handle an introspection request (RFC 7662). This method is an alias of the {@link #handle(Params, Options)} - * method. + * >RFC 7662). This method is an alias of the {@link #handle(Params)} method. * * @param parameters * Request parameters of an introspection request. @@ -514,16 +547,16 @@ public Response handle( { Params params = new Params() .setParameters(parameters) + .setOptions(options) ; - return handle(params, options); + return handle(params); } /** * Handle an introspection request (RFC 7662). This method is an alias of {@link #handle(Params, Options) - * handle}{@code (params, null)}. + * >RFC 7662). * * @param params * Parameters needed to handle the introspection request. @@ -539,32 +572,6 @@ public Response handle( * @since 2.63 */ public Response handle(Params params) throws WebApplicationException - { - return handle(params, null); - } - - - /** - * Handle an introspection request (RFC 7662). - * - * @param params - * Parameters needed to handle the introspection request. - * Must not be {@code null}. - * - * @param options - * Request options for the {@code /api/auth/introspection/standard} API. - * - * @return - * A response that should be returned from the endpoint to - * the resource server. - * - * @throws WebApplicationException - * An error occurred. - * - * @since 2.82 - */ - public Response handle(Params params, Options options) throws WebApplicationException { try { @@ -580,7 +587,7 @@ public Response handle(Params params, Options options) throws WebApplicationExce params.getSharedKeyForSign(), params.getSharedKeyForEncryption(), params.getPublicKeyForEncryption(), - options + params.getOptions() ); } catch (WebApplicationException e) diff --git a/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java b/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java index a78cbbd..721bb38 100644 --- a/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java +++ b/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java @@ -60,7 +60,7 @@ public class PushedAuthReqHandler extends BaseHandler */ public static class Params implements Serializable { - private static final long serialVersionUID = 1L; + private static final long serialVersionUID = 2L; private MultivaluedMap parameters; @@ -69,6 +69,7 @@ public static class Params implements Serializable private String dpop; private String htm; private String htu; + private Options options; /** @@ -295,6 +296,39 @@ public Params setHtu(String htu) return this; } + + + /** + * Get the request options for {@code /api/pushed_auth_req} API. + * + * @return + * The request options for {@code /api/pushed_auth_req} API. + * + * @since 2.82 + */ + public Options getOptions() + { + return options; + } + + + /** + * Set the request options for {@code /api/pushed_auth_req} API. + * + * @param options + * The request options for {@code /api/pushed_auth_req} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setOptions(Options options) + { + this.options = options; + + return this; + } } @@ -347,7 +381,7 @@ public Response handle( /** * Handle a pushed authorization request. This method is an alias of the {@link - * #handle(Params, Options)} method. + * #handle(Params)} method. * * @param parameters * Request parameters of a pushed authorization request. @@ -384,15 +418,15 @@ public Response handle( .setParameters(parameters) .setAuthorization(authorization) .setClientCertificatePath(clientCertificatePath) + .setOptions(options) ; - return handle(params, options); + return handle(params); } /** - * Handle a PAR request. This method is an alias of {@link #handle(Params, Options) - * handle}{@code (params, null)}. + * Handle a PAR request. * * @param params * Parameters needed to handle the PAR request. @@ -408,31 +442,6 @@ public Response handle( * @since 2.69 */ public Response handle(Params params) - { - return handle(params, null); - } - - - /** - * Handle a PAR request. - * - * @param params - * Parameters needed to handle the PAR request. - * Must not be {@code null}. - * - * @param options - * Request options for the {@code /api/pushed_auth_req} API. - * - * @return - * A response that should be returned from the endpoint to the - * client application. - * - * @throws WebApplicationException - * An error occurred. - * - * @since 2.82 - */ - public Response handle(Params params, Options options) { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -454,7 +463,7 @@ public Response handle(Params params, Options options) params.getDpop(), params.getHtm(), params.getHtu(), - options + params.getOptions() ); } catch (WebApplicationException e) diff --git a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java index a23ad4f..9a350ea 100644 --- a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java @@ -60,7 +60,7 @@ public class TokenRequestHandler extends BaseHandler */ public static class Params implements Serializable { - private static final long serialVersionUID = 1L; + private static final long serialVersionUID = 2L; private MultivaluedMap parameters; @@ -69,6 +69,9 @@ public static class Params implements Serializable private String dpop; private String htm; private String htu; + private Options tokenOptions; + private Options tokenIssueOptions; + private Options tokenFailOptions; /** @@ -289,6 +292,105 @@ public Params setHtu(String htu) return this; } + + + /** + * Get the request options for {@code /api/auth/token} API. + * + * @return + * The request options for {@code /api/auth/token} API. + * + * @since 2.82 + */ + public Options getTokenOptions() + { + return tokenOptions; + } + + + /** + * Set the request options for {@code /api/auth/token} API. + * + * @param options + * The request options for {@code /api/auth/token} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setTokenOptions(Options options) + { + tokenOptions = options; + + return this; + } + + + /** + * Get the request options for {@code /api/auth/token/issue} API. + * + * @return + * The request options for {@code /api/auth/token/issue} API. + * + * @since 2.82 + */ + public Options getTokenIssueOptions() + { + return tokenIssueOptions; + } + + + /** + * Set the request options for {@code /api/auth/token/issue} API. + * + * @param options + * The request options for {@code /api/auth/token/issue} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setTokenIssueOptions(Options options) + { + tokenIssueOptions = options; + + return this; + } + + + /** + * Get the request options for {@code /api/auth/token/fail} API. + * + * @return + * The request options for {@code /api/auth/token/fail} API. + * + * @since 2.82 + */ + public Options getTokenFailOptions() + { + return tokenFailOptions; + } + + + /** + * Set the request options for {@code /api/auth/token/fail} API. + * + * @param options + * The request options for {@code /api/auth/token/fail} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setTokenFailOptions(Options options) + { + tokenFailOptions = options; + + return this; + } } @@ -394,8 +496,9 @@ public Response handle( /** - * Handle a token request. This method is an alias of {@link #handle(MultivaluedMap, String, String[], Options, Options, Options) - * handle}{@code (parameters, authorization, clientCertificatePath, null, null, null)}. + * Handle a token request. This method is an alias of {@link + * #handle(MultivaluedMap, String, String[], Options, Options, Options) handle}{@code + * (parameters, authorization, clientCertificatePath, null, null, null)}. * * @param parameters * Request parameters of a token request. @@ -430,8 +533,8 @@ public Response handle( /** - * Handle a token request. This method is an alias of the {@link #handle(Params, - * Options, Options, Options)} method. + * Handle a token request. This method is an alias of the {@link #handle(Params)} + * method. * * @param parameters * Request parameters of a token request. @@ -475,15 +578,17 @@ public Response handle( .setParameters(parameters) .setAuthorization(authorization) .setClientCertificatePath(clientCertificatePath) + .setTokenOptions(tokenFailOpts) + .setTokenIssueOptions(tokenFailOpts) + .setTokenFailOptions(tokenFailOpts) ; - return handle(params, tokenOpts, tokenIssueOpts, tokenFailOpts); + return handle(params); } /** - * Handle a token request. This method is an alias of the {@link #handle(Params, - * Options, Options, Options) handle}{@code (params, null, null, null)}. + * Handle a token request. * * @param params * Parameters needed to handle the token request. @@ -499,39 +604,6 @@ public Response handle( * @since 2.27 */ public Response handle(Params params) throws WebApplicationException - { - return handle(params, null, null, null); - } - - - /** - * Handle a token request. - * - * @param params - * Parameters needed to handle the token request. - * Must not be {@code null}. - * - * @param tokenOpts - * Request options for the {@code /api/auth/token} API. - * - * @param tokenIssueOpts - * Request options for the {@code /api/auth/token/issue} API. - * - * @param tokenFailOpts - * Request options for the {@code /api/auth/token/fail} API. - * - * @return - * A response that should be returned from the endpoint to the - * client application. - * - * @throws WebApplicationException - * An error occurred. - * - * @since 2.82 - */ - public Response handle( - Params params, Options tokenOpts, Options tokenIssueOpts, Options tokenFailOpts) - throws WebApplicationException { // Convert the value of Authorization header (credentials of // the client application), if any, into BasicCredentials. @@ -553,9 +625,9 @@ public Response handle( params.getDpop(), params.getHtm(), params.getHtu(), - tokenOpts, - tokenIssueOpts, - tokenFailOpts + params.getTokenOptions(), + params.getTokenIssueOptions(), + params.getTokenFailOptions() ); } catch (WebApplicationException e) diff --git a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java index 93c90af..3c82d67 100644 --- a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java @@ -63,7 +63,7 @@ public class UserInfoRequestHandler extends BaseHandler */ public static class Params implements Serializable { - private static final long serialVersionUID = 2L; + private static final long serialVersionUID = 3L; private String accessToken; @@ -72,6 +72,8 @@ public static class Params implements Serializable private String htm; private String htu; private boolean oldIdaFormatUsed; + private Options userInfoOptions; + private Options userInfoIssueOptions; /** @@ -381,6 +383,72 @@ public Params setOldIdaFormatUsed(boolean used) return this; } + + + /** + * Get the request options for {@code /api/auth/userinfo} API. + * + * @return + * The request options for {@code /api/auth/userinfo} API. + * + * @since 2.82 + */ + public Options getUserInfoOptions() + { + return userInfoOptions; + } + + + /** + * Set the request options for {@code /api/auth/userinfo} API. + * + * @param options + * The request options for {@code /api/auth/userinfo} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setUserInfoOptions(Options options) + { + userInfoOptions = options; + + return this; + } + + + /** + * Get the request options for {@code /api/auth/userinfo/issue} API. + * + * @return + * The request options for {@code /api/auth/userinfo/issue} API. + * + * @since 2.82 + */ + public Options getUserInfoIssueOptions() + { + return userInfoIssueOptions; + } + + + /** + * Set the request options for {@code /api/auth/userinfo/issue} API. + * + * @param options + * The request options for {@code /api/auth/userinfo/issue} API. + * + * @return + * {@code this} object. + * + * @since 2.82 + */ + public Params setUserInfoIssueOptions(Options options) + { + userInfoIssueOptions = options; + + return this; + } } @@ -470,29 +538,11 @@ public Response handle( { Params params = new Params() .setAccessToken(accessToken) + .setUserInfoOptions(userInfoOpts) + .setUserInfoIssueOptions(userInfoIssueOpts) ; - return handle(params, userInfoOpts, userInfoIssueOpts); - } - - - /** - * Handle a userinfo request. This method is an alias of {@link #handle(Params, Options, Options) - * handle}{@code (params, null, null)}. - * - * @param params - * Parameters needed to handle the userinfo request. - * - * @return - * A response that should be returned from the endpoint to the - * client application. - * - * @throws WebApplicationException - * An error occurred. - */ - public Response handle(Params params) throws WebApplicationException - { - return handle(params, null, null); + return handle(params); } @@ -502,24 +552,14 @@ public Response handle(Params params) throws WebApplicationException * @param params * Parameters needed to handle the userinfo request. * - * @param userInfoOpts - * Request options for the {@code /api/auth/userinfo} API. - * - * @param userInfoIssueOpts - * Request options for the {@code /api/auth/userinfo/issue} API. - * * @return * A response that should be returned from the endpoint to the * client application. * * @throws WebApplicationException * An error occurred. - * - * @since 2.82 */ - public Response handle( - Params params, Options userInfoOpts, Options userInfoIssueOpts) - throws WebApplicationException + public Response handle(Params params) throws WebApplicationException { // If an access token is not available. if (params == null || params.getAccessToken() == null) @@ -532,7 +572,7 @@ public Response handle( try { // Process the userinfo request. - return process(params, userInfoOpts, userInfoIssueOpts); + return process(params); } catch (WebApplicationException e) { @@ -549,7 +589,7 @@ public Response handle( /** * Process the userinfo request with the access token. */ - private Response process(Params params, Options userInfoOpts, Options userInfoIssueOpts) + private Response process(Params params) { // Call Authlete's /api/auth/userinfo API. UserInfoResponse response = getApiCaller().callUserInfo( @@ -558,7 +598,7 @@ private Response process(Params params, Options userInfoOpts, Options userInfoIs params.getDpop(), params.getHtm(), params.getHtu(), - userInfoOpts + params.getUserInfoOptions() ); // 'action' in the response denotes the next action which @@ -592,7 +632,7 @@ private Response process(Params params, Options userInfoOpts, Options userInfoIs case OK: // Return the user information. - return getUserInfo(params, response, headers, userInfoIssueOpts); + return getUserInfo(params, response, headers, params.getUserInfoIssueOptions()); default: // This never happens. From a7e51927849eb8da284c4fe80e009d013460cc63 Mon Sep 17 00:00:00 2001 From: Hideki Ikeda Date: Fri, 3 Jan 2025 16:13:46 +0900 Subject: [PATCH 3/4] Rename some parameters. --- .../jakarta/AuthorizationDecisionHandler.java | 12 ++--- .../jakarta/AuthorizationRequestHandler.java | 31 ++++++------- .../BaseAuthorizationDecisionEndpoint.java | 18 ++++---- .../jakarta/BaseAuthorizationEndpoint.java | 12 ++--- .../authlete/jakarta/BaseTokenEndpoint.java | 32 +++++++------- .../jakarta/BaseUserInfoEndpoint.java | 10 ++--- .../authlete/jakarta/TokenRequestHandler.java | 44 +++++++++---------- .../jakarta/UserInfoRequestHandler.java | 14 +++--- 8 files changed, 87 insertions(+), 86 deletions(-) diff --git a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java index 5f3323b..2d3ac73 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java @@ -625,10 +625,10 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales * Requested claim locales. Use the value of the {@code claimsLocales} * parameter in a response from Authlete's {@code /api/auth/authorization} API. * - * @param authzIssueOpts + * @param authzIssueOptions * Request options for the {@code /api/auth/authorization/issue} API. * - * @param authzFailOpts + * @param authzFailOptions * Request options for the {@code /api/auth/authorization/fail} API. * * @return @@ -639,15 +639,15 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales * An error occurred. */ public Response handle( - String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOpts, - Options authzFailOpts) throws WebApplicationException + String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOptions, + Options authzFailOptions) throws WebApplicationException { Params params = new Params() .setTicket(ticket) .setClaimNames(claimNames) .setClaimLocales(claimLocales) - .setAuthzIssueOptions(authzFailOpts) - .setAuthzFailOptions(authzFailOpts) + .setAuthzIssueOptions(authzFailOptions) + .setAuthzFailOptions(authzFailOptions) ; return handle(params); diff --git a/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java index 7e7b009..7ee071c 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java @@ -102,13 +102,13 @@ public Response handle(MultivaluedMap parameters) throws WebAppl * @param parameters * Request parameters of an authorization request. * - * @param authzOpts + * @param authzOptions * Request options for the {@code /api/auth/authorization} API. * - * @param authzIssueOpts + * @param authzIssueOptions * Request options for the {@code /api/auth/authorization/issue} API. * - * @param authzFailOpts + * @param authzFailOptions * Request options for the {@code /api/auth/authorization/fail} API. * * @return @@ -121,13 +121,13 @@ public Response handle(MultivaluedMap parameters) throws WebAppl * @since 2.82 */ public Response handle( - MultivaluedMap parameters, Options authzOpts, - Options authzIssueOpts, Options authzFailOpts) throws WebApplicationException + MultivaluedMap parameters, Options authzOptions, + Options authzIssueOptions, Options authzFailOptions) throws WebApplicationException { try { // Process the given parameters. - return process(parameters, authzOpts, authzIssueOpts, authzFailOpts); + return process(parameters, authzOptions, authzIssueOptions, authzFailOptions); } catch (WebApplicationException e) { @@ -145,10 +145,11 @@ public Response handle( * Process the authorization request. */ private Response process( - MultivaluedMap parameters, Options authzOpts, Options authzIssueOpts, Options authzFailOpts) + MultivaluedMap parameters, Options authzOptions, + Options authzIssueOptions, Options authzFailOptions) { // Call Authlete's /api/auth/authorization API. - AuthorizationResponse response = getApiCaller().callAuthorization(parameters, authzOpts); + AuthorizationResponse response = getApiCaller().callAuthorization(parameters, authzOptions); // 'action' in the response denotes the next action which // this service implementation should take. @@ -185,7 +186,7 @@ private Response process( // Process the authorization request without user interaction. // The flow reaches here only when the authorization request // contained prompt=none. - return handleNoInteraction(response, authzIssueOpts, authzFailOpts); + return handleNoInteraction(response, authzIssueOptions, authzFailOptions); default: // This never happens. @@ -209,16 +210,16 @@ private Response handleInteraction(AuthorizationResponse response) * Authlete's {@code /api/auth/authorization} API is {@code NO_INTERACTION}. */ private Response handleNoInteraction( - AuthorizationResponse response, Options authzIssueOpts, Options authzFailOpts) + AuthorizationResponse response, Options authzIssueOptions, Options authzFailOptions) { // Check 1. End-User Authentication - noInteractionCheckAuthentication(response, authzFailOpts); + noInteractionCheckAuthentication(response, authzFailOptions); // Get the time when the user was authenticated. long authTime = mSpi.getUserAuthenticatedAt(); // Check 2. Max Age - noInteractionCheckMaxAge(response, authTime, authzFailOpts); + noInteractionCheckMaxAge(response, authTime, authzFailOptions); // The current subject, i.e. the unique ID assigned by // the service to the current user. @@ -228,14 +229,14 @@ private Response handleNoInteraction( String sub = mSpi.getSub(); // Check 3. Subject - noInteractionCheckSubject(response, subject, authzFailOpts); + noInteractionCheckSubject(response, subject, authzFailOptions); // Get the ACR that was satisfied when the current user // was authenticated. String acr = mSpi.getAcr(); // Check 4. ACR - noInteractionCheckAcr(response, acr, authzFailOpts); + noInteractionCheckAcr(response, acr, authzFailOptions); // Extra properties to associate with an access token and/or // an authorization code. @@ -248,7 +249,7 @@ private Response handleNoInteraction( String[] scopes = mSpi.getScopes(); // Issue - return noInteractionIssue(response, authTime, subject, acr, properties, scopes, sub, authzIssueOpts); + return noInteractionIssue(response, authTime, subject, acr, properties, scopes, sub, authzIssueOptions); } diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java index 0a43e80..1e696d5 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java @@ -89,10 +89,10 @@ public Response handle( * Requested claim locales. Use the value of the {@code claimsLocales} * parameter in a response from Authlete's {@code /api/auth/authorization} API. * - * @param authzIssueOpts + * @param authzIssueOptions * Request options for the {@code /api/auth/authorization/issue} API. * - * @param authzFailOpts + * @param authzFailOptions * Request options for the {@code /api/auth/authorization/fail} API. * * @return @@ -102,15 +102,15 @@ public Response handle( */ public Response handle( AuthleteApi api, AuthorizationDecisionHandlerSpi spi, - String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOpts, - Options authzFailOpts) + String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOptions, + Options authzFailOptions) { Params params = new Params() .setTicket(ticket) .setClaimNames(claimNames) .setClaimLocales(claimLocales) - .setAuthzIssueOptions(authzFailOpts) - .setAuthzFailOptions(authzFailOpts) + .setAuthzIssueOptions(authzFailOptions) + .setAuthzFailOptions(authzFailOptions) ; return handle(api, spi, params); @@ -122,9 +122,9 @@ public Response handle( * *

    * This method internally creates a {@link AuthorizationDecisionHandler} instance and - * calls its {@link AuthorizationDecisionHandler#handle(Params, Options, Options)} - * method. Then, this method uses the value returned from the {@code handle()} method - * as a response from this method. + * calls its {@link AuthorizationDecisionHandler#handle(Params)} method. Then, + * this method uses the value returned from the {@code handle()} method as a + * response from this method. *

    * *

    diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java index 1ed1b9e..29ebba8 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java @@ -99,13 +99,13 @@ public Response handle( * @param parameters * Request parameters of the authorization request. * - * @param authzOpts + * @param authzOptions * Request options for the {@code /api/auth/authorization} API. * - * @param authzIssueOpts + * @param authzIssueOptions * Request options for the {@code /api/auth/authorization/issue} API. * - * @param authzFailOpts + * @param authzFailOptions * Request options for the {@code /api/auth/authorization/fail} API. * * @return @@ -115,8 +115,8 @@ public Response handle( */ public Response handle( AuthleteApi api, AuthorizationRequestHandlerSpi spi, - MultivaluedMap parameters, Options authzOpts, - Options authzIssueOpts, Options authzFailOpts) + MultivaluedMap parameters, Options authzOptions, + Options authzIssueOptions, Options authzFailOptions) { try { @@ -124,7 +124,7 @@ public Response handle( AuthorizationRequestHandler handler = new AuthorizationRequestHandler(api, spi); // Delegate the task to the handler. - return handler.handle(parameters, authzOpts, authzIssueOpts, authzFailOpts); + return handler.handle(parameters, authzOptions, authzIssueOptions, authzFailOptions); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java index 26d66bf..e9134a2 100644 --- a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java @@ -72,7 +72,7 @@ public Response handle( /** * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi, * TokenRequestHandlerSpi, MultivaluedMap, String, String[], Options) handle}{@code - * (api, spi, parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts)}. + * (api, spi, parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -86,13 +86,13 @@ public Response handle( * @param authorization * The value of {@code Authorization} header of the token request. * - * @param tokenOpts + * @param tokenOptions * Request options for the {@code /api/auth/token} API. * - * @param tokenIssueOpts + * @param tokenIssueOptions * Request options for the {@code /api/auth/token/issue} API. * - * @param tokenFailOpts + * @param tokenFailOptions * Request options for the {@code /api/auth/token/fail} API. * * @return @@ -103,10 +103,10 @@ public Response handle( public Response handle( AuthleteApi api, TokenRequestHandlerSpi spi, MultivaluedMap parameters, String authorization, - Options tokenOpts, Options tokenIssueOpts, Options tokenFailOpts) + Options tokenOptions, Options tokenIssueOptions, Options tokenFailOptions) { return handle( - api, spi, parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts); + api, spi, parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions); } @@ -148,7 +148,7 @@ public Response handle( /** * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi, - * TokenRequestHandlerSpi, TokenRequestHandler.Params, Options, Options, Options)} + * TokenRequestHandlerSpi, TokenRequestHandler.Params)} * method. * * @param api @@ -168,13 +168,13 @@ public Response handle( * PEM format. The client's own certificate is the first in this * array. Can be {@code null}. * - * @param tokenOpts + * @param tokenOptions * Request options for the {@code /api/auth/token} API. * - * @param tokenIssueOpts + * @param tokenIssueOptions * Request options for the {@code /api/auth/token/issue} API. * - * @param tokenFailOpts + * @param tokenFailOptions * Request options for the {@code /api/auth/token/fail} API. * * @return @@ -185,16 +185,16 @@ public Response handle( public Response handle( AuthleteApi api, TokenRequestHandlerSpi spi, MultivaluedMap parameters, String authorization, - String[] clientCertificatePath, Options tokenOpts, Options tokenIssueOpts, - Options tokenFailOpts) + String[] clientCertificatePath, Options tokenOptions, Options tokenIssueOptions, + Options tokenFailOptions) { Params params = new Params() .setParameters(parameters) .setAuthorization(authorization) .setClientCertificatePath(clientCertificatePath) - .setTokenOptions(tokenOpts) - .setTokenIssueOptions(tokenIssueOpts) - .setTokenFailOptions(tokenFailOpts) + .setTokenOptions(tokenOptions) + .setTokenIssueOptions(tokenIssueOptions) + .setTokenFailOptions(tokenFailOptions) ; return handle(api, spi, params); @@ -206,7 +206,7 @@ public Response handle( * *

    * This method internally creates a {@link TokenRequestHandler} instance and - * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params, Options)} + * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params)} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    diff --git a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java index 48f6904..c576cf9 100644 --- a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java @@ -75,10 +75,10 @@ public Response handle( * @param accessToken * An access token. * - * @param userInfoOpts + * @param userInfoOptions * Request options for the {@code /api/auth/userinfo} API. * - * @param userInfoIssueOpts + * @param userInfoIssueOptions * Request options for the {@code /api/auth/userinfo/issue} API. * * @return @@ -88,12 +88,12 @@ public Response handle( */ public Response handle( AuthleteApi api, UserInfoRequestHandlerSpi spi, String accessToken, - Options userInfoOpts, Options userInfoIssueOpts) + Options userInfoOptions, Options userInfoIssueOptions) { Params params = new Params() .setAccessToken(accessToken) - .setUserInfoOptions(userInfoOpts) - .setUserInfoIssueOptions(userInfoIssueOpts) + .setUserInfoOptions(userInfoOptions) + .setUserInfoIssueOptions(userInfoIssueOptions) ; return handle(api, spi, params); diff --git a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java index 9a350ea..c7ac227 100644 --- a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java @@ -456,7 +456,7 @@ public Response handle( /** * Handle a token request. This method is an alias of {@link * #handle(MultivaluedMap, String, String[], Options, Options, Options) handle}{@code - * (parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts)}. + * (parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions)}. * * @param parameters * Request parameters of a token request. @@ -468,13 +468,13 @@ public Response handle( * "https://tools.ietf.org/html/rfc2617#section-2">Basic * Authentication. * - * @param tokenOpts + * @param tokenOptions * Request options for the {@code /api/auth/token} API. * - * @param tokenIssueOpts + * @param tokenIssueOptions * Request options for the {@code /api/auth/token/issue} API. * - * @param tokenFailOpts + * @param tokenFailOptions * Request options for the {@code /api/auth/token/fail} API. * * @return @@ -488,10 +488,10 @@ public Response handle( */ public Response handle( MultivaluedMap parameters, String authorization, - Options tokenOpts, Options tokenIssueOpts, Options tokenFailOpts) + Options tokenOptions, Options tokenIssueOptions, Options tokenFailOptions) throws WebApplicationException { - return handle(parameters, authorization, null, tokenOpts, tokenIssueOpts, tokenFailOpts); + return handle(parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions); } @@ -551,13 +551,13 @@ public Response handle( * item in the array is the client's certificate itself. May be {@code null} if * the client did not send a certificate or path. * - * @param tokenOpts + * @param tokenOptions * Request options for the {@code /api/auth/token} API. * - * @param tokenIssueOpts + * @param tokenIssueOptions * Request options for the {@code /api/auth/token/issue} API. * - * @param tokenFailOpts + * @param tokenFailOptions * Request options for the {@code /api/auth/token/fail} API. * * @return @@ -571,16 +571,16 @@ public Response handle( */ public Response handle( MultivaluedMap parameters, String authorization, - String[] clientCertificatePath, Options tokenOpts, Options tokenIssueOpts, - Options tokenFailOpts) throws WebApplicationException + String[] clientCertificatePath, Options tokenOptions, Options tokenIssueOptions, + Options tokenFailOptions) throws WebApplicationException { Params params = new Params() .setParameters(parameters) .setAuthorization(authorization) .setClientCertificatePath(clientCertificatePath) - .setTokenOptions(tokenFailOpts) - .setTokenIssueOptions(tokenFailOpts) - .setTokenFailOptions(tokenFailOpts) + .setTokenOptions(tokenFailOptions) + .setTokenIssueOptions(tokenFailOptions) + .setTokenFailOptions(tokenFailOptions) ; return handle(params); @@ -648,8 +648,8 @@ public Response handle(Params params) throws WebApplicationException private Response process( MultivaluedMap parameters, String clientId, String clientSecret, String[] clientCertificatePath, - String dpop, String htm, String htu, Options tokenOpts, Options tokenIssueOpts, - Options tokenFailOpts) + String dpop, String htm, String htu, Options tokenOptions, Options tokenIssueOptions, + Options tokenFailOptions) { // Extra properties to associate with an access token. Property[] properties = mSpi.getProperties(); @@ -671,7 +671,7 @@ private Response process( // Call Authlete's /api/auth/token API. TokenResponse response = getApiCaller().callToken( parameters, clientId, clientSecret, properties, - clientCertificate, clientCertificatePath, dpop, htm, htu, tokenOpts); + clientCertificate, clientCertificatePath, dpop, htm, htu, tokenOptions); // 'action' in the response denotes the next action which // this service implementation should take. @@ -700,7 +700,7 @@ private Response process( case PASSWORD: // Process the token request whose flow is "Resource Owner Password Credentials". - return handlePassword(response, headers, tokenIssueOpts, tokenFailOpts); + return handlePassword(response, headers, tokenIssueOptions, tokenFailOptions); case OK: // 200 OK @@ -746,8 +746,8 @@ private static Map prepareHeaders(TokenResponse response) * Process the token request whose flow is "Resource Owner Password Credentials". */ private Response handlePassword( - TokenResponse response, Map headers, Options tokenIssueOpts, - Options tokenFailOpts) + TokenResponse response, Map headers, Options tokenIssueOptions, + Options tokenFailOptions) { // The credentials of the resource owner. String username = response.getUsername(); @@ -766,14 +766,14 @@ private Response handlePassword( { // Issue an access token and optionally an ID token. return getApiCaller().tokenIssue( - ticket, subject, properties, headers, tokenIssueOpts); + ticket, subject, properties, headers, tokenIssueOptions); } else { // The credentials are invalid. An access token is not issued. throw getApiCaller().tokenFail( ticket, Reason.INVALID_RESOURCE_OWNER_CREDENTIALS, headers, - tokenFailOpts); + tokenFailOptions); } } diff --git a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java index 3c82d67..1227b2e 100644 --- a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java @@ -511,16 +511,16 @@ public Response handle(String accessToken) throws WebApplicationException * "http://openid.net/specs/openid-connect-core-1_0.html#UserInfo" * >UserInfo Endpoint defined in OpenID Connect - * Core 1.0. This method is an alias of the {@link - * #handle(Params, Options, Options)} method. + * Core 1.0. This method is an alias of the {@link #handle(Params)} + * method. * * @param accessToken * An access token. * - * @param userInfoOpts + * @param userInfoOptions * Request options for the {@code /api/auth/userinfo} API. * - * @param userInfoIssueOpts + * @param userInfoIssueOptions * Request options for the {@code /api/auth/userinfo/issue} API. * * @return @@ -533,13 +533,13 @@ public Response handle(String accessToken) throws WebApplicationException * @since 2.82 */ public Response handle( - String accessToken, Options userInfoOpts, Options userInfoIssueOpts) + String accessToken, Options userInfoOptions, Options userInfoIssueOptions) throws WebApplicationException { Params params = new Params() .setAccessToken(accessToken) - .setUserInfoOptions(userInfoOpts) - .setUserInfoIssueOptions(userInfoIssueOpts) + .setUserInfoOptions(userInfoOptions) + .setUserInfoIssueOptions(userInfoIssueOptions) ; return handle(params); From 2789bc7548b754cffd4cbdfd590b52edde11bba7 Mon Sep 17 00:00:00 2001 From: Hideki Ikeda Date: Fri, 3 Jan 2025 17:28:10 +0900 Subject: [PATCH 4/4] Modify some comments. --- .../jakarta/AccessTokenValidator.java | 16 +++---- .../jakarta/AuthorizationDecisionHandler.java | 36 +++++++------- .../jakarta/AuthorizationRequestHandler.java | 10 ++-- ...lAuthenticationCompleteRequestHandler.java | 10 ++-- ...ckchannelAuthenticationRequestHandler.java | 10 ++-- .../BaseAuthorizationDecisionEndpoint.java | 10 ++-- .../jakarta/BaseAuthorizationEndpoint.java | 14 +++--- ...BaseBackchannelAuthenticationEndpoint.java | 16 +++---- .../BaseClientRegistrationEndpoint.java | 17 ++++--- .../jakarta/BaseConfigurationEndpoint.java | 17 +++---- .../BaseCredentialIssuerMetadataEndpoint.java | 16 +++---- ...seCredentialJwtIssuerMetadataEndpoint.java | 16 +++---- .../BaseDeviceAuthorizationEndpoint.java | 8 ++-- .../jakarta/BaseDeviceCompleteEndpoint.java | 4 +- .../BaseDeviceVerificationEndpoint.java | 7 +-- .../BaseFederationConfigurationEndpoint.java | 14 +++--- .../BaseFederationRegistrationEndpoint.java | 11 +++-- .../jakarta/BaseGrantManagementEndpoint.java | 4 +- .../jakarta/BaseIntrospectionEndpoint.java | 10 ++-- .../authlete/jakarta/BaseJwksEndpoint.java | 8 ++-- .../jakarta/BasePushedAuthReqEndpoint.java | 30 ++++++------ .../jakarta/BaseResourceEndpoint.java | 13 +++-- .../jakarta/BaseRevocationEndpoint.java | 10 ++-- .../authlete/jakarta/BaseTokenEndpoint.java | 25 +++++----- .../jakarta/BaseUserInfoEndpoint.java | 6 +-- .../ClientRegistrationRequestHandler.java | 18 +++---- .../jakarta/ConfigurationRequestHandler.java | 10 ++-- ...redentialIssuerMetadataRequestHandler.java | 6 +-- ...entialJwtIssuerMetadataRequestHandler.java | 4 +- .../DeviceAuthorizationRequestHandler.java | 14 +++--- .../jakarta/DeviceCompleteRequestHandler.java | 4 +- .../DeviceVerificationRequestHandler.java | 4 +- ...FederationConfigurationRequestHandler.java | 2 +- .../FederationRegistrationRequestHandler.java | 2 +- .../authlete/jakarta/GMRequestHandler.java | 4 +- .../jakarta/IntrospectionRequestHandler.java | 14 +++--- .../authlete/jakarta/JwksRequestHandler.java | 4 +- .../jakarta/PushedAuthReqHandler.java | 48 +++++++++---------- .../jakarta/RevocationRequestHandler.java | 6 +-- .../authlete/jakarta/TokenRequestHandler.java | 44 ++++++++--------- .../jakarta/UserInfoRequestHandler.java | 26 +++++----- 41 files changed, 278 insertions(+), 270 deletions(-) diff --git a/src/main/java/com/authlete/jakarta/AccessTokenValidator.java b/src/main/java/com/authlete/jakarta/AccessTokenValidator.java index 447e9bc..f5d7ce1 100644 --- a/src/main/java/com/authlete/jakarta/AccessTokenValidator.java +++ b/src/main/java/com/authlete/jakarta/AccessTokenValidator.java @@ -322,10 +322,10 @@ public Params setHtu(String htu) /** - * Get the request options for {@code /api/auth/introspection} API. + * Get the request options for the {@code /api/auth/introspection} API. * * @return - * The request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @since 2.82 */ @@ -336,10 +336,10 @@ public Options getOptions() /** - * Set the request options for {@code /api/auth/introspection} API. + * Set the request options for the {@code /api/auth/introspection} API. * * @param options - * The request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * {@code this} object. @@ -399,7 +399,7 @@ public AccessTokenInfo validate(String accessToken) throws WebApplicationExcepti * An access token to validate. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. @@ -459,7 +459,7 @@ public AccessTokenInfo validate( * {@code null} is okay. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. @@ -555,7 +555,7 @@ public AccessTokenInfo validate( * Can be {@code null} if no certificate is presented. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. @@ -660,7 +660,7 @@ public IntrospectionResponse validate(IntrospectionRequest request) throws WebAp * The request parameters to Authlete's {@code /auth/introspection} API. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * The response from the Authlete's {@code /auth/introspection} API. diff --git a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java index 2d3ac73..810f75d 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationDecisionHandler.java @@ -434,10 +434,10 @@ public Params setOldIdaFormatUsed(boolean used) /** - * Get the request options for {@code /api/auth/authorization} API. + * Get the request options for the {@code /api/auth/authorization} API. * * @return - * The request options for {@code /api/auth/authorization} API. + * The request options for the {@code /api/auth/authorization} API. * * @since 2.82 */ @@ -448,10 +448,10 @@ public Options getAuthzOptions() /** - * Set the request options for {@code /api/auth/authorization} API. + * Set the request options for the {@code /api/auth/authorization} API. * * @param options - * The request options for {@code /api/auth/authorization} API. + * The request options for the {@code /api/auth/authorization} API. * * @return * {@code this} object. @@ -467,10 +467,10 @@ public Params setAuthzOptions(Options options) /** - * Get the request options for {@code /api/auth/authorization/issue} API. + * Get the request options for the {@code /api/auth/authorization/issue} API. * * @return - * The request options for {@code /api/auth/authorization/issue} API. + * The request options for the {@code /api/auth/authorization/issue} API. * * @since 2.82 */ @@ -481,10 +481,10 @@ public Options getAuthzIssueOptions() /** - * Set the request options for {@code /api/auth/authorization/issue} API. + * Set the request options for the {@code /api/auth/authorization/issue} API. * * @param options - * The request options for {@code /api/auth/authorization/issue} API. + * The request options for the {@code /api/auth/authorization/issue} API. * * @return * {@code this} object. @@ -500,10 +500,10 @@ public Params setAuthzIssueOptions(Options options) /** - * Get the request options for {@code /api/auth/authorization/fail} API. + * Get the request options for the {@code /api/auth/authorization/fail} API. * * @return - * The request options for {@code /api/auth/authorization/fail} API. + * The request options for the {@code /api/auth/authorization/fail} API. * * @since 2.82 */ @@ -514,10 +514,10 @@ public Options getAuthzFailOptions() /** - * Set the request options for {@code /api/auth/authorization/fail} API. + * Set the request options for the {@code /api/auth/authorization/fail} API. * * @param options - * The request options for {@code /api/auth/authorization/fail} API. + * The request options for the {@code /api/auth/authorization/fail} API. * * @return * {@code this} object. @@ -537,7 +537,7 @@ public Params setAuthzFailOptions(Options options) * {@link AuthorizationResponse}. * * @param response - * An response from Authlete's {@code /api/auth/authorization/issue} API. + * An response from Authlete's {@code /api/auth/authorization} API. * * @return * A new {@code Params} instance built from the response. @@ -626,10 +626,10 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales * parameter in a response from Authlete's {@code /api/auth/authorization} API. * * @param authzIssueOptions - * Request options for the {@code /api/auth/authorization/issue} API. + * The request options for the {@code /api/auth/authorization/issue} API. * * @param authzFailOptions - * Request options for the {@code /api/auth/authorization/fail} API. + * The request options for the {@code /api/auth/authorization/fail} API. * * @return * A response to the client application. Basically, the response @@ -637,6 +637,8 @@ public Response handle(String ticket, String[] claimNames, String[] claimLocales * * @throws WebApplicationException * An error occurred. + * + * @since 2.82 */ public Response handle( String ticket, String[] claimNames, String[] claimLocales, Options authzIssueOptions, @@ -1154,7 +1156,7 @@ private VerifiedClaimsCollector createVerifiedClaimsCollector() * {@code verified_claims/claims}. * * @param options - * Request options for {@code /auth/authorization/issue} API. + * The request options for the {@code /auth/authorization/issue} API. * * @return * A response that should be returned to the client application. @@ -1196,7 +1198,7 @@ private Response authorize( * A reason of the failure of the authorization request. * * @param options - * Request options for {@code /auth/authorization/fail} API. + * The request options for the {@code /auth/authorization/fail} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java b/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java index 7ee071c..e2502b1 100644 --- a/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/AuthorizationRequestHandler.java @@ -79,7 +79,7 @@ public AuthorizationRequestHandler(AuthleteApi api, AuthorizationRequestHandlerS * handle}{@code (parameters, null, null, null)}. * * @param parameters - * Request parameters of an authorization request. + * The request parameters of an authorization request. * * @return * A response that should be returned from the endpoint to the client @@ -100,16 +100,16 @@ public Response handle(MultivaluedMap parameters) throws WebAppl * of OAuth 2.0 (RFC 6749). * * @param parameters - * Request parameters of an authorization request. + * The request parameters of an authorization request. * * @param authzOptions - * Request options for the {@code /api/auth/authorization} API. + * The request options for the {@code /api/auth/authorization} API. * * @param authzIssueOptions - * Request options for the {@code /api/auth/authorization/issue} API. + * The request options for the {@code /api/auth/authorization/issue} API. * * @param authzFailOptions - * Request options for the {@code /api/auth/authorization/fail} API. + * The request options for the {@code /api/auth/authorization/fail} API. * * @return * A response that should be returned from the endpoint to the diff --git a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java index 7116819..9d18151 100644 --- a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationCompleteRequestHandler.java @@ -115,7 +115,7 @@ public void handle(String ticket, String[] claimNames) throws WebApplicationExce * API. * * @param options - * Request options for the {@code /api/backchannel/authentication/complete} API. + * The request options for the {@code /api/backchannel/authentication/complete} API. * * @throws WebApplicationException * An error occurred. @@ -225,8 +225,8 @@ private BackchannelAuthenticationCompleteResponse complete(String ticket, String /** - * Call Authlete's {@code /api/backchannel/authentication/complete} API with an unsuccessful - * result. + * Call Authlete's {@code /api/backchannel/authentication/complete} API with + * an unsuccessful result. * * @param ticket * A ticket that was issued by Authlete's {@code /api/backchannel/authentication} @@ -245,7 +245,7 @@ private BackchannelAuthenticationCompleteResponse complete(String ticket, String * The URI of a document which describes the error in detail. * * @param options - * Request options for the {@code /api/backchannel/authentication/complete} API. + * The request options for the {@code /api/backchannel/authentication/complete} API. * * @return * A response from Authlete's {@code /api/backchannel/authentication/complete} @@ -293,7 +293,7 @@ private BackchannelAuthenticationCompleteResponse fail( * Extra properties to associate with an access token. * * @param options - * Request options for the {@code /api/backchannel/authentication/complete} API. + * The request options for the {@code /api/backchannel/authentication/complete} API. * * @param scopes * Scopes to associate with an access token. If {@code null} is given, diff --git a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java index 4d7db07..dd31d52 100644 --- a/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/BackchannelAuthenticationRequestHandler.java @@ -88,7 +88,7 @@ public BackchannelAuthenticationRequestHandler( * handle}{@code (parameters, authorization, clientCertificatePath, null, null, null)}. * * @param parameters - * Request parameters of a backchannel authentication request. + * The request parameters of a backchannel authentication request. * * @param authorization * The value of {@code Authorization} header in the backchannel authentication @@ -122,7 +122,7 @@ public Response handle( * endpoint of CIBA (Client Initiated Backchannel Authentication). * * @param parameters - * Request parameters of a backchannel authentication request. + * The request parameters of a backchannel authentication request. * * @param authorization * The value of {@code Authorization} header in the backchannel authentication @@ -137,13 +137,13 @@ public Response handle( * if the client did not send a certificate or path. * * @param bcAuthOptions - * Request options for the {@code /api/backchannel/authentication} API. + * The request options for the {@code /api/backchannel/authentication} API. * * @param bcAuthIssueOptions - * Request options for the {@code /api/backchannel/authentication/issue} API. + * The request options for the {@code /api/backchannel/authentication/issue} API. * * @param bcAuthFailOptions - * Request options for the {@code /api/backchannel/authentication/fail} API. + * The request options for the {@code /api/backchannel/authentication/fail} API. * * @return * A response that should be returned from the endpoint to the diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java index 1e696d5..5591d40 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationDecisionEndpoint.java @@ -90,10 +90,10 @@ public Response handle( * parameter in a response from Authlete's {@code /api/auth/authorization} API. * * @param authzIssueOptions - * Request options for the {@code /api/auth/authorization/issue} API. + * The request options for the {@code /api/auth/authorization/issue} API. * * @param authzFailOptions - * Request options for the {@code /api/auth/authorization/fail} API. + * The request options for the {@code /api/auth/authorization/fail} API. * * @return * A response that should be returned to the client application. @@ -122,9 +122,9 @@ public Response handle( * *

    * This method internally creates a {@link AuthorizationDecisionHandler} instance and - * calls its {@link AuthorizationDecisionHandler#handle(Params)} method. Then, - * this method uses the value returned from the {@code handle()} method as a - * response from this method. + * calls its {@link AuthorizationDecisionHandler#handle(Params) handle()} method. + * Then, this method uses the value returned from the {@code handle()} method + * as a response from this method. *

    * *

    diff --git a/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java index 29ebba8..00af0c1 100644 --- a/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseAuthorizationEndpoint.java @@ -58,7 +58,7 @@ public class BaseAuthorizationEndpoint extends BaseEndpoint * An implementation of {@link AuthorizationRequestHandlerSpi}. * * @param parameters - * Request parameters of the authorization request. + * The request parameters of the authorization request. * * @return * A response that should be returned to the client application. @@ -77,8 +77,8 @@ public Response handle( *

    * This method internally creates a {@link AuthorizationRequestHandler} instance and * calls its {@link AuthorizationRequestHandler#handle(MultivaluedMap, Options, - * Options, Options)} method. Then, this method uses the value returned from - * the {@code handle()} method as a response from this method. + * Options, Options) handle()} method. Then, this method uses the value returned + * from the {@code handle()} method as a response from this method. *

    * *

    @@ -97,16 +97,16 @@ public Response handle( * An implementation of {@link AuthorizationRequestHandlerSpi}. * * @param parameters - * Request parameters of the authorization request. + * The request parameters of the authorization request. * * @param authzOptions - * Request options for the {@code /api/auth/authorization} API. + * The request options for the {@code /api/auth/authorization} API. * * @param authzIssueOptions - * Request options for the {@code /api/auth/authorization/issue} API. + * The request options for the {@code /api/auth/authorization/issue} API. * * @param authzFailOptions - * Request options for the {@code /api/auth/authorization/fail} API. + * The request options for the {@code /api/auth/authorization/fail} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java index 2d5c4e6..94ae6b9 100644 --- a/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseBackchannelAuthenticationEndpoint.java @@ -48,7 +48,7 @@ public class BaseBackchannelAuthenticationEndpoint extends BaseEndpoint * An implementation of {@link BackchannelAuthenticationRequestHandlerSpi}. * * @param parameters - * Request parameters of the backchannel authentication request. + * The request parameters of the backchannel authentication request. * * @param authorization * The value of {@code Authorization} header of the backchannel authentication @@ -76,9 +76,9 @@ public Response handle( * *

    * This method internally creates a {@link BackchannelAuthenticationRequestHandler} - * instance and calls its {@link BackchannelAuthenticationRequestHandler#handle(MultivaluedMap, String, String[])} - * method. Then, this method uses the value returned from the {@code handle()} - * method as a response from this method. + * instance and calls its {@link BackchannelAuthenticationRequestHandler#handle(MultivaluedMap, String, String[]) + * handle()} method. Then, this method uses the value returned from the {@code + * handle()} method as a response from this method. *

    * *

    @@ -97,7 +97,7 @@ public Response handle( * An implementation of {@link BackchannelAuthenticationRequestHandlerSpi}. * * @param parameters - * Request parameters of the backchannel authentication request. + * The request parameters of the backchannel authentication request. * * @param authorization * The value of {@code Authorization} header of the backchannel authentication @@ -108,13 +108,13 @@ public Response handle( * client's own certificate is the first in this array. Can be {@code null}. * * @param bcAuthOptions - * Request options for the {@code /api/backchannel/authentication} API. + * The request options for the {@code /api/backchannel/authentication} API. * * @param bcAuthIssueOptions - * Request options for the {@code /api/backchannel/authentication/issue} API. + * The request options for the {@code /api/backchannel/authentication/issue} API. * * @param bcAuthFailOptions - * Request options for the {@code /api/backchannel/authentication/fail} API. + * The request options for the {@code /api/backchannel/authentication/fail} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java index 46e3341..3197b95 100644 --- a/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseClientRegistrationEndpoint.java @@ -70,8 +70,7 @@ public Response handleRegister( * *

    * This method internally creates a {@link ClientRegistrationRequestHandler} - * instance and calls its - * {@link ClientRegistrationRequestHandler#handleRegister(String, String, Options)} + * instance and calls its {@link ClientRegistrationRequestHandler#handleRegister(String, String, Options) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -96,7 +95,7 @@ public Response handleRegister( * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. @@ -160,7 +159,7 @@ public Response handleGet( * *

    * This method internally creates a {@link ClientRegistrationRequestHandler} - * instance and calls its {@link ClientRegistrationRequestHandler#handleGet(String, String, Options)} + * instance and calls its {@link ClientRegistrationRequestHandler#handleGet(String, String, Options) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -189,7 +188,7 @@ public Response handleGet( * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. @@ -258,7 +257,7 @@ public Response handleUpdate( *

    * This method internally creates a {@link ClientRegistrationRequestHandler} * instance and calls its - * {@link ClientRegistrationRequestHandler#handleUpdate(String, String, String)} + * {@link ClientRegistrationRequestHandler#handleUpdate(String, String, String) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -290,7 +289,7 @@ public Response handleUpdate( * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. @@ -356,7 +355,7 @@ public Response handleDelete( *

    * This method internally creates a {@link ClientRegistrationRequestHandler} * instance and calls its - * {@link ClientRegistrationRequestHandler#handleDelete(String, String)} + * {@link ClientRegistrationRequestHandler#handleDelete(String, String) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -385,7 +384,7 @@ public Response handleDelete( * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java index 542a2dc..4c01eca 100644 --- a/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseConfigurationEndpoint.java @@ -74,7 +74,7 @@ public class BaseConfigurationEndpoint extends BaseEndpoint { /** * Handle a request for OpenID Provider configuration. This method is an alias - * of the {@link #handle(AuthleteApi, Options)} method. + * of {@link #handle(AuthleteApi, Options) handle}{@code (api, (Options)null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -111,7 +111,7 @@ public Response handle(AuthleteApi api) * An implementation of {@link AuthleteApi}. * * @param options - * Request options for the {@code /api/service/configuration} API. + * The request options for the {@code /api/service/configuration} API. * * @return * A response that should be returned to the client application. @@ -141,14 +141,15 @@ public Response handle(AuthleteApi api, Options options) /** * Handle a request for OpenID Provider configuration. This method is an alias - * of the {@link #handle(AuthleteApi, ServiceConfigurationRequest, Options)} - * method. + * of {@link #handle(AuthleteApi, ServiceConfigurationRequest, Options) handle}{@code + * (api, request, null)}. * * @param api * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /service/configuration} API. + * The request parameters for Authlete's {@code /service/configuration} + * API. * * @return * A response that should be returned from the discovery endpoint. @@ -167,7 +168,7 @@ public Response handle(AuthleteApi api, ServiceConfigurationRequest request) *

    * This method internally creates a {@link ConfigurationRequestHandler} * instance and calls its - * {@link ConfigurationRequestHandler#handle(ServiceConfigurationRequest, Options)} + * {@link ConfigurationRequestHandler#handle(ServiceConfigurationRequest, Options) handle()} * method. Then, this method uses the value returned from the method as a response * from this method. *

    @@ -185,11 +186,11 @@ public Response handle(AuthleteApi api, ServiceConfigurationRequest request) * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/service/configuration} + * The request parameters for Authlete's {@code /api/service/configuration} * API. * * @param options - * Request options for the {@code /api/service/configuration} API. + * The request options for the {@code /api/service/configuration} API. * * @return * A response that should be returned from the discovery endpoint. diff --git a/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java b/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java index 9d4a332..f9498d9 100644 --- a/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseCredentialIssuerMetadataEndpoint.java @@ -57,7 +57,7 @@ public class BaseCredentialIssuerMetadataEndpoint extends BaseEndpoint { /** * Handle a request to the credential issuer metadata endpoint. This method is - * an alias of the {@link #handle(AuthleteApi, Options)} method. + * an alias of {@link #handle(AuthleteApi, Options) handle}{@code (api, (Options)null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -81,7 +81,7 @@ public Response handle(AuthleteApi api) * An implementation of {@link AuthleteApi}. * * @param options - * Request options for the {@code /api/vci/metadata} API. + * The request options for the {@code /api/vci/metadata} API. * * @return * A response that should be returned from the credential issuer @@ -97,14 +97,14 @@ public Response handle(AuthleteApi api, Options options) /** * Handle a request to the credential issuer metadata endpoint. This method - * is an alias of the {@link #handle(AuthleteApi, CredentialIssuerMetadataRequest, - * Options)} method. + * is an alias of {@link #handle(AuthleteApi, CredentialIssuerMetadataRequest, + * Options) handle}{@code (api, request, null)}. * * @param api * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/vci/metadata} API. + * The request parameters for Authlete's {@code /api/vci/metadata} API. * * @return * A response that should be returned from the credential issuer @@ -122,7 +122,7 @@ public Response handle(AuthleteApi api, CredentialIssuerMetadataRequest request) *

    * This method internally creates a {@link CredentialIssuerMetadataRequestHandler} * instance and calls its {@link CredentialIssuerMetadataRequestHandler#handle(CredentialIssuerMetadataRequest, - * Options)} method. Then, this method uses the value returned from the handler's + * Options) handle()} method. Then, this method uses the value returned from the handler's * method as a response from this method. *

    * @@ -139,10 +139,10 @@ public Response handle(AuthleteApi api, CredentialIssuerMetadataRequest request) * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/vci/metadata} API. + * The request parameters for Authlete's {@code /api/vci/metadata} API. * * @param options - * Request options for the {@code /api/vci/metadata} API. + * The request options for the {@code /api/vci/metadata} API. * * @return * A response that should be returned from the credential issuer diff --git a/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java b/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java index 554716b..ef3d553 100644 --- a/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseCredentialJwtIssuerMetadataEndpoint.java @@ -53,7 +53,7 @@ public class BaseCredentialJwtIssuerMetadataEndpoint extends BaseEndpoint { /** * Handle a request to the JWT issuer metadata endpoint. This method is an alias - * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest)} method. + * of the {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest)} method. * * @param api * An implementation of {@link AuthleteApi}. @@ -70,14 +70,14 @@ public Response handle(AuthleteApi api) /** * Handle a request to the JWT issuer metadata endpoint. This method is an alias - * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest, Options)} + * of the {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest, Options)} * method. * * @param api * An implementation of {@link AuthleteApi}. * * @param options - * Request options for the {@code /api/vci/jwtissuer} API. + * The request options for the {@code /api/vci/jwtissuer} API. * * @return * A response that should be returned from the JWT issuer @@ -93,8 +93,8 @@ public Response handle(AuthleteApi api, Options options) /** * Handle a request to the JWT issuer metadata endpoint. This method is an alias - * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest, CredentialJwtIssuerMetadataRequest, - * Options)} method. + * of {@link #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest, Options)}{@code + * handle(api, request, null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -115,7 +115,7 @@ public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest reque *

    * This method internally creates a {@link CredentialJwtIssuerMetadataRequestHandler} * instance and calls its {@link - * CredentialJwtIssuerMetadataRequestHandler#handle(CredentialJwtIssuerMetadataRequest, Options)} + * CredentialJwtIssuerMetadataRequestHandler#handle(CredentialJwtIssuerMetadataRequest, Options) handle()} * method. Then, this method uses the value returned from the handler's method * as a response from this method. *

    @@ -133,10 +133,10 @@ public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest reque * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/vci/jwtissuer} API. + * The request parameters for Authlete's {@code /api/vci/jwtissuer} API. * * @param options - * Request options for the {@code /api/vci/jwtissuer} API. + * The request options for the {@code /api/vci/jwtissuer} API. * * @return * A response that should be returned from the JWT issuer diff --git a/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java index 13d9ce0..60bc6fa 100644 --- a/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseDeviceAuthorizationEndpoint.java @@ -45,7 +45,7 @@ public class BaseDeviceAuthorizationEndpoint extends BaseEndpoint * An implementation of {@link DeviceAuthorizationRequestHandlerSpi}. * * @param parameters - * Request parameters of the device authorization request. + * The request parameters of the device authorization request. * * @param authorization * The value of {@code Authorization} header of the device authorization @@ -73,7 +73,7 @@ public Response handle( *

    * This method internally creates a {@link DeviceAuthorizationRequestHandler} * instance and calls its {@link - * DeviceAuthorizationRequestHandler#handle(MultivaluedMap, String, String[], Options)} + * DeviceAuthorizationRequestHandler#handle(MultivaluedMap, String, String[], Options) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -95,7 +95,7 @@ public Response handle( * An implementation of {@link DeviceAuthorizationRequestHandlerSpi}. * * @param parameters - * Request parameters of the device authorization request. + * The request parameters of the device authorization request. * * @param authorization * The value of {@code Authorization} header of the device authorization @@ -107,7 +107,7 @@ public Response handle( * {@code null}. * * @param options - * Request options for the {@code /api/device/authorization} API. + * The request options for the device authorization request. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java b/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java index faee98e..d2f35b4 100644 --- a/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseDeviceCompleteEndpoint.java @@ -68,7 +68,7 @@ public Response handle( * *

    * This method internally creates a {@link DeviceCompleteRequestHandler} instance and - * calls its {@link DeviceCompleteRequestHandler#handle(String, String[], Options)} + * calls its {@link DeviceCompleteRequestHandler#handle(String, String[], Options) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -96,7 +96,7 @@ public Response handle( * parameter in a response from Authlete's {@code /api/device/verification} API. * * @param options - * Request options for the {@code /api/device/authorization/complete} API. + * The request options for the {@code /api/device/authorization/complete} API. * * @return * A response that should be returned to the end-user. diff --git a/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java index 24ce3b8..8a827e9 100644 --- a/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseDeviceVerificationEndpoint.java @@ -35,7 +35,8 @@ public class BaseDeviceVerificationEndpoint extends BaseEndpoint { /** * Handle a device verification request. This method is an alias of {@link - * #handle(AuthleteApi, DeviceVerificationRequestHandlerSpi, Options)} method. + * #handle(AuthleteApi, DeviceVerificationRequestHandlerSpi, Options) handle}{@code + * (api, spi, null)}. * * @param api * An implementation of {@link AuthleteApi}. @@ -57,7 +58,7 @@ public Response handle(AuthleteApi api, DeviceVerificationRequestHandlerSpi spi) * *

    * This method internally creates a {@link DeviceVerificationRequestHandler} - * instance and calls its {@link DeviceVerificationRequestHandler#handle(Options)} + * instance and calls its {@link DeviceVerificationRequestHandler#handle(Options) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -78,7 +79,7 @@ public Response handle(AuthleteApi api, DeviceVerificationRequestHandlerSpi spi) * An implementation of {@link DeviceVerificationRequestHandlerSpi}. * * @param options - * Request options for the {@code /api/device/authorization/verification} API. + * The request options for the {@code /api/device/authorization/verification} API. * * @return * A response that should be returned to the end-user. diff --git a/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java index 6576605..97c6d6e 100644 --- a/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseFederationConfigurationEndpoint.java @@ -60,7 +60,7 @@ public class BaseFederationConfigurationEndpoint extends BaseEndpoint { /** * Handle a request to the entity configuration endpoint. This method is an alias - * of {@link #handle(AuthleteApi, FederationConfigurationRequest)} method. + * of the {@link #handle(AuthleteApi, FederationConfigurationRequest)} method. * * @param api * An implementation of {@link AuthleteApi}. @@ -77,14 +77,14 @@ public Response handle(AuthleteApi api) /** * Handle a request to the entity configuration endpoint. This method is an - * alias of {@link #handle(AuthleteApi, FederationConfigurationRequest, Options)} + * alias of the {@link #handle(AuthleteApi, FederationConfigurationRequest, Options)} * method. * * @param api * An implementation of {@link AuthleteApi}. * * @param options - * Request options for the {@code /api/federation/configuration} API. + * The request options for the {@code /api/federation/configuration} API. * * @return * A response that should be returned from the entity configuration @@ -107,7 +107,7 @@ public Response handle(AuthleteApi api, Options options) * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/federation/configuration} API. + * The request parameters for Authlete's {@code /api/federation/configuration} API. * * @return * A response that should be returned from the entity configuration @@ -125,7 +125,7 @@ public Response handle(AuthleteApi api, FederationConfigurationRequest request) *

    * This method internally creates a {@link FederationConfigurationRequestHandler} * instance and calls its {@link - * FederationConfigurationRequestHandler#handle(FederationConfigurationRequest, Options)} + * FederationConfigurationRequestHandler#handle(FederationConfigurationRequest, Options) handle()} * method. Then, this method uses the value returned from the handler's method * as a response from this method. *

    @@ -143,10 +143,10 @@ public Response handle(AuthleteApi api, FederationConfigurationRequest request) * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/federation/configuration} API. + * The request parameters for Authlete's {@code /api/federation/configuration} API. * * @param options - * Request options for the {@code /api/federation/configuration} API. + * The request options for the {@code /api/federation/configuration} API. * * @return * A response that should be returned from the entity configuration diff --git a/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java index ff3895e..e405f87 100644 --- a/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseFederationRegistrationEndpoint.java @@ -83,13 +83,14 @@ public class BaseFederationRegistrationEndpoint extends BaseEndpoint { /** * Handle a request to the federation registration endpoint. This method is an alias - * of {@link #handle(AuthleteApi, FederationRegistrationRequest, Options)} method. + * of {@link #handle(AuthleteApi, FederationRegistrationRequest, Options) handle}{@code + * (api, request, null)}. * * @param api * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/federation/registration} API. + * The request parameters for Authlete's {@code /api/federation/registration} API. * * @return * A response that should be returned from the federation @@ -107,7 +108,7 @@ public Response handle(AuthleteApi api, FederationRegistrationRequest request) *

    * This method internally creates a {@link FederationRegistrationRequestHandler} * instance and calls its {@link - * FederationRegistrationRequestHandler#handle(FederationRegistrationRequest, Options)} + * FederationRegistrationRequestHandler#handle(FederationRegistrationRequest, Options) handle()} * method. Then, this method uses the value returned from the handler's method * as a response from this method. *

    @@ -125,10 +126,10 @@ public Response handle(AuthleteApi api, FederationRegistrationRequest request) * An implementation of {@link AuthleteApi}. * * @param request - * Request parameters for Authlete's {@code /api/federation/registration} API. + * The request parameters for Authlete's {@code /api/federation/registration} API. * * @param options - * Request options for the {@code /api/federation/configuration} API. + * The request options for the {@code /api/federation/registration} API. * * @return * A response that should be returned from the federation diff --git a/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java b/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java index e36f97d..edb224a 100644 --- a/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseGrantManagementEndpoint.java @@ -39,7 +39,7 @@ public class BaseGrantManagementEndpoint extends BaseResourceEndpoint { /** * Handle a grant management request. This method is an alias of {@link - * #handle(AuthleteApi, HttpServletRequest, String, Options)}{@code + * #handle(AuthleteApi, HttpServletRequest, String, Options) handle}{@code * (api, req, grantId, null)}. * * @param api @@ -86,7 +86,7 @@ public Response handle( * endpoint. The last part of the path of the URL. * * @param options - * Request options for the {@code /api/gm} API. + * The request options for the {@code /api/gm} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java b/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java index 60ea3e8..03a0ec8 100644 --- a/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseIntrospectionEndpoint.java @@ -47,7 +47,7 @@ public class BaseIntrospectionEndpoint extends BaseEndpoint * An implementation of {@link AuthleteApi}. * * @param parameters - * Request parameters of an introspection request. + * The request parameters of an introspection request. * * @return * A response that should be returned to the resource server. @@ -60,16 +60,16 @@ public Response handle(AuthleteApi api, MultivaluedMap parameter /** * Handle an introspection request. This method is an alias of the {@link - * #handle(AuthleteApi, IntrospectionRequestHandler.Params, Options)} method. + * #handle(AuthleteApi, IntrospectionRequestHandler.Params)} method. * * @param api * An implementation of {@link AuthleteApi}. * * @param parameters - * Request parameters of an introspection request. + * The request parameters of an introspection request. * * @param options - * Request options for the {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * A response that should be returned to the resource server. @@ -94,7 +94,7 @@ public Response handle( *

    * This method internally creates an {@link IntrospectionRequestHandler} * instance and calls its {@link - * IntrospectionRequestHandler#handle(IntrospectionRequestHandler.Params, Options)} + * IntrospectionRequestHandler#handle(IntrospectionRequestHandler.Params) handle()} * method with the {@code params} argument. Then, this * method uses the value returned from the {@code handle()} method * as a response from this method. diff --git a/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java b/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java index c082f42..4f386f1 100644 --- a/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseJwksEndpoint.java @@ -73,9 +73,9 @@ public Response handle(AuthleteApi api) * *

    * This method internally creates a {@link JwksRequestHandler} instance and - * calls its {@link JwksRequestHandler#handle()} method. Then, this method - * uses the value returned from the {@code handle()} method as a response - * from this method. + * calls its {@link JwksRequestHandler#handle(Options) handle()} method. Then, + * this method uses the value returned from the {@code handle()} method as a + * response from this method. *

    * *

    @@ -92,7 +92,7 @@ public Response handle(AuthleteApi api) * An implementation of {@link AuthleteApi}. * * @param options - * Request options for the {@code /api/service/jwks/get} API. + * The request options for the {@code /api/service/jwks/get} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java b/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java index 37ee653..99b6c63 100644 --- a/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BasePushedAuthReqEndpoint.java @@ -43,17 +43,17 @@ public class BasePushedAuthReqEndpoint extends BaseEndpoint * (api, parameters, authorization, clientCertificates, null)}. * * @param api - * An implementation of {@link AuthleteApi}. + * An implementation of {@link AuthleteApi}. * * @param parameters - * Request parameters of the pushed authorization request. + * The request parameters of the pushed authorization request. * * @param authorization - * The value of {@code Authorization} header of the pushed authorization request. + * The value of {@code Authorization} header of the pushed authorization request. * * @param clientCertificates - * The certificate path used in mutual TLS authentication, in PEM format. The - * client's own certificate is the first in this array. Can be {@code null}. + * The certificate path used in mutual TLS authentication, in PEM format. The + * client's own certificate is the first in this array. Can be {@code null}. * * @return * A response that should be returned to the client application. @@ -67,23 +67,24 @@ protected Response handle( /** - * Handle a pushed authorization request. + * Handle a pushed authorization request. This method is an alias of {@link + * #handle(AuthleteApi, Params) handle}{@code (api, params)}. * * @param api - * An implementation of {@link AuthleteApi}. + * An implementation of {@link AuthleteApi}. * * @param parameters - * Request parameters of the pushed authorization request. + * The request parameters of the pushed authorization request. * * @param authorization - * The value of {@code Authorization} header of the pushed authorization request. + * The value of {@code Authorization} header of the pushed authorization request. * * @param clientCertificates - * The certificate path used in mutual TLS authentication, in PEM format. The - * client's own certificate is the first in this array. Can be {@code null}. + * The certificate path used in mutual TLS authentication, in PEM format. The + * client's own certificate is the first in this array. Can be {@code null}. * * @param options - * Request options for the {@code /api/pushed_auth_req} API. + * The request options for the {@code /api/pushed_auth_req} API. * * @return * A response that should be returned to the client application. @@ -106,12 +107,11 @@ protected Response handle( /** - * Handle a PAR request. This method is an alias of the {@link - * #handle(AuthleteApi, Params, Options) handle}{@code (api, params, null)}. + * Handle a PAR request. * *

    * This method internally creates a {@link PushedAuthReqHandler} instance and - * calls its {@link PushedAuthReqHandler#handle(PushedAuthReqHandler.Params, Options)} + * calls its {@link PushedAuthReqHandler#handle(PushedAuthReqHandler.Params) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    diff --git a/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java b/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java index 0b7227d..1b2916b 100644 --- a/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseResourceEndpoint.java @@ -123,7 +123,7 @@ public AccessTokenInfo validateAccessToken( * An access token to validate. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. @@ -191,7 +191,7 @@ public AccessTokenInfo validateAccessToken( * {@code null} is okay. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. @@ -275,7 +275,7 @@ public AccessTokenInfo validateAccessToken( * with the access token. {@code null} is okay. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. @@ -351,9 +351,8 @@ public AccessTokenInfo validateAccessToken( /** - * Validate an access token. This method is an alias of {@link - * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params, Options)} - * method. + * Validate an access token. This method is an alias of the {@link + * #validateAccessToken(AuthleteApi, AccessTokenValidator.Params)} method. * * @param api * Implementation of {@link AuthleteApi} interface. @@ -375,7 +374,7 @@ public AccessTokenInfo validateAccessToken( * Can be {@code null} if no certificate is presented. * * @param options - * Request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * Information about the access token. diff --git a/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java b/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java index 45e190b..3e1d04a 100644 --- a/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseRevocationEndpoint.java @@ -47,7 +47,7 @@ public class BaseRevocationEndpoint extends BaseEndpoint * An implementation of {@link AuthleteApi}. * * @param parameters - * Request parameters of a revocation request. + * The request parameters of a revocation request. * * @param authorization * The value of {@code Authorization} header. @@ -67,8 +67,8 @@ public Response handle( * *

    * This method internally creates a {@link RevocationRequestHandler} instance - * and calls its {@link RevocationRequestHandler#handle(MultivaluedMap, String, Options)} - * method with the {@code parameters} argument and the {@code authorization} + * and calls its {@link RevocationRequestHandler#handle(MultivaluedMap, String, Options) + * handle()} method with the {@code parameters} argument and the {@code authorization} * argument. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    @@ -87,13 +87,13 @@ public Response handle( * An implementation of {@link AuthleteApi}. * * @param parameters - * Request parameters of a revocation request. + * The request parameters of a revocation request. * * @param authorization * The value of {@code Authorization} header. * * @param options - * Request options for {@code /api/auth/revocation} API. + * The request options for the {@code /api/auth/revocation} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java index e9134a2..4c3c244 100644 --- a/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseTokenEndpoint.java @@ -53,7 +53,7 @@ public class BaseTokenEndpoint extends BaseEndpoint * An implementation of {@link TokenRequestHandlerSpi}. * * @param parameters - * Request parameters of the token request. + * The request parameters of the token request. * * @param authorization * The value of {@code Authorization} header of the token request. @@ -81,19 +81,19 @@ public Response handle( * An implementation of {@link TokenRequestHandlerSpi}. * * @param parameters - * Request parameters of the token request. + * The request parameters of the token request. * * @param authorization * The value of {@code Authorization} header of the token request. * * @param tokenOptions - * Request options for the {@code /api/auth/token} API. + * The request options for the {@code /api/auth/token} API. * * @param tokenIssueOptions - * Request options for the {@code /api/auth/token/issue} API. + * The request options for the {@code /api/auth/token/issue} API. * * @param tokenFailOptions - * Request options for the {@code /api/auth/token/fail} API. + * The request options for the {@code /api/auth/token/fail} API. * * @return * A response that should be returned to the client application. @@ -122,7 +122,7 @@ public Response handle( * An implementation of {@link TokenRequestHandlerSpi}. * * @param parameters - * Request parameters of the token request. + * The request parameters of the token request. * * @param authorization * The value of {@code Authorization} header of the token request. @@ -148,8 +148,7 @@ public Response handle( /** * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi, - * TokenRequestHandlerSpi, TokenRequestHandler.Params)} - * method. + * TokenRequestHandlerSpi, TokenRequestHandler.Params)} method. * * @param api * An implementation of {@link AuthleteApi}. @@ -158,7 +157,7 @@ public Response handle( * An implementation of {@link TokenRequestHandlerSpi}. * * @param parameters - * Request parameters of the token request. + * The request parameters of the token request. * * @param authorization * The value of {@code Authorization} header of the token request. @@ -169,13 +168,13 @@ public Response handle( * array. Can be {@code null}. * * @param tokenOptions - * Request options for the {@code /api/auth/token} API. + * The request options for the {@code /api/auth/token} API. * * @param tokenIssueOptions - * Request options for the {@code /api/auth/token/issue} API. + * The request options for the {@code /api/auth/token/issue} API. * * @param tokenFailOptions - * Request options for the {@code /api/auth/token/fail} API. + * The request options for the {@code /api/auth/token/fail} API. * * @return * A response that should be returned to the client application. @@ -206,7 +205,7 @@ public Response handle( * *

    * This method internally creates a {@link TokenRequestHandler} instance and - * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params)} + * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params) handle()} * method. Then, this method uses the value returned from the {@code handle()} * method as a response from this method. *

    diff --git a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java index c576cf9..a369da1 100644 --- a/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java +++ b/src/main/java/com/authlete/jakarta/BaseUserInfoEndpoint.java @@ -76,10 +76,10 @@ public Response handle( * An access token. * * @param userInfoOptions - * Request options for the {@code /api/auth/userinfo} API. + * The request options for the {@code /api/auth/userinfo} API. * * @param userInfoIssueOptions - * Request options for the {@code /api/auth/userinfo/issue} API. + * The request options for the {@code /api/auth/userinfo/issue} API. * * @return * A response that should be returned to the client application. @@ -107,7 +107,7 @@ public Response handle( * This method internally creates a {@link UserInfoRequestHandler} instance * and calls its * {@link UserInfoRequestHandler#handle(UserInfoRequestHandler.Params) - * handle(Params)} method. Then, this method uses the value returned from + * handle()} method. Then, this method uses the value returned from * the {@code handle()} method as a response from this method. *

    * diff --git a/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java b/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java index 8b3fbfc..55bb08e 100644 --- a/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/ClientRegistrationRequestHandler.java @@ -91,7 +91,8 @@ public ClientRegistrationRequestHandler(AuthleteApi api) /** * Handle a dynamic client registration request. This method is an alias of - * {@link #handleRegister(String, String, Options)}{@code (json, authorization, null)}. + * {@link #handleRegister(String, String, Options) handleRegister}{@code + * (json, authorization, null)}. * * @param json * The serialized JSON body of the client registration request. @@ -123,7 +124,7 @@ public Response handleRegister(String json, String authorization) * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. @@ -156,7 +157,7 @@ public Response handleRegister(String json, String authorization, Options option /** * Handle a dynamic client management GET request. This method is an alias of - * the {@link #handleGet(String, String, Options)}{@code (clientId, authorization, null)}. + * the {@link #handleGet(String, String, Options) handleGet}{@code (clientId, authorization, null)}. * * @param clientId * The client ID as determined by the incoming request. @@ -188,7 +189,7 @@ public Response handleGet(String clientId, String authorization) * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. @@ -221,7 +222,8 @@ public Response handleGet(String clientId, String authorization, Options options /** * Handle a dynamic client management PUT request. This method is an alias of - * {@link #handleUpdate(String, String, String, Options)}{@code (clientId, json, authorization, null)}. + * {@link #handleUpdate(String, String, String, Options) handleUpdate}{@code + * (clientId, json, authorization, null)}. * * @param clientId * The client ID as determined by the incoming request. @@ -259,7 +261,7 @@ public Response handleUpdate(String clientId, String json, String authorization) * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. @@ -293,7 +295,7 @@ public Response handleUpdate( /** * Handle a dynamic client management DELETE request. This method is an alias - * of {@link #handleDelete(String, String, Options)}{@code (clientId, authorization, null)}. + * of {@link #handleDelete(String, String, Options) handleDelete}{@code (clientId, authorization, null)}. * * @param clientId * The client ID as determined by the incoming request. @@ -325,7 +327,7 @@ public Response handleDelete(String clientId, String authorization) * This is optional. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the client application. diff --git a/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java b/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java index 1e0ae95..5166a2c 100644 --- a/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/ConfigurationRequestHandler.java @@ -108,7 +108,7 @@ public Response handle() throws WebApplicationException * method is an alias of {@link #handle(boolean, Options) handle}{@code (true, options)}. * * @param options - * Request options to the Authlete API. + * The request options to the Authlete API. * * @return * A response that should be returned from the endpoint to @@ -154,7 +154,7 @@ public Response handle(boolean pretty) throws WebApplicationException * {@code true} to return the output JSON in pretty format. * * @param options - * Request options to the Authlete API. + * The request options to the Authlete API. * * @return * A response that should be returned from the endpoint to @@ -196,7 +196,7 @@ public Response handle(boolean pretty, Options options) throws WebApplicationExc * #handle(ServiceConfigurationRequest, Options) handle}{@code (request, null)}. * * @param request - * Request parameters to the Authlete API. + * The request parameters to the Authlete API. * * @return * A response that should be returned from the discovery endpoint. @@ -218,10 +218,10 @@ public Response handle(ServiceConfigurationRequest request) throws WebApplicatio * API. * * @param request - * Request parameters to the Authlete API. + * The request parameters to the Authlete API. * * @param options - * Request options to the Authlete API. + * The request options to the Authlete API. * * @return * A response that should be returned from the discovery endpoint. diff --git a/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java b/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java index 355cd5e..4aabb45 100644 --- a/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/CredentialIssuerMetadataRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2023 Authlete, Inc. + * Copyright (C) 2023-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -57,7 +57,7 @@ public CredentialIssuerMetadataRequestHandler(AuthleteApi api) /** * Handle a request to the credential issuer metadata endpoint. This method * is an alias of the {@link - * #handle(CredentialIssuerMetadataRequest, Options)}{@code (request, null)}. + * #handle(CredentialIssuerMetadataRequest, Options) handle}{@code (request, null)}. * * @param request * A credential issuer metadata request. @@ -82,7 +82,7 @@ public Response handle( * A credential issuer metadata request. * * @param options - * Request options for the {@code /api/vci/metadata} API. + * The request options for the {@code /api/vci/metadata} API. * * @return * A response that should be returned from the credential issuer diff --git a/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java b/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java index 0f262fc..be0e0a0 100644 --- a/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/CredentialJwtIssuerMetadataRequestHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2023 Authlete, Inc. + * Copyright (C) 2023-2025 Authlete, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -81,7 +81,7 @@ public Response handle(CredentialJwtIssuerMetadataRequest request) throws WebApp * A JWT issuer metadata request. * * @param options - * Request options for the {@code /api/vci/jwtissuer} API. + * The request options for the {@code /api/vci/jwtissuer} API. * * @return * A response that should be returned from the JWT issuer diff --git a/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java b/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java index 69cd016..4501694 100644 --- a/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/DeviceAuthorizationRequestHandler.java @@ -66,12 +66,12 @@ public DeviceAuthorizationRequestHandler(AuthleteApi api) /** - * Handler for device authorization requests in OAuth 2.0 Device Authorization - * Grant (Device Flow). This method is an alias of {@link #handle(MultivaluedMap, String, String[], Options) + * Handle device authorization requests in OAuth 2.0 Device Authorization Grant + * (Device Flow). This method is an alias of {@link #handle(MultivaluedMap, String, String[], Options) * handle}{@code (parameters, authorization, clientCertificatePath, null)}. * * @param parameters - * Request parameters of a device authorization request. + * The request parameters of a device authorization request. * * @param authorization * The value of {@code Authorization} header in the device authorization @@ -101,11 +101,11 @@ public Response handle( /** - * Handler for device authorization requests in OAuth 2.0 Device Authorization - * Grant (Device Flow). + * Handle device authorization requests in OAuth 2.0 Device Authorization Grant + * (Device Flow). * * @param parameters - * Request parameters of a device authorization request. + * The request parameters of a device authorization request. * * @param authorization * The value of {@code Authorization} header in the device authorization @@ -120,7 +120,7 @@ public Response handle( * if the client did not send a certificate or path. * * @param options - * Request options for the {@code /api/device/authorization} API. + * The request options for the device authorization request. * * @return * A response that should be returned from the endpoint to the diff --git a/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java b/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java index c21895d..020669d 100644 --- a/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/DeviceCompleteRequestHandler.java @@ -78,7 +78,7 @@ public DeviceCompleteRequestHandler(AuthleteApi api, DeviceCompleteRequestHandle /** * Handle the result of end-user authentication and authorization in OAuth * 2.0 Device Authorization Grant (Device Flow). This method is an alias of - * the {@link #handle(String, String[], Options)} method. + * {@link #handle(String, String[], Options) handle}{@code (userCode, claimNames, null)}. * * @param userCode * The user code that the end-user input. @@ -113,7 +113,7 @@ public Response handle(String userCode, String[] claimNames) throws WebApplicati * API. * * @param options - * Request options for the {@code /api/client/registration} API. + * The request options for the {@code /api/client/registration} API. * * @return * A response that should be returned to the end-user. diff --git a/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java b/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java index 066cc77..79564c5 100644 --- a/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/DeviceVerificationRequestHandler.java @@ -93,7 +93,7 @@ public Response handle() throws WebApplicationException * (Device Flow). * * @param options - * Request options for the {@code /api/device/verification} API. + * The request options for the {@code /api/device/verification} API. * * @return * A response that should be returned to the end-user. @@ -106,7 +106,7 @@ public Response handle(Options options) throws WebApplicationException try { // Process the given parameters. - return process(null); + return process(options); } catch (WebApplicationException e) { diff --git a/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java b/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java index bd9849b..fbf1939 100644 --- a/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/FederationConfigurationRequestHandler.java @@ -81,7 +81,7 @@ public Response handle(FederationConfigurationRequest request) throws WebApplica * An entity configuration request. * * @param options - * Request options for the {@code /api/federation/configuration} API. + * The request options for the {@code /api/federation/configuration} API. * * @return * A response that should be returned from the entity configuration diff --git a/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java b/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java index 7300703..b90420e 100644 --- a/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/FederationRegistrationRequestHandler.java @@ -81,7 +81,7 @@ public Response handle(FederationRegistrationRequest request) throws WebApplicat * An "explicit" client registration request. * * @param options - * Request options for the {@code /api/federation/registration} API. + * The request options for the {@code /api/federation/registration} API. * * @return * A response that should be returned from the federation diff --git a/src/main/java/com/authlete/jakarta/GMRequestHandler.java b/src/main/java/com/authlete/jakarta/GMRequestHandler.java index c6f9c3a..4ecb4e1 100644 --- a/src/main/java/com/authlete/jakarta/GMRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/GMRequestHandler.java @@ -55,7 +55,7 @@ public GMRequestHandler(AuthleteApi api) /** - * Handle a grant management request. This method is an alias of the {@link + * Handle a grant management request. This method is an alias of {@link * #handle(GMRequest, Options) handle}{@code (request, null)}. * * @param request @@ -80,7 +80,7 @@ public Response handle(GMRequest request) throws WebApplicationException * A grant management request. * * @param options - * Request options for the {@code /api/gm} API. + * The request options for the {@code /api/gm} API. * * @return * A response that should be returned from the grant management diff --git a/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java b/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java index 8c90f77..576b42e 100644 --- a/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/IntrospectionRequestHandler.java @@ -456,10 +456,10 @@ public Params setPublicKeyForEncryption(String key) /** - * Get the request options for {@code /api/auth/introspection} API. + * Get the request options for the {@code /api/auth/introspection} API. * * @return - * The request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @since 2.82 */ @@ -470,10 +470,10 @@ public Options getOptions() /** - * Set the request options for {@code /api/auth/introspection} API. + * Set the request options for the {@code /api/auth/introspection} API. * * @param options - * The request options for {@code /api/auth/introspection} API. + * The request options for the {@code /api/auth/introspection} API. * * @return * {@code this} object. @@ -507,7 +507,7 @@ public IntrospectionRequestHandler(AuthleteApi api) * handle}{@code (parameters, null)}. * * @param parameters - * Request parameters of an introspection request. + * The request parameters of an introspection request. * * @return * A response that should be returned from the endpoint to @@ -528,10 +528,10 @@ public Response handle( * >RFC 7662). This method is an alias of the {@link #handle(Params)} method. * * @param parameters - * Request parameters of an introspection request. + * The request parameters of an introspection request. * * @param options - * Request options for the {@code /api/auth/introspection/standard} API. + * The request options for the {@code /api/auth/introspection/standard} API. * * @return * A response that should be returned from the endpoint to diff --git a/src/main/java/com/authlete/jakarta/JwksRequestHandler.java b/src/main/java/com/authlete/jakarta/JwksRequestHandler.java index b858066..48e5c19 100644 --- a/src/main/java/com/authlete/jakarta/JwksRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/JwksRequestHandler.java @@ -78,7 +78,7 @@ public Response handle() throws WebApplicationException * of {@link #handle(boolean, Options) handle}{@code (true, options)}. * * @param options - * Request options for the {@code /api/service/jwks/get} API. + * The request options for the {@code /api/service/jwks/get} API. * * @return * A response that should be returned from the endpoint to @@ -123,7 +123,7 @@ public Response handle(boolean pretty) throws WebApplicationException * {@code true} to return the output JSON in pretty format. * * @param options - * Request options for the {@code /api/service/jwks/get} API. + * The request options for the {@code /api/service/jwks/get} API. * * @return * A response that should be returned from the endpoint to diff --git a/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java b/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java index 721bb38..e534fc5 100644 --- a/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java +++ b/src/main/java/com/authlete/jakarta/PushedAuthReqHandler.java @@ -299,10 +299,10 @@ public Params setHtu(String htu) /** - * Get the request options for {@code /api/pushed_auth_req} API. + * Get the request options for the {@code /api/pushed_auth_req} API. * * @return - * The request options for {@code /api/pushed_auth_req} API. + * The request options for the {@code /api/pushed_auth_req} API. * * @since 2.82 */ @@ -313,10 +313,10 @@ public Options getOptions() /** - * Set the request options for {@code /api/pushed_auth_req} API. + * Set the request options for the {@code /api/pushed_auth_req} API. * * @param options - * The request options for {@code /api/pushed_auth_req} API. + * The request options for the {@code /api/pushed_auth_req} API. * * @return * {@code this} object. @@ -350,19 +350,19 @@ public PushedAuthReqHandler(AuthleteApi api) * (parameters, authorization, clientCertificatePath, null)}. * * @param parameters - * Request parameters of a pushed authorization request. + * The request parameters of a pushed authorization request. * * @param authorization - * The value of {@code Authorization} header in the pushed - * authorization request. A client application may embed its - * pair of client ID and client secret in a pushed authorization - * request using Basic Authentication. + * The value of {@code Authorization} header in the pushed + * authorization request. A client application may embed its + * pair of client ID and client secret in a pushed authorization + * request using Basic Authentication. * * @param clientCertificatePath - * The path of the client's certificate, each in PEM format. - * The first item in the array is the client's certificate itself. - * May be {@code null} if the client did not send a certificate or path. + * The path of the client's certificate, each in PEM format. + * The first item in the array is the client's certificate itself. + * May be {@code null} if the client did not send a certificate or path. * * @return * A response that should be returned from the endpoint to the @@ -384,29 +384,29 @@ public Response handle( * #handle(Params)} method. * * @param parameters - * Request parameters of a pushed authorization request. + * The request parameters of a pushed authorization request. * * @param authorization - * The value of {@code Authorization} header in the pushed - * authorization request. A client application may embed its - * pair of client ID and client secret in a pushed authorization - * request using Basic Authentication. + * The value of {@code Authorization} header in the pushed + * authorization request. A client application may embed its + * pair of client ID and client secret in a pushed authorization + * request using Basic Authentication. * * @param clientCertificatePath - * The path of the client's certificate, each in PEM format. - * The first item in the array is the client's certificate itself. - * May be {@code null} if the client did not send a certificate or path. + * The path of the client's certificate, each in PEM format. + * The first item in the array is the client's certificate itself. + * May be {@code null} if the client did not send a certificate or path. * * @param options - * Request options for the {@code /api/pushed_auth_req} API. + * The request options for the {@code /api/pushed_auth_req} API. * * @return * A response that should be returned from the endpoint to the * client application. * * @throws WebApplicationException - * An error occurred. + * An error occurred. * * @since 2.82 */ diff --git a/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java b/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java index 9001b92..e576ef0 100644 --- a/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/RevocationRequestHandler.java @@ -69,7 +69,7 @@ public RevocationRequestHandler(AuthleteApi api) * handle}{@code (parameters, authorization, null)}. * * @param parameters - * Request parameters of a token revocation request. + * The request parameters of a token revocation request. * * @param authorization * The value of {@code Authorization} header in the token revocation @@ -97,7 +97,7 @@ public Response handle( * >RFC 7009). * * @param parameters - * Request parameters of a token revocation request. + * The request parameters of a token revocation request. * * @param authorization * The value of {@code Authorization} header in the token revocation @@ -107,7 +107,7 @@ public Response handle( * Authentication. * * @param options - * Request options for the {@code /api/auth/revocation} API. + * The request options for the {@code /api/auth/revocation} API. * * @return * A response that should be returned from the endpoint to the diff --git a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java index c7ac227..43f42ac 100644 --- a/src/main/java/com/authlete/jakarta/TokenRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/TokenRequestHandler.java @@ -295,10 +295,10 @@ public Params setHtu(String htu) /** - * Get the request options for {@code /api/auth/token} API. + * Get the request options for the {@code /api/auth/token} API. * * @return - * The request options for {@code /api/auth/token} API. + * The request options for the {@code /api/auth/token} API. * * @since 2.82 */ @@ -309,10 +309,10 @@ public Options getTokenOptions() /** - * Set the request options for {@code /api/auth/token} API. + * Set the request options for the {@code /api/auth/token} API. * * @param options - * The request options for {@code /api/auth/token} API. + * The request options for the {@code /api/auth/token} API. * * @return * {@code this} object. @@ -328,10 +328,10 @@ public Params setTokenOptions(Options options) /** - * Get the request options for {@code /api/auth/token/issue} API. + * Get the request options for the {@code /api/auth/token/issue} API. * * @return - * The request options for {@code /api/auth/token/issue} API. + * The request options for the {@code /api/auth/token/issue} API. * * @since 2.82 */ @@ -342,10 +342,10 @@ public Options getTokenIssueOptions() /** - * Set the request options for {@code /api/auth/token/issue} API. + * Set the request options for the {@code /api/auth/token/issue} API. * * @param options - * The request options for {@code /api/auth/token/issue} API. + * The request options for the {@code /api/auth/token/issue} API. * * @return * {@code this} object. @@ -361,10 +361,10 @@ public Params setTokenIssueOptions(Options options) /** - * Get the request options for {@code /api/auth/token/fail} API. + * Get the request options for the {@code /api/auth/token/fail} API. * * @return - * The request options for {@code /api/auth/token/fail} API. + * The request options for the {@code /api/auth/token/fail} API. * * @since 2.82 */ @@ -375,10 +375,10 @@ public Options getTokenFailOptions() /** - * Set the request options for {@code /api/auth/token/fail} API. + * Set the request options for the {@code /api/auth/token/fail} API. * * @param options - * The request options for {@code /api/auth/token/fail} API. + * The request options for the {@code /api/auth/token/fail} API. * * @return * {@code this} object. @@ -430,7 +430,7 @@ public TokenRequestHandler(AuthleteApi api, TokenRequestHandlerSpi spi) * (parameters, authorization, null, null, null)}. * * @param parameters - * Request parameters of a token request. + * The request parameters of a token request. * * @param authorization * The value of {@code Authorization} header in the token request. @@ -459,7 +459,7 @@ public Response handle( * (parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions)}. * * @param parameters - * Request parameters of a token request. + * The request parameters of a token request. * * @param authorization * The value of {@code Authorization} header in the token request. @@ -469,13 +469,13 @@ public Response handle( * Authentication. * * @param tokenOptions - * Request options for the {@code /api/auth/token} API. + * The request options for the {@code /api/auth/token} API. * * @param tokenIssueOptions - * Request options for the {@code /api/auth/token/issue} API. + * The request options for the {@code /api/auth/token/issue} API. * * @param tokenFailOptions - * Request options for the {@code /api/auth/token/fail} API. + * The request options for the {@code /api/auth/token/fail} API. * * @return * A response that should be returned from the endpoint to the @@ -501,7 +501,7 @@ public Response handle( * (parameters, authorization, clientCertificatePath, null, null, null)}. * * @param parameters - * Request parameters of a token request. + * The request parameters of a token request. * * @param authorization * The value of {@code Authorization} header in the token request. @@ -537,7 +537,7 @@ public Response handle( * method. * * @param parameters - * Request parameters of a token request. + * The request parameters of a token request. * * @param authorization * The value of {@code Authorization} header in the token request. @@ -552,13 +552,13 @@ public Response handle( * the client did not send a certificate or path. * * @param tokenOptions - * Request options for the {@code /api/auth/token} API. + * The request options for the {@code /api/auth/token} API. * * @param tokenIssueOptions - * Request options for the {@code /api/auth/token/issue} API. + * The request options for the {@code /api/auth/token/issue} API. * * @param tokenFailOptions - * Request options for the {@code /api/auth/token/fail} API. + * The request options for the {@code /api/auth/token/fail} API. * * @return * A response that should be returned from the endpoint to the diff --git a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java index 1227b2e..20db8d8 100644 --- a/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java +++ b/src/main/java/com/authlete/jakarta/UserInfoRequestHandler.java @@ -386,10 +386,10 @@ public Params setOldIdaFormatUsed(boolean used) /** - * Get the request options for {@code /api/auth/userinfo} API. + * Get the request options for the {@code /api/auth/userinfo} API. * * @return - * The request options for {@code /api/auth/userinfo} API. + * The request options for the {@code /api/auth/userinfo} API. * * @since 2.82 */ @@ -400,10 +400,10 @@ public Options getUserInfoOptions() /** - * Set the request options for {@code /api/auth/userinfo} API. + * Set the request options for the {@code /api/auth/userinfo} API. * * @param options - * The request options for {@code /api/auth/userinfo} API. + * The request options for the {@code /api/auth/userinfo} API. * * @return * {@code this} object. @@ -419,10 +419,10 @@ public Params setUserInfoOptions(Options options) /** - * Get the request options for {@code /api/auth/userinfo/issue} API. + * Get the request options for the {@code /api/auth/userinfo/issue} API. * * @return - * The request options for {@code /api/auth/userinfo/issue} API. + * The request options for the {@code /api/auth/userinfo/issue} API. * * @since 2.82 */ @@ -433,10 +433,10 @@ public Options getUserInfoIssueOptions() /** - * Set the request options for {@code /api/auth/userinfo/issue} API. + * Set the request options for the {@code /api/auth/userinfo/issue} API. * * @param options - * The request options for {@code /api/auth/userinfo/issue} API. + * The request options for the {@code /api/auth/userinfo/issue} API. * * @return * {@code this} object. @@ -518,10 +518,10 @@ public Response handle(String accessToken) throws WebApplicationException * An access token. * * @param userInfoOptions - * Request options for the {@code /api/auth/userinfo} API. + * The request options for the {@code /api/auth/userinfo} API. * * @param userInfoIssueOptions - * Request options for the {@code /api/auth/userinfo/issue} API. + * The request options for the {@code /api/auth/userinfo/issue} API. * * @return * A response that should be returned from the endpoint to the @@ -547,7 +547,11 @@ public Response handle( /** - * Handle a userinfo request. + * Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect + * Core 1.0. * * @param params * Parameters needed to handle the userinfo request.