Skip to content

[java] [restclient] Add support for a token supplier to OAuth based RestClient clients #19944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Oct 31, 2024
Merged

[java] [restclient] Add support for a token supplier to OAuth based RestClient clients #19944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions modules/openapi-generator/src/main/resources/Java/libraries/restclient/auth/OAuth.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,49 @@

package {{invokerPackage}}.auth;

import java.util.Optional;
import java.util.function.Supplier;
import org.springframework.http.HttpHeaders;
import org.springframework.util.MultiValueMap;

/**
* Provides support for RFC 6750 - Bearer Token usage for OAUTH 2.0 Authorization.
*/
{{>generatedAnnotation}}
public class OAuth implements Authentication {
private String accessToken;
private Supplier<String> tokenSupplier;

/**
* Returns the bearer token used for Authorization.
*
* @return The bearer token
*/
public String getAccessToken() {
return accessToken;
return tokenSupplier.get();
}

/**
* Sets the bearer access token used for Authorization.
*
* @param accessToken The bearer token to send in the Authorization header
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
setAccessToken(() -> accessToken);
}

/**
* Sets the supplier of bearer tokens used for Authorization.
*
* @param tokenSupplier The supplier of bearer tokens to send in the Authorization header
*/
public void setAccessToken(Supplier<String> tokenSupplier) {
this.tokenSupplier = tokenSupplier;
}

@Override
public void applyToParams(MultiValueMap<String, String> queryParams, HttpHeaders headerParams, MultiValueMap<String, String> cookieParams) {
if (accessToken != null) {
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken);
}
Optional.ofNullable(tokenSupplier).map(Supplier::get).ifPresent(accessToken ->
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken)
);
}
}
23 changes: 22 additions & 1 deletion .../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2963,7 +2963,7 @@ void shouldGenerateCorrectJaxbAnnotations(Library library) {


@Test
public void shouldGenerateOAuthTokenSuppliers() {
public void testRestTemplateWithGeneratedOAuthTokenSuppliers() {

final Map<String, File> files = generateFromContract(
"src/test/resources/3_0/java/oauth.yaml",
Expand Down Expand Up @@ -2994,6 +2994,27 @@ public void shouldGenerateOAuthTokenSuppliers() {

}

@Test
public void testRestClientWithGeneratedOAuthTokenSuppliers() {
final Map<String, File> files = generateFromContract(
"src/test/resources/3_0/java/oauth.yaml",
JavaClientCodegen.RESTCLIENT
);

final JavaFileAssert oAuth = JavaFileAssert.assertThat(files.get("OAuth.java"))
.printFileContent();
oAuth
.assertMethod("setAccessToken", "String")
.bodyContainsLines("setAccessToken(() -> accessToken);");
oAuth
.assertMethod("setAccessToken", "Supplier<String>")
.bodyContainsLines("this.tokenSupplier = tokenSupplier;");
oAuth
.assertMethod("applyToParams")
.bodyContainsLines("Optional.ofNullable(tokenSupplier).map(Supplier::get).ifPresent(accessToken ->")
.bodyContainsLines("headerParams.add(HttpHeaders.AUTHORIZATION, \"Bearer \" + accessToken)");
}

@Test public void testRestClientWithXML_issue_19137() {
final Path output = newTempFolder();
final CodegenConfigurator configurator = new CodegenConfigurator()
Expand Down
36 changes: 30 additions & 6 deletions ...t/petstore/java/restclient-swagger2/src/main/java/org/openapitools/client/auth/OAuth.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,49 @@

package org.openapitools.client.auth;

import java.util.Optional;
import java.util.function.Supplier;
import org.springframework.http.HttpHeaders;
import org.springframework.util.MultiValueMap;

/**
* Provides support for RFC 6750 - Bearer Token usage for OAUTH 2.0 Authorization.
*/
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.10.0-SNAPSHOT")
public class OAuth implements Authentication {
private String accessToken;
private Supplier<String> tokenSupplier;

/**
* Returns the bearer token used for Authorization.
*
* @return The bearer token
*/
public String getAccessToken() {
return accessToken;
return tokenSupplier.get();
}

/**
* Sets the bearer access token used for Authorization.
*
* @param accessToken The bearer token to send in the Authorization header
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
setAccessToken(() -> accessToken);
}

/**
* Sets the supplier of bearer tokens used for Authorization.
*
* @param tokenSupplier The supplier of bearer tokens to send in the Authorization header
*/
public void setAccessToken(Supplier<String> tokenSupplier) {
this.tokenSupplier = tokenSupplier;
}

@Override
public void applyToParams(MultiValueMap<String, String> queryParams, HttpHeaders headerParams, MultiValueMap<String, String> cookieParams) {
if (accessToken != null) {
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken);
}
Optional.ofNullable(tokenSupplier).map(Supplier::get).ifPresent(accessToken ->
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken)
);
}
}
36 changes: 30 additions & 6 deletions ...estclient-useSingleRequestParameter/src/main/java/org/openapitools/client/auth/OAuth.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,49 @@

package org.openapitools.client.auth;

import java.util.Optional;
import java.util.function.Supplier;
import org.springframework.http.HttpHeaders;
import org.springframework.util.MultiValueMap;

/**
* Provides support for RFC 6750 - Bearer Token usage for OAUTH 2.0 Authorization.
*/
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.10.0-SNAPSHOT")
public class OAuth implements Authentication {
private String accessToken;
private Supplier<String> tokenSupplier;

/**
* Returns the bearer token used for Authorization.
*
* @return The bearer token
*/
public String getAccessToken() {
return accessToken;
return tokenSupplier.get();
}

/**
* Sets the bearer access token used for Authorization.
*
* @param accessToken The bearer token to send in the Authorization header
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
setAccessToken(() -> accessToken);
}

/**
* Sets the supplier of bearer tokens used for Authorization.
*
* @param tokenSupplier The supplier of bearer tokens to send in the Authorization header
*/
public void setAccessToken(Supplier<String> tokenSupplier) {
this.tokenSupplier = tokenSupplier;
}

@Override
public void applyToParams(MultiValueMap<String, String> queryParams, HttpHeaders headerParams, MultiValueMap<String, String> cookieParams) {
if (accessToken != null) {
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken);
}
Optional.ofNullable(tokenSupplier).map(Supplier::get).ifPresent(accessToken ->
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken)
);
}
}
36 changes: 30 additions & 6 deletions ...les/client/petstore/java/restclient/src/main/java/org/openapitools/client/auth/OAuth.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,49 @@

package org.openapitools.client.auth;

import java.util.Optional;
import java.util.function.Supplier;
import org.springframework.http.HttpHeaders;
import org.springframework.util.MultiValueMap;

/**
* Provides support for RFC 6750 - Bearer Token usage for OAUTH 2.0 Authorization.
*/
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.10.0-SNAPSHOT")
public class OAuth implements Authentication {
private String accessToken;
private Supplier<String> tokenSupplier;

/**
* Returns the bearer token used for Authorization.
*
* @return The bearer token
*/
public String getAccessToken() {
return accessToken;
return tokenSupplier.get();
}

/**
* Sets the bearer access token used for Authorization.
*
* @param accessToken The bearer token to send in the Authorization header
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
setAccessToken(() -> accessToken);
}

/**
* Sets the supplier of bearer tokens used for Authorization.
*
* @param tokenSupplier The supplier of bearer tokens to send in the Authorization header
*/
public void setAccessToken(Supplier<String> tokenSupplier) {
this.tokenSupplier = tokenSupplier;
}

@Override
public void applyToParams(MultiValueMap<String, String> queryParams, HttpHeaders headerParams, MultiValueMap<String, String> cookieParams) {
if (accessToken != null) {
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken);
}
Optional.ofNullable(tokenSupplier).map(Supplier::get).ifPresent(accessToken ->
headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken)
);
}
}