[DE-452] Typed Config (#480)

* setup MicroProfile Config

* replaced ConfigProvider with ArangoConfigProperties

* extracted ArangoConfigProperties interface

* use HostDescription instead of com.arangodb.config.Host

* ArangoConfigProperties.fromFile

* fixed shaded integration tests

* doc upd

Author: rashtao

ChangeLog.md

@@ -35,8 +35,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ### Added
 
-- added `ArangoDB.Builder.loadProperties(ConfigPropertiesProvider)` to register custom configuration providers
-- added `FileConfigPropertiesProvider` to load properties from local files
+- added `ArangoDB.Builder.loadProperties(ArangoConfigProperties)` to register custom configuration suppliers
+- added `ArangoConfigProperties.fromFile()` to load properties from local files
 - added support to `HTTP/2` communication protocol
 - added optional transitive dependency on `io.vertx:vertx-web-client` (can be excluded if using VST only)
 - added transitive dependency on Jackson Core, Databind and Annotations

docs/v7_detailed_changes.md

@@ -42,16 +42,17 @@ The default communication protocol is now `HTTP2_JSON` (`HTTP/2` with `JSON` con
 The default host configuration to `127.0.0.1:8529` has been removed.
 
 Configuration properties are not read automatically from properties files anymore.
-A new API for loading properties has been introduced: `ArangoDB.Builder.loadProperties(ConfigPropertiesProvider)`. 
+A new API for loading properties has been introduced: `ArangoDB.Builder.loadProperties(ArangoConfigProperties)`. 
 Implementations could supply configuration properties coming from different sources, eg. system properties, remote 
-stores, frameworks facilities, etc. 
-An implementation for loading properties from local files is provided by `FileConfigPropertiesProvider`.
+stores, frameworks facilities, etc.
+An implementation for loading properties from local files is provided by `ArangoConfigProperties.fromFile()` and its 
+overloaded variants.
 
-Here is an example to read config properties from `arangodb.properties` file (same behavior as in version `6`):
+Here is an example to read config properties from `arangodb.properties` file (as in version `6`):
 
 ```java
 ArangoDB adb = new ArangoDB.Builder()
-        .loadProperties(new FileConfigPropertiesProvider())
+        .loadProperties(ArangoConfigProperties.fromFile())
         // ...
         .build();
 ```
@@ -67,10 +68,12 @@ are prefixed with `adb`:
 // ...
 
 ArangoDB adb = new ArangoDB.Builder()
-        .loadProperties(new FileConfigPropertiesProvider("adb", "arangodb-with-prefix.properties"))
+        .loadProperties(new FileConfigPropertiesProvider("arangodb-with-prefix.properties", "adb"))
         .build();
 ```
 
+An example showing how to provide configuration using Eclipse MicroProfile Config can be found 
+[here](../driver/src/test/java/com/arangodb/config).
 
 ## Transitive dependencies
 

driver/pom.xml

@@ -251,6 +251,12 @@
             <version>1.8</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.smallrye.config</groupId>
+            <artifactId>smallrye-config-core</artifactId>
+            <version>3.1.1</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 </project>

driver/src/main/java/com/arangodb/ArangoDB.java

@@ -20,8 +20,7 @@
 
 package com.arangodb;
 
-import com.arangodb.config.ConfigPropertiesProvider;
-import com.arangodb.config.ConfigPropertyKey;
+import com.arangodb.config.ArangoConfigProperties;
 import com.arangodb.entity.*;
 import com.arangodb.internal.ArangoDBImpl;
 import com.arangodb.internal.ArangoDefaults;
@@ -336,19 +335,12 @@ public interface ArangoDB extends ArangoSerdeAccessor {
      */
     class Builder extends InternalArangoDBBuilder {
 
-        protected Protocol protocol = ArangoDefaults.DEFAULT_NETWORK_PROTOCOL;
-
         public Builder() {
             super();
         }
 
-        private static Protocol loadProtocol(final ConfigPropertiesProvider properties, final Protocol currentValue) {
-            return Protocol.valueOf(getProperty(properties, ConfigPropertyKey.PROTOCOL, currentValue).toUpperCase(Locale.ROOT));
-        }
-
-        public Builder loadProperties(final ConfigPropertiesProvider properties) {
+        public Builder loadProperties(final ArangoConfigProperties properties) {
             doLoadProperties(properties);
-            protocol = loadProtocol(properties, protocol);
             return this;
         }
 

driver/src/main/java/com/arangodb/async/ArangoDBAsync.java

@@ -24,7 +24,7 @@
 import com.arangodb.async.internal.ArangoDBAsyncImpl;
 import com.arangodb.async.internal.velocystream.VstCommunicationAsync;
 import com.arangodb.async.internal.velocystream.VstConnectionFactoryAsync;
-import com.arangodb.config.ConfigPropertiesProvider;
+import com.arangodb.config.ArangoConfigProperties;
 import com.arangodb.entity.*;
 import com.arangodb.internal.ArangoDefaults;
 import com.arangodb.internal.InternalArangoDBBuilder;
@@ -315,7 +315,7 @@ public Builder() {
             super();
         }
 
-        public Builder loadProperties(final ConfigPropertiesProvider config) {
+        public Builder loadProperties(final ArangoConfigProperties config) {
             super.doLoadProperties(config);
             return this;
         }

driver/src/main/java/com/arangodb/async/internal/velocystream/VstCommunicationAsync.java

@@ -22,7 +22,7 @@
 
 import com.arangodb.ArangoDBException;
 import com.arangodb.internal.net.ArangoDBRedirectException;
-import com.arangodb.internal.net.HostDescription;
+import com.arangodb.config.HostDescription;
 import com.arangodb.internal.net.HostHandle;
 import com.arangodb.internal.net.HostHandler;
 import com.arangodb.internal.serde.InternalSerde;

driver/src/main/java/com/arangodb/async/internal/velocystream/VstConnectionAsync.java

@@ -21,7 +21,7 @@
 package com.arangodb.async.internal.velocystream;
 
 import com.arangodb.async.internal.utils.CompletableFutureUtils;
-import com.arangodb.internal.net.HostDescription;
+import com.arangodb.config.HostDescription;
 import com.arangodb.internal.velocystream.internal.Chunk;
 import com.arangodb.internal.velocystream.internal.Message;
 import com.arangodb.internal.velocystream.internal.MessageStore;

driver/src/main/java/com/arangodb/async/internal/velocystream/VstConnectionFactoryAsync.java

@@ -22,7 +22,7 @@
 
 import com.arangodb.internal.net.Connection;
 import com.arangodb.internal.net.ConnectionFactory;
-import com.arangodb.internal.net.HostDescription;
+import com.arangodb.config.HostDescription;
 import com.arangodb.internal.velocystream.internal.MessageStore;
 
 import javax.net.ssl.SSLContext;

driver/src/main/java/com/arangodb/config/ArangoConfigProperties.java

@@ -0,0 +1,100 @@
+package com.arangodb.config;
+
+import com.arangodb.Protocol;
+import com.arangodb.entity.LoadBalancingStrategy;
+import com.arangodb.internal.config.ArangoConfigPropertiesImpl;
+
+import java.util.List;
+import java.util.Optional;
+
+public interface ArangoConfigProperties {
+
+    /**
+     * Reads properties from file arangodb.properties.
+     * Properties must be prefixed with @{code "arangodb"}, eg. @{code "arangodb.hosts=localhost:8529"}.
+     */
+    static ArangoConfigProperties fromFile() {
+        return new ArangoConfigPropertiesImpl();
+    }
+
+    /**
+     * Reads properties from file {@code fileName}.
+     * Properties must be prefixed with @{code "arangodb"}, eg. @{code "arangodb.hosts=localhost:8529"}.
+     */
+    static ArangoConfigProperties fromFile(final String fileName) {
+        return new ArangoConfigPropertiesImpl(fileName);
+    }
+
+    /**
+     * Reads properties from file {@code fileName}.
+     * Properties must be prefixed with @{code prefix}, eg. @{code "<prefix>.hosts=localhost:8529"}.
+     */
+    static ArangoConfigProperties fromFile(final String fileName, final String prefix) {
+        return new ArangoConfigPropertiesImpl(fileName, prefix);
+    }
+
+    default Optional<List<HostDescription>> getHosts() {
+        return Optional.empty();
+    }
+
+    default Optional<Protocol> getProtocol() {
+        return Optional.empty();
+    }
+
+    default Optional<String> getUser() {
+        return Optional.empty();
+    }
+
+    default Optional<String> getPassword() {
+        return Optional.empty();
+    }
+
+    default Optional<String> getJwt() {
+        return Optional.empty();
+    }
+
+    default Optional<Integer> getTimeout() {
+        return Optional.empty();
+    }
+
+    default Optional<Boolean> getUseSsl() {
+        return Optional.empty();
+    }
+
+    default Optional<Boolean> getVerifyHost() {
+        return Optional.empty();
+    }
+
+    default Optional<Integer> getChunkSize() {
+        return Optional.empty();
+    }
+
+    default Optional<Integer> getMaxConnections() {
+        return Optional.empty();
+    }
+
+    default Optional<Long> getConnectionTtl() {
+        return Optional.empty();
+    }
+
+    default Optional<Integer> getKeepAliveInterval() {
+        return Optional.empty();
+    }
+
+    default Optional<Boolean> getAcquireHostList() {
+        return Optional.empty();
+    }
+
+    default Optional<Integer> getAcquireHostListInterval() {
+        return Optional.empty();
+    }
+
+    default Optional<LoadBalancingStrategy> getLoadBalancingStrategy() {
+        return Optional.empty();
+    }
+
+    default Optional<Integer> getResponseQueueTimeSamples() {
+        return Optional.empty();
+    }
+
+}