Improved Switcher Context Base configuration options (#325)

* Improved Switcher Context Base configuration options (#324)

* Improved Switcher Context Base configuration options

* Fixes code smells

* Added regexTimeout configuration

Author: petruki

README.md

@@ -101,14 +101,35 @@ MyAppFeatures.initializeClient();
 ```
 
 Or simply define a custom file properties to load everything from it.
-
 ```
 // Load from resources/switcherapi-test.properties 
 MyAppFeatures.loadProperties("switcherapi-test");
 ```
 
+Or using configureClient() with @PostConstruct to handle all the configuration build boilerplate.
+
+```java
+@ConfigurationProperties
+class MySwitcherClientConfig extends SwitcherContextBase {
+
+	@SwitcherKey
+	public static final String MY_SWITCHER = "MY_SWITCHER";
+	
+	@Override
+	@PostConstruct
+	public void configureClient() {
+		// you can add pre-configuration here
+		super.configureClient();
+		// you can add post-configuration here
+	}
+}
+```
+
 ### Defining your features
 
+Create a class that extends SwitcherContext if you are loading the configuration from the switcherapi.properties file.
+Or use SwitcherContextBase to define the configuration using the ContextBuilder or SwitcherConfig.
+
 ```java
 public class MyAppFeatures extends SwitcherContext {
 

pom.xml

@@ -84,7 +84,8 @@
 		<sonar.coverage.exclusions>
 			**/model/**/*.java,
 			**/exception/**/*.java,
-			**/service/validators/RegexValidatorV8.java
+			**/service/validators/RegexValidatorV8.java,
+			**/client/remote/Constants.java
 		</sonar.coverage.exclusions>
 	</properties>
 

src/main/java/com/github/switcherapi/client/ContextBuilder.java

@@ -3,6 +3,12 @@
 import com.github.switcherapi.client.model.ContextKey;
 import org.apache.commons.lang3.StringUtils;
 
+import java.util.Optional;
+
+import static com.github.switcherapi.client.SwitcherProperties.DEFAULT_REGEX_TIMEOUT;
+import static com.github.switcherapi.client.SwitcherProperties.DEFAULT_TIMEOUT_MS;
+import static com.github.switcherapi.client.remote.Constants.DEFAULT_POOL_SIZE;
+
 public class ContextBuilder {
 
 	private static ContextBuilder context;
@@ -130,8 +136,9 @@ public ContextBuilder snapshotAutoUpdateInterval(String snapshotAutoUpdateInterv
 	 * @param regexTimeout Time in ms given to Timed Match Worker used for local Regex (ReDoS safety mechanism) - 3000 default value
 	 * @return ContextBuilder
 	 */
-	public ContextBuilder regexTimeout(int regexTimeout) {
-		properties.setValue(ContextKey.REGEX_TIMEOUT, regexTimeout);
+	public ContextBuilder regexTimeout(Integer regexTimeout) {
+		properties.setValue(ContextKey.REGEX_TIMEOUT,
+				Optional.ofNullable(regexTimeout).orElse(DEFAULT_REGEX_TIMEOUT));
 		return this;
 	}
 
@@ -198,17 +205,19 @@ public ContextBuilder truststorePassword(String truststorePassword) {
 	 * @param timeoutMs Time in ms given to the API to respond - 3000 default value
 	 * @return ContextBuilder
 	 */
-    public ContextBuilder timeoutMs(int timeoutMs) {
-		properties.setValue(ContextKey.TIMEOUT_MS, timeoutMs);
+    public ContextBuilder timeoutMs(Integer timeoutMs) {
+		properties.setValue(ContextKey.TIMEOUT_MS,
+				Optional.ofNullable(timeoutMs).orElse(DEFAULT_TIMEOUT_MS));
 		return this;
 	}
 
 	/**
 	 * @param poolSize Number of threads for the pool connection - 10 default value
 	 * @return ContextBuilder
 	 */
-	public ContextBuilder poolConnectionSize(int poolSize) {
-		properties.setValue(ContextKey.POOL_CONNECTION_SIZE, poolSize);
+	public ContextBuilder poolConnectionSize(Integer poolSize) {
+		properties.setValue(ContextKey.POOL_CONNECTION_SIZE,
+				Optional.ofNullable(poolSize).orElse(DEFAULT_POOL_SIZE));
 		return this;
 	}
 }

src/main/java/com/github/switcherapi/client/SwitcherConfig.java

@@ -0,0 +1,144 @@
+package com.github.switcherapi.client;
+
+abstract class SwitcherConfig {
+
+	protected String contextLocation;
+	protected String url;
+	protected String apikey;
+	protected String domain;
+	protected String component;
+	protected String environment;
+
+	protected boolean local;
+	protected String silent;
+	protected Integer timeout;
+	protected Integer regexTimeout;
+	protected Integer poolSize;
+	protected SnapshotConfig snapshot;
+	protected TruststoreConfig truststore;
+
+	SwitcherConfig() {
+		this.snapshot = new SnapshotConfig();
+		this.truststore = new TruststoreConfig();
+	}
+
+	/**
+	 * Initialize the Switcher Client.<br>
+	 * - Build context {@link ContextBuilder}<br>
+	 * - Configure context {@link SwitcherContextBase#configure(ContextBuilder)}<br>
+	 * - Initialize client {@link SwitcherContextBase#initializeClient()}<br>
+	 */
+	protected abstract void configureClient();
+
+	public void setContextLocation(String contextLocation) {
+		this.contextLocation = contextLocation;
+	}
+
+	public void setUrl(String url) {
+		this.url = url;
+	}
+
+	public void setApikey(String apikey) {
+		this.apikey = apikey;
+	}
+
+	public void setDomain(String domain) {
+		this.domain = domain;
+	}
+
+	public void setComponent(String component) {
+		this.component = component;
+	}
+
+	public void setEnvironment(String environment) {
+		this.environment = environment;
+	}
+
+	public void setLocal(boolean local) {
+		this.local = local;
+	}
+
+	public void setSilent(String silent) {
+		this.silent = silent;
+	}
+
+	public void setTimeout(Integer timeout) {
+		this.timeout = timeout;
+	}
+
+	public void setRegexTimeout(Integer regexTimeout) {
+		this.regexTimeout = regexTimeout;
+	}
+
+	public void setPoolSize(Integer poolSize) {
+		this.poolSize = poolSize;
+	}
+
+	public void setSnapshot(SnapshotConfig snapshot) {
+		this.snapshot = snapshot;
+	}
+
+	public void setTruststore(TruststoreConfig truststore) {
+		this.truststore = truststore;
+	}
+
+	public static class SnapshotConfig {
+		private String location;
+		private boolean auto;
+		private boolean skipValidation;
+		private String updateInterval;
+
+		public String getLocation() {
+			return location;
+		}
+
+		public void setLocation(String location) {
+			this.location = location;
+		}
+
+		public boolean isAuto() {
+			return auto;
+		}
+
+		public void setAuto(boolean auto) {
+			this.auto = auto;
+		}
+
+		public boolean isSkipValidation() {
+			return skipValidation;
+		}
+
+		public void setSkipValidation(boolean skipValidation) {
+			this.skipValidation = skipValidation;
+		}
+
+		public String getUpdateInterval() {
+			return updateInterval;
+		}
+
+		public void setUpdateInterval(String updateInterval) {
+			this.updateInterval = updateInterval;
+		}
+	}
+
+	public static class TruststoreConfig {
+		private String path;
+		private String password;
+
+		public String getPath() {
+			return path;
+		}
+
+		public void setPath(String path) {
+			this.path = path;
+		}
+
+		public String getPassword() {
+			return password;
+		}
+
+		public void setPassword(String password) {
+			this.password = password;
+		}
+	}
+}

src/main/java/com/github/switcherapi/client/SwitcherContext.java

@@ -6,7 +6,7 @@
 import com.github.switcherapi.client.model.Switcher;
 
 /**
- * <b>Switcher Context Toolkit</b>
+ * <b>Switcher Context</b>
  * <p>
  * 
  * This class will load Switcher Properties internally, making it ready to use.