Skip to content

Make ApiClient in retrofit2 be able to use own OkHttpClient #6699

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
merged 9 commits into from
Jul 2, 2020
Merged

Make ApiClient in retrofit2 be able to use own OkHttpClient #6699

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c46b027
Merge pull request #1 from OpenAPITools/master
tgerth Jun 17, 2020
b4fec1c
set adapterBuilder.client() only if okBuilder was used in retrofit2
Jun 17, 2020
6f646db
updated the samples
Jun 18, 2020
b0855b3
added field okHttpClient and updated samples
Jun 22, 2020
26f777a
bug fixed, added exception if okBuilder is null
Jun 26, 2020
ef3a88e
added semicolon
Jun 26, 2020
d7634ae
added space, changed Exception to RuntimeException and changed its me…
Jun 29, 2020
d1de6b8
updated the samples
Jun 29, 2020
ccf3c20
Merge pull request #2 from OpenAPITools/master
tgerth Jun 30, 2020
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
22 changes: 17 additions & 5 deletions modules/openapi-generator/src/main/resources/Java/libraries/retrofit2/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,18 @@ public class ApiClient {
private OkHttpClient.Builder okBuilder;
private Retrofit.Builder adapterBuilder;
private JSON json;
private OkHttpClient okHttpClient;

public ApiClient() {
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okBuilder = new OkHttpClient.Builder();
}

public ApiClient(OkHttpClient client){
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okHttpClient = client;
}

public ApiClient(String[] authNames) {
Expand Down Expand Up @@ -141,7 +149,6 @@ public class ApiClient {
{{/hasOAuthMethods}}
public void createDefaultAdapter() {
json = new JSON();
okBuilder = new OkHttpClient.Builder();

String baseUrl = "{{{basePath}}}";
if (!baseUrl.endsWith("/"))
Expand All @@ -164,10 +171,11 @@ public class ApiClient {
}

public <S> S createService(Class<S> serviceClass) {
return adapterBuilder
.client(okBuilder.build())
.build()
.create(serviceClass);
if (okHttpClient != null) {
return adapterBuilder.client(okHttpClient).build().create(serviceClass);
}else {
return adapterBuilder.client(okBuilder.build()).build().create(serviceClass);
}
}

public ApiClient setDateFormat(DateFormat dateFormat) {
Expand Down Expand Up @@ -357,7 +365,11 @@ public class ApiClient {
throw new RuntimeException("auth name \"" + authName + "\" already in api authorizations");
}
apiAuthorizations.put(authName, authorization);
if(okBuilder == null){
throw new Exception("okBuilder is null")
}
okBuilder.addInterceptor(authorization);

return this;
}

Expand Down
22 changes: 17 additions & 5 deletions samples/client/petstore/java/retrofit2/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,18 @@ public class ApiClient {
private OkHttpClient.Builder okBuilder;
private Retrofit.Builder adapterBuilder;
private JSON json;
private OkHttpClient okHttpClient;

public ApiClient() {
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okBuilder = new OkHttpClient.Builder();
}

public ApiClient(OkHttpClient client){
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okHttpClient = client;
}

public ApiClient(String[] authNames) {
Expand Down Expand Up @@ -114,7 +122,6 @@ public ApiClient(String authName, String clientId, String secret, String usernam

public void createDefaultAdapter() {
json = new JSON();
okBuilder = new OkHttpClient.Builder();

String baseUrl = "http://petstore.swagger.io:80/v2";
if (!baseUrl.endsWith("/"))
Expand All @@ -128,10 +135,11 @@ public void createDefaultAdapter() {
}

public <S> S createService(Class<S> serviceClass) {
return adapterBuilder
.client(okBuilder.build())
.build()
.create(serviceClass);
if (okHttpClient != null) {
return adapterBuilder.client(okHttpClient).build().create(serviceClass);
}else {
Copy link
Member

@cbornet cbornet Jun 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space missing

return adapterBuilder.client(okBuilder.build()).build().create(serviceClass);
}
}

public ApiClient setDateFormat(DateFormat dateFormat) {
Expand Down Expand Up @@ -303,7 +311,11 @@ public ApiClient addAuthorization(String authName, Interceptor authorization) {
throw new RuntimeException("auth name \"" + authName + "\" already in api authorizations");
}
apiAuthorizations.put(authName, authorization);
if(okBuilder == null){
throw new Exception("okBuilder is null")
Copy link
Member

@cbornet cbornet Jun 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use RuntimeException ? (or even better : create an ApiClientException)

Copy link
Member

@cbornet cbornet Jun 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The message could be more explicit. Something like "the ApiClient was created with a built okClient so it's not possible to add an authorization interceptor to it".

Copy link
Contributor Author

@tgerth tgerth Jun 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the advantage of creating an own ApiClientException comparing to the RuntimeException here in this case?

Copy link
Member

@cbornet cbornet Jun 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See https://rules.sonarsource.com/java/RSPEC-112 . But we already have a bunch of RuntimeException so...

Copy link
Contributor Author

@tgerth tgerth Jun 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok I see but as you said we already have many RuntimeExceptions so I will use a RuntimeException here if that's ok and then maybe in future you/we can change them to own Exceptions.

}
okBuilder.addInterceptor(authorization);

return this;
}

Expand Down
22 changes: 17 additions & 5 deletions ...es/client/petstore/java/retrofit2rx2/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,18 @@ public class ApiClient {
private OkHttpClient.Builder okBuilder;
private Retrofit.Builder adapterBuilder;
private JSON json;
private OkHttpClient okHttpClient;

public ApiClient() {
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okBuilder = new OkHttpClient.Builder();
}

public ApiClient(OkHttpClient client){
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okHttpClient = client;
}

public ApiClient(String[] authNames) {
Expand Down Expand Up @@ -115,7 +123,6 @@ public ApiClient(String authName, String clientId, String secret, String usernam

public void createDefaultAdapter() {
json = new JSON();
okBuilder = new OkHttpClient.Builder();

String baseUrl = "http://petstore.swagger.io:80/v2";
if (!baseUrl.endsWith("/"))
Expand All @@ -130,10 +137,11 @@ public void createDefaultAdapter() {
}

public <S> S createService(Class<S> serviceClass) {
return adapterBuilder
.client(okBuilder.build())
.build()
.create(serviceClass);
if (okHttpClient != null) {
return adapterBuilder.client(okHttpClient).build().create(serviceClass);
}else {
return adapterBuilder.client(okBuilder.build()).build().create(serviceClass);
}
}

public ApiClient setDateFormat(DateFormat dateFormat) {
Expand Down Expand Up @@ -305,7 +313,11 @@ public ApiClient addAuthorization(String authName, Interceptor authorization) {
throw new RuntimeException("auth name \"" + authName + "\" already in api authorizations");
}
apiAuthorizations.put(authName, authorization);
if(okBuilder == null){
throw new Exception("okBuilder is null")
}
okBuilder.addInterceptor(authorization);

return this;
}

Expand Down
22 changes: 17 additions & 5 deletions ...es/client/petstore/java/retrofit2rx3/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,18 @@ public class ApiClient {
private OkHttpClient.Builder okBuilder;
private Retrofit.Builder adapterBuilder;
private JSON json;
private OkHttpClient okHttpClient;

public ApiClient() {
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okBuilder = new OkHttpClient.Builder();
}

public ApiClient(OkHttpClient client){
apiAuthorizations = new LinkedHashMap<String, Interceptor>();
createDefaultAdapter();
okHttpClient = client;
}

public ApiClient(String[] authNames) {
Expand Down Expand Up @@ -115,7 +123,6 @@ public ApiClient(String authName, String clientId, String secret, String usernam

public void createDefaultAdapter() {
json = new JSON();
okBuilder = new OkHttpClient.Builder();

String baseUrl = "http://petstore.swagger.io:80/v2";
if (!baseUrl.endsWith("/"))
Expand All @@ -130,10 +137,11 @@ public void createDefaultAdapter() {
}

public <S> S createService(Class<S> serviceClass) {
return adapterBuilder
.client(okBuilder.build())
.build()
.create(serviceClass);
if (okHttpClient != null) {
return adapterBuilder.client(okHttpClient).build().create(serviceClass);
}else {
return adapterBuilder.client(okBuilder.build()).build().create(serviceClass);
}
}

public ApiClient setDateFormat(DateFormat dateFormat) {
Expand Down Expand Up @@ -305,7 +313,11 @@ public ApiClient addAuthorization(String authName, Interceptor authorization) {
throw new RuntimeException("auth name \"" + authName + "\" already in api authorizations");
}
apiAuthorizations.put(authName, authorization);
if(okBuilder == null){
throw new Exception("okBuilder is null")
}
okBuilder.addInterceptor(authorization);

return this;
}

Expand Down