Merge pull request #49 from dhis2/configurable-object-mapper

mortenoh · web-flow · commit 75a1ef677f8d · 2022-12-15T15:17:39.000+07:00
feat: parameterise timeout values and object mapper
diff --git a/android-jackson-model/pom.xml b/android-jackson-model/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>dhis2-java-sdk-pom</artifactId>
         <groupId>org.hisp.dhis.integration.sdk</groupId>
-        <version>1.0.0-RC2</version>
+        <version>1.0.0-RC3-SNAPSHOT</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>
diff --git a/jackson-model/pom.xml b/jackson-model/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>dhis2-java-sdk-pom</artifactId>
         <groupId>org.hisp.dhis.integration.sdk</groupId>
-        <version>1.0.0-RC2</version>
+        <version>1.0.0-RC3-SNAPSHOT</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
     <groupId>org.hisp.dhis.integration.sdk</groupId>
     <artifactId>dhis2-java-sdk-pom</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.0-RC2</version>
+    <version>1.0.0-RC3-SNAPSHOT</version>
 
     <name>DHIS2 Java SDK</name>
     <url>https://github.com/dhis2/dhis2-java-sdk</url>
diff --git a/sdk/pom.xml b/sdk/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>dhis2-java-sdk-pom</artifactId>
         <groupId>org.hisp.dhis.integration.sdk</groupId>
-        <version>1.0.0-RC2</version>
+        <version>1.0.0-RC3-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>dhis2-java-sdk</artifactId>
diff --git a/sdk/src/main/java/org/hisp/dhis/integration/sdk/DefaultDhis2Client.java b/sdk/src/main/java/org/hisp/dhis/integration/sdk/DefaultDhis2Client.java
@@ -54,11 +54,15 @@ public class DefaultDhis2Client implements Dhis2Client
     private final ConverterFactory converterFactory;
 
     DefaultDhis2Client( String apiUrl, SecurityContext securityContext, ConverterFactory converterFactory,
-        int maxIdleConnections, long keepAliveDuration )
+        int maxIdleConnections, long keepAliveDuration, long callTimeout, long readTimeout, long writeTimeout,
+        long connectTimeout )
     {
         this.apiUrl = apiUrl;
         OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder()
-            .connectionPool( new ConnectionPool( maxIdleConnections, keepAliveDuration, TimeUnit.MILLISECONDS ) );
+            .connectionPool( new ConnectionPool( maxIdleConnections, keepAliveDuration, TimeUnit.MILLISECONDS ) )
+            .callTimeout( callTimeout, TimeUnit.MILLISECONDS ).readTimeout( readTimeout, TimeUnit.MILLISECONDS )
+            .writeTimeout( writeTimeout, TimeUnit.MILLISECONDS )
+            .connectTimeout( connectTimeout, TimeUnit.MILLISECONDS );
         httpClient = httpClientBuilder.addInterceptor(
             chain -> chain.proceed( securityContext.apply( chain.request() ) ) ).build();
         this.converterFactory = converterFactory;
diff --git a/sdk/src/main/java/org/hisp/dhis/integration/sdk/Dhis2ClientBuilder.java b/sdk/src/main/java/org/hisp/dhis/integration/sdk/Dhis2ClientBuilder.java
@@ -42,7 +42,15 @@ public class Dhis2ClientBuilder
 
     private final int maxIdleConnections;
 
-    private final long keepAliveDuration;
+    private final long keepAliveDurationMs;
+
+    private final long callTimeoutMs;
+
+    private final long readTimeoutMs;
+
+    private final long writeTimeoutMs;
+
+    private final long connectTimeoutMs;
 
     private ConverterFactory converterFactory = new JacksonConverterFactory();
 
@@ -53,36 +61,42 @@ public static Dhis2ClientBuilder newClient( String baseApiUrl, String username,
 
     public static Dhis2ClientBuilder newClient( String baseApiUrl, String personalAccessToken )
     {
-        return newClient( baseApiUrl, personalAccessToken, 5, 300000 );
+        return newClient( baseApiUrl, personalAccessToken, 5, 300000, 0, 10000, 10000, 10000 );
     }
 
     public static Dhis2ClientBuilder newClient( String baseApiUrl, String username, String password,
-        int maxIdleConnections, long keepAliveDuration )
+        int maxIdleConnections, long keepAliveDurationMs )
     {
         return new Dhis2ClientBuilder( baseApiUrl, new BasicCredentialsSecurityContext( username, password ),
-            maxIdleConnections, keepAliveDuration );
+            maxIdleConnections, keepAliveDurationMs, 0, 10000, 10000, 10000 );
     }
 
     public static Dhis2ClientBuilder newClient( String baseApiUrl, String personalAccessToken, int maxIdleConnections,
-        long keepAliveDuration )
+        long keepAliveDurationMs, long callTimeoutMs, long readTimeoutMs, long writeTimeoutMs, long connectTimeoutMs )
     {
         return new Dhis2ClientBuilder( baseApiUrl, new PersonalAccessTokenSecurityContext( personalAccessToken ),
-            maxIdleConnections, keepAliveDuration );
+            maxIdleConnections, keepAliveDurationMs, callTimeoutMs, readTimeoutMs, writeTimeoutMs, connectTimeoutMs );
     }
 
     public static Dhis2ClientBuilder newClient( String baseApiUrl, SecurityContext securityContext,
-        int maxIdleConnections, long keepAliveDuration )
+        int maxIdleConnections, long keepAliveDurationMs, long callTimeoutMs, long readTimeoutMs, long writeTimeoutMs,
+        long connectTimeoutMs )
     {
-        return new Dhis2ClientBuilder( baseApiUrl, securityContext, maxIdleConnections, keepAliveDuration );
+        return new Dhis2ClientBuilder( baseApiUrl, securityContext, maxIdleConnections, keepAliveDurationMs, callTimeoutMs,
+            readTimeoutMs, writeTimeoutMs, connectTimeoutMs );
     }
 
     private Dhis2ClientBuilder( String baseApiUrl, SecurityContext securityContext, int maxIdleConnections,
-        long keepAliveDuration )
+        long keepAliveDurationMs, long callTimeoutMs, long readTimeoutMs, long writeTimeoutMs, long connectTimeout )
     {
         this.baseApiUrl = baseApiUrl.trim();
         this.securityContext = securityContext;
         this.maxIdleConnections = maxIdleConnections;
-        this.keepAliveDuration = keepAliveDuration;
+        this.keepAliveDurationMs = keepAliveDurationMs;
+        this.callTimeoutMs = callTimeoutMs;
+        this.readTimeoutMs = readTimeoutMs;
+        this.writeTimeoutMs = writeTimeoutMs;
+        this.connectTimeoutMs = connectTimeout;
     }
 
     public Dhis2ClientBuilder withConverterFactory( ConverterFactory converterFactory )
@@ -100,6 +114,6 @@ public Dhis2Client build()
             apiPathStringBuilder.append( "/" );
         }
         return new DefaultDhis2Client( apiPathStringBuilder.toString(), securityContext, converterFactory,
-            maxIdleConnections, keepAliveDuration );
+            maxIdleConnections, keepAliveDurationMs, callTimeoutMs, readTimeoutMs, writeTimeoutMs, connectTimeoutMs );
     }
 }
diff --git a/sdk/src/main/java/org/hisp/dhis/integration/sdk/internal/converter/JacksonConverterFactory.java b/sdk/src/main/java/org/hisp/dhis/integration/sdk/internal/converter/JacksonConverterFactory.java
@@ -27,21 +27,35 @@
  */
 package org.hisp.dhis.integration.sdk.internal.converter;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import org.hisp.dhis.integration.sdk.api.converter.ConverterFactory;
 import org.hisp.dhis.integration.sdk.api.converter.RequestConverter;
 import org.hisp.dhis.integration.sdk.api.converter.ResponseConverter;
 
 public class JacksonConverterFactory implements ConverterFactory
 {
+    private final ObjectMapper objectMapper;
+
+    public JacksonConverterFactory( ObjectMapper objectMapper )
+    {
+        this.objectMapper = objectMapper;
+    }
+
+    public JacksonConverterFactory()
+    {
+        this.objectMapper = new ObjectMapper().registerModule( new Jdk8Module().configureAbsentsAsNulls( true ) );
+    }
+
     @Override
     public <T> RequestConverter<T> createRequestConverter( Class<T> requestType )
     {
-        return new JacksonRequestConverter<>(requestType);
+        return new JacksonRequestConverter<>( requestType, objectMapper );
     }
 
     @Override
     public <T> ResponseConverter<T> createResponseConverter( Class<T> responseType )
     {
-        return new JacksonResponseConverter<>( responseType );
+        return new JacksonResponseConverter<>( responseType, objectMapper );
     }
 }
diff --git a/sdk/src/main/java/org/hisp/dhis/integration/sdk/internal/converter/JacksonRequestConverter.java b/sdk/src/main/java/org/hisp/dhis/integration/sdk/internal/converter/JacksonRequestConverter.java
@@ -28,29 +28,28 @@
 package org.hisp.dhis.integration.sdk.internal.converter;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import org.hisp.dhis.integration.sdk.api.converter.RequestConverter;
 
 import java.io.IOException;
 
 public class JacksonRequestConverter<T> implements RequestConverter<T>
 {
-    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper().registerModule(
-        new Jdk8Module().configureAbsentsAsNulls( true ) );
-
     private final Class<T> requestType;
 
-    public JacksonRequestConverter( Class<T> requestType )
+    private final ObjectMapper objectMapper;
+
+    public JacksonRequestConverter( Class<T> requestType, ObjectMapper objectMapper )
     {
         this.requestType = requestType;
+        this.objectMapper = objectMapper;
     }
 
     @Override
     public String convert( T requestBody )
     {
         try
         {
-            return OBJECT_MAPPER.writeValueAsString( requestBody );
+            return objectMapper.writeValueAsString( requestBody );
         }
         catch ( IOException e )
         {
diff --git a/sdk/src/main/java/org/hisp/dhis/integration/sdk/internal/converter/JacksonResponseConverter.java b/sdk/src/main/java/org/hisp/dhis/integration/sdk/internal/converter/JacksonResponseConverter.java
@@ -39,21 +39,22 @@
 
 public class JacksonResponseConverter<T> implements ResponseConverter<T>
 {
-    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
-
     private final Class<T> returnType;
 
-    public JacksonResponseConverter( Class<T> returnType )
+    private final ObjectMapper objectMapper;
+
+    public JacksonResponseConverter( Class<T> returnType, ObjectMapper objectMapper )
     {
         this.returnType = returnType;
+        this.objectMapper = objectMapper;
     }
 
     @Override
     public T convert( ResponseBody responseBody )
     {
         try
         {
-            return OBJECT_MAPPER.readValue( responseBody.charStream(), returnType );
+            return objectMapper.readValue( responseBody.charStream(), returnType );
         }
         catch ( IOException e )
         {
@@ -68,7 +69,7 @@ public T convert( ResponseBody responseBody )
     @Override
     public T convert( List<Map<String, Object>> responseBody )
     {
-        return OBJECT_MAPPER.convertValue( responseBody,
-            OBJECT_MAPPER.getTypeFactory().constructCollectionLikeType( List.class, returnType ) );
+        return objectMapper.convertValue( responseBody,
+            objectMapper.getTypeFactory().constructCollectionLikeType( List.class, returnType ) );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,15 @@ public class Dhis2ClientBuilder`
`42`	`42`
`43`	`43`	`private final int maxIdleConnections;`
`44`	`44`
`45`		`- private final long keepAliveDuration;`
	`45`	`+ private final long keepAliveDurationMs;`
	`46`	`+`
	`47`	`+ private final long callTimeoutMs;`
	`48`	`+`
	`49`	`+ private final long readTimeoutMs;`
	`50`	`+`
	`51`	`+ private final long writeTimeoutMs;`
	`52`	`+`
	`53`	`+ private final long connectTimeoutMs;`
`46`	`54`
`47`	`55`	`private ConverterFactory converterFactory = new JacksonConverterFactory();`
`48`	`56`
`@@ -53,36 +61,42 @@ public static Dhis2ClientBuilder newClient( String baseApiUrl, String username,`
`53`	`61`
`54`	`62`	`public static Dhis2ClientBuilder newClient( String baseApiUrl, String personalAccessToken )`
`55`	`63`	`{`
`56`		`- return newClient( baseApiUrl, personalAccessToken, 5, 300000 );`
	`64`	`+ return newClient( baseApiUrl, personalAccessToken, 5, 300000, 0, 10000, 10000, 10000 );`
`57`	`65`	`}`
`58`	`66`
`59`	`67`	`public static Dhis2ClientBuilder newClient( String baseApiUrl, String username, String password,`
`60`		`- int maxIdleConnections, long keepAliveDuration )`
	`68`	`+ int maxIdleConnections, long keepAliveDurationMs )`
`61`	`69`	`{`
`62`	`70`	`return new Dhis2ClientBuilder( baseApiUrl, new BasicCredentialsSecurityContext( username, password ),`
`63`		`- maxIdleConnections, keepAliveDuration );`
	`71`	`+ maxIdleConnections, keepAliveDurationMs, 0, 10000, 10000, 10000 );`
`64`	`72`	`}`
`65`	`73`
`66`	`74`	`public static Dhis2ClientBuilder newClient( String baseApiUrl, String personalAccessToken, int maxIdleConnections,`
`67`		`- long keepAliveDuration )`
	`75`	`+ long keepAliveDurationMs, long callTimeoutMs, long readTimeoutMs, long writeTimeoutMs, long connectTimeoutMs )`
`68`	`76`	`{`
`69`	`77`	`return new Dhis2ClientBuilder( baseApiUrl, new PersonalAccessTokenSecurityContext( personalAccessToken ),`
`70`		`- maxIdleConnections, keepAliveDuration );`
	`78`	`+ maxIdleConnections, keepAliveDurationMs, callTimeoutMs, readTimeoutMs, writeTimeoutMs, connectTimeoutMs );`
`71`	`79`	`}`
`72`	`80`
`73`	`81`	`public static Dhis2ClientBuilder newClient( String baseApiUrl, SecurityContext securityContext,`
`74`		`- int maxIdleConnections, long keepAliveDuration )`
	`82`	`+ int maxIdleConnections, long keepAliveDurationMs, long callTimeoutMs, long readTimeoutMs, long writeTimeoutMs,`
	`83`	`+ long connectTimeoutMs )`
`75`	`84`	`{`
`76`		`- return new Dhis2ClientBuilder( baseApiUrl, securityContext, maxIdleConnections, keepAliveDuration );`
	`85`	`+ return new Dhis2ClientBuilder( baseApiUrl, securityContext, maxIdleConnections, keepAliveDurationMs, callTimeoutMs,`
	`86`	`+ readTimeoutMs, writeTimeoutMs, connectTimeoutMs );`
`77`	`87`	`}`
`78`	`88`
`79`	`89`	`private Dhis2ClientBuilder( String baseApiUrl, SecurityContext securityContext, int maxIdleConnections,`
`80`		`- long keepAliveDuration )`
	`90`	`+ long keepAliveDurationMs, long callTimeoutMs, long readTimeoutMs, long writeTimeoutMs, long connectTimeout )`
`81`	`91`	`{`
`82`	`92`	`this.baseApiUrl = baseApiUrl.trim();`
`83`	`93`	`this.securityContext = securityContext;`
`84`	`94`	`this.maxIdleConnections = maxIdleConnections;`
`85`		`- this.keepAliveDuration = keepAliveDuration;`
	`95`	`+ this.keepAliveDurationMs = keepAliveDurationMs;`
	`96`	`+ this.callTimeoutMs = callTimeoutMs;`
	`97`	`+ this.readTimeoutMs = readTimeoutMs;`
	`98`	`+ this.writeTimeoutMs = writeTimeoutMs;`
	`99`	`+ this.connectTimeoutMs = connectTimeout;`
`86`	`100`	`}`
`87`	`101`
`88`	`102`	`public Dhis2ClientBuilder withConverterFactory( ConverterFactory converterFactory )`
`@@ -100,6 +114,6 @@ public Dhis2Client build()`
`100`	`114`	`apiPathStringBuilder.append( "/" );`
`101`	`115`	`}`
`102`	`116`	`return new DefaultDhis2Client( apiPathStringBuilder.toString(), securityContext, converterFactory,`
`103`		`- maxIdleConnections, keepAliveDuration );`
	`117`	`+ maxIdleConnections, keepAliveDurationMs, callTimeoutMs, readTimeoutMs, writeTimeoutMs, connectTimeoutMs );`
`104`	`118`	`}`
`105`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,29 +28,28 @@`
`28`	`28`	`package org.hisp.dhis.integration.sdk.internal.converter;`
`29`	`29`
`30`	`30`	`import com.fasterxml.jackson.databind.ObjectMapper;`
`31`		`-import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;`
`32`	`31`	`import org.hisp.dhis.integration.sdk.api.converter.RequestConverter;`
`33`	`32`
`34`	`33`	`import java.io.IOException;`
`35`	`34`
`36`	`35`	`public class JacksonRequestConverter<T> implements RequestConverter<T>`
`37`	`36`	`{`
`38`		`- private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper().registerModule(`
`39`		`- new Jdk8Module().configureAbsentsAsNulls( true ) );`
`40`		`-`
`41`	`37`	`private final Class<T> requestType;`
`42`	`38`
`43`		`- public JacksonRequestConverter( Class<T> requestType )`
	`39`	`+ private final ObjectMapper objectMapper;`
	`40`	`+`
	`41`	`+ public JacksonRequestConverter( Class<T> requestType, ObjectMapper objectMapper )`
`44`	`42`	`{`
`45`	`43`	`this.requestType = requestType;`
	`44`	`+ this.objectMapper = objectMapper;`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`@Override`
`49`	`48`	`public String convert( T requestBody )`
`50`	`49`	`{`
`51`	`50`	`try`
`52`	`51`	`{`
`53`		`- return OBJECT_MAPPER.writeValueAsString( requestBody );`
	`52`	`+ return objectMapper.writeValueAsString( requestBody );`
`54`	`53`	`}`
`55`	`54`	`catch ( IOException e )`
`56`	`55`	`{`
Original file line number	Diff line number	Diff line change
`@@ -39,21 +39,22 @@`
`39`	`39`
`40`	`40`	`public class JacksonResponseConverter<T> implements ResponseConverter<T>`
`41`	`41`	`{`
`42`		`- private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();`
`43`		`-`
`44`	`42`	`private final Class<T> returnType;`
`45`	`43`
`46`		`- public JacksonResponseConverter( Class<T> returnType )`
	`44`	`+ private final ObjectMapper objectMapper;`
	`45`	`+`
	`46`	`+ public JacksonResponseConverter( Class<T> returnType, ObjectMapper objectMapper )`
`47`	`47`	`{`
`48`	`48`	`this.returnType = returnType;`
	`49`	`+ this.objectMapper = objectMapper;`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`@Override`
`52`	`53`	`public T convert( ResponseBody responseBody )`
`53`	`54`	`{`
`54`	`55`	`try`
`55`	`56`	`{`
`56`		`- return OBJECT_MAPPER.readValue( responseBody.charStream(), returnType );`
	`57`	`+ return objectMapper.readValue( responseBody.charStream(), returnType );`
`57`	`58`	`}`
`58`	`59`	`catch ( IOException e )`
`59`	`60`	`{`
`@@ -68,7 +69,7 @@ public T convert( ResponseBody responseBody )`
`68`	`69`	`@Override`
`69`	`70`	`public T convert( List<Map<String, Object>> responseBody )`
`70`	`71`	`{`
`71`		`- return OBJECT_MAPPER.convertValue( responseBody,`
`72`		`- OBJECT_MAPPER.getTypeFactory().constructCollectionLikeType( List.class, returnType ) );`
	`72`	`+ return objectMapper.convertValue( responseBody,`
	`73`	`+ objectMapper.getTypeFactory().constructCollectionLikeType( List.class, returnType ) );`
`73`	`74`	`}`
`74`	`75`	`}`