Refactor configuration

3 files changed, 252 insertions, 0 deletions

diff --git a/src/org/traccar/config/Config.java b/src/org/traccar/config/Config.java
new file mode 100644
index 000000000..d8f2a0e99
--- /dev/null
+++ b/src/org/traccar/config/Config.java
@@ -0,0 +1,166 @@
+/*
+ * Copyright 2015 - 2019 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.config;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.InvalidPropertiesFormatException;
+import java.util.Properties;
+
+public class Config {
+
+    private final Properties properties = new Properties();
+
+    private boolean useEnvironmentVariables;
+
+    public Config() {
+    }
+
+    public Config(String file) throws IOException {
+        try {
+            Properties mainProperties = new Properties();
+            try (InputStream inputStream = new FileInputStream(file)) {
+                mainProperties.loadFromXML(inputStream);
+            }
+
+            String defaultConfigFile = mainProperties.getProperty("config.default");
+            if (defaultConfigFile != null) {
+                try (InputStream inputStream = new FileInputStream(defaultConfigFile)) {
+                    properties.loadFromXML(inputStream);
+                }
+            }
+
+            properties.putAll(mainProperties); // override defaults
+
+            useEnvironmentVariables = Boolean.parseBoolean(System.getenv("CONFIG_USE_ENVIRONMENT_VARIABLES"))
+                    || Boolean.parseBoolean(properties.getProperty("config.useEnvironmentVariables"));
+        } catch (InvalidPropertiesFormatException e) {
+            throw new RuntimeException("Configuration file is not a valid XML document", e);
+        }
+    }
+
+    public boolean hasKey(ConfigKey key) {
+        return hasKey(key.getKey());
+    }
+
+    @Deprecated
+    public boolean hasKey(String key) {
+        return useEnvironmentVariables && System.getenv().containsKey(getEnvironmentVariableName(key))
+                || properties.containsKey(key);
+    }
+
+    public String getString(ConfigKey key) {
+        return getString(key.getKey());
+    }
+
+    @Deprecated
+    public String getString(String key) {
+        if (useEnvironmentVariables) {
+            String value = System.getenv(getEnvironmentVariableName(key));
+            if (value != null && !value.isEmpty()) {
+                return value;
+            }
+        }
+        return properties.getProperty(key);
+    }
+
+    public String getString(ConfigKey key, String defaultValue) {
+        return getString(key.getKey(), defaultValue);
+    }
+
+    @Deprecated
+    public String getString(String key, String defaultValue) {
+        return hasKey(key) ? getString(key) : defaultValue;
+    }
+
+    public boolean getBoolean(ConfigKey key) {
+        return getBoolean(key.getKey());
+    }
+
+    @Deprecated
+    public boolean getBoolean(String key) {
+        return Boolean.parseBoolean(getString(key));
+    }
+
+    public int getInteger(ConfigKey key) {
+        return getInteger(key.getKey());
+    }
+
+    @Deprecated
+    public int getInteger(String key) {
+        return getInteger(key, 0);
+    }
+
+    public int getInteger(ConfigKey key, int defaultValue) {
+        return getInteger(key.getKey(), defaultValue);
+    }
+
+    @Deprecated
+    public int getInteger(String key, int defaultValue) {
+        return hasKey(key) ? Integer.parseInt(getString(key)) : defaultValue;
+    }
+
+    public long getLong(ConfigKey key) {
+        return getLong(key.getKey());
+    }
+
+    @Deprecated
+    public long getLong(String key) {
+        return getLong(key, 0);
+    }
+
+    public long getLong(ConfigKey key, long defaultValue) {
+        return getLong(key.getKey(), defaultValue);
+    }
+
+    @Deprecated
+    public long getLong(String key, long defaultValue) {
+        return hasKey(key) ? Long.parseLong(getString(key)) : defaultValue;
+    }
+
+    public double getDouble(ConfigKey key) {
+        return getDouble(key.getKey());
+    }
+
+    @Deprecated
+    public double getDouble(String key) {
+        return getDouble(key, 0.0);
+    }
+
+    public double getDouble(ConfigKey key, double defaultValue) {
+        return getDouble(key.getKey(), defaultValue);
+    }
+
+    @Deprecated
+    public double getDouble(String key, double defaultValue) {
+        return hasKey(key) ? Double.parseDouble(getString(key)) : defaultValue;
+    }
+
+    public void setString(ConfigKey key, String value) {
+        setString(key.getKey(), value);
+    }
+
+    @Deprecated
+    public void setString(String key, String value) {
+        properties.put(key, value);
+    }
+
+    static String getEnvironmentVariableName(String key) {
+        return key.replaceAll("\\.", "_").replaceAll("(\\p{Lu})", "_$1").toUpperCase();
+    }
+
+}
diff --git a/src/org/traccar/config/ConfigKey.java b/src/org/traccar/config/ConfigKey.java
new file mode 100644
index 000000000..418ab56e4
--- /dev/null
+++ b/src/org/traccar/config/ConfigKey.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2019 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.config;
+
+public class ConfigKey {
+
+    private final String key;
+    private final Class clazz;
+    private final String description;
+
+    ConfigKey(String key, Class clazz, String description) {
+        this.key = key;
+        this.clazz = clazz;
+        this.description = description;
+    }
+
+    String getKey() {
+        return key;
+    }
+
+    Class getValueClass() {
+        return clazz;
+    }
+
+    String getDescription() {
+        return description;
+    }
+
+}
diff --git a/src/org/traccar/config/Keys.java b/src/org/traccar/config/Keys.java
new file mode 100644
index 000000000..90e7de2e5
--- /dev/null
+++ b/src/org/traccar/config/Keys.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2019 Anton Tananaev (anton@traccar.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.traccar.config;
+
+public final class Keys {
+
+    public static final ConfigKey FORWARD_ENABLE = new ConfigKey(
+            "forward.enable",
+            Boolean.class,
+            "Enable positions forwarding to other web server.");
+
+    public static final ConfigKey FORWARD_URL = new ConfigKey(
+            "forward.url",
+            String.class,
+            "URL to forward positions. Data is passed through URL parameters. For example, {uniqueId} for device" +
+                    "identifier, {latitude} and {longitude} for coordinates.");
+
+    public static final ConfigKey FORWARD_HEADER = new ConfigKey(
+            "forward.header",
+            String.class,
+            "Additional HTTP header, can be used for authorization.");
+
+    public static final ConfigKey FORWARD_JSON = new ConfigKey(
+            "forward.json",
+            Boolean.class,
+            "Boolean value to enable forwarding in JSON format.");
+
+    private Keys() {
+    }
+
+}