diff options
Diffstat (limited to 'src/org/traccar/config')
| -rw-r--r-- | src/org/traccar/config/Config.java | 166 | ||||
| -rw-r--r-- | src/org/traccar/config/ConfigKey.java | 36 | ||||
| -rw-r--r-- | src/org/traccar/config/ConfigSuffix.java | 28 | ||||
| -rw-r--r-- | src/org/traccar/config/Keys.java | 356 |
4 files changed, 586 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..2e54ad392 --- /dev/null +++ b/src/org/traccar/config/ConfigKey.java @@ -0,0 +1,36 @@ +/* + * 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; + + ConfigKey(String key, Class clazz) { + this.key = key; + this.clazz = clazz; + } + + String getKey() { + return key; + } + + Class getValueClass() { + return clazz; + } + +} diff --git a/src/org/traccar/config/ConfigSuffix.java b/src/org/traccar/config/ConfigSuffix.java new file mode 100644 index 000000000..149b2cd00 --- /dev/null +++ b/src/org/traccar/config/ConfigSuffix.java @@ -0,0 +1,28 @@ +/* + * 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 ConfigSuffix extends ConfigKey { + + ConfigSuffix(String key, Class clazz) { + super(key, clazz); + } + + public ConfigKey withPrefix(String prefix) { + return new ConfigKey(prefix + getKey(), getValueClass()); + } + +} diff --git a/src/org/traccar/config/Keys.java b/src/org/traccar/config/Keys.java new file mode 100644 index 000000000..48cf3e558 --- /dev/null +++ b/src/org/traccar/config/Keys.java @@ -0,0 +1,356 @@ +/* + * 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 { + + /** + * Connection timeout value in seconds. Because sometimes there is no way to detect lost TCP connection old + * connections stay in open state. On most systems there is a limit on number of open connection, so this leads to + * problems with establishing new connections when number of devices is high or devices data connections are + * unstable. + */ + public static final ConfigSuffix PROTOCOL_TIMEOUT = new ConfigSuffix( + ".timeout", Integer.class); + + /** + * Server wide connection timeout value in seconds. See protocol timeout for more information. + */ + public static final ConfigKey SERVER_TIMEOUT = new ConfigKey( + "server.timeout", Integer.class); + + /** + * Address for uploading aggregated anonymous usage statistics. Uploaded information is the same you can see on the + * statistics screen in the web app. It does not include any sensitive (e.g. locations). + */ + public static final ConfigKey SERVER_STATISTICS = new ConfigKey( + "server.statistics", Boolean.class); + + /** + * Enable events subsystem. Flag to enable all events handlers. + */ + public static final ConfigKey EVENT_ENABLE = new ConfigKey( + "event.enable", Boolean.class); + + /** + * If true, the event is generated once at the beginning of overspeeding period. + */ + public static final ConfigKey EVENT_OVERSPEED_NOT_REPEAT = new ConfigKey( + "event.overspeed.notRepeat", Boolean.class); + + /** + * Minimal over speed duration to trigger the event. Value in seconds. + */ + public static final ConfigKey EVENT_OVERSPEED_MINIMAL_DURATION = new ConfigKey( + "event.overspeed.minimalDuration", Long.class); + + /** + * Relevant only for geofence speed limits. Use lowest speed limits from all geofences. + */ + public static final ConfigKey EVENT_OVERSPEED_PREFER_LOWEST = new ConfigKey( + "event.overspeed.preferLowest", Boolean.class); + + /** + * Do not generate alert event if same alert was present in last known location. + */ + public static final ConfigKey EVENT_IGNORE_DUPLICATE_ALERTS = new ConfigKey( + "event.ignoreDuplicateAlerts", Boolean.class); + + /** + * List of external handler classes to use in Netty pipeline. + */ + public static final ConfigKey EXTRA_HANDLERS = new ConfigKey( + "extra.handlers", String.class); + + /** + * Enable positions forwarding to other web server. + */ + public static final ConfigKey FORWARD_ENABLE = new ConfigKey( + "forward.enable", Boolean.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_URL = new ConfigKey( + "forward.url", String.class); + + /** + * Additional HTTP header, can be used for authorization. + */ + public static final ConfigKey FORWARD_HEADER = new ConfigKey( + "forward.header", String.class); + + /** + * Boolean value to enable forwarding in JSON format. + */ + public static final ConfigKey FORWARD_JSON = new ConfigKey( + "forward.json", Boolean.class); + + /** + * Boolean flag to enable or disable position filtering. + */ + public static final ConfigKey FILTER_ENABLE = new ConfigKey( + "filter.enable", Boolean.class); + + /** + * Filter invalid (valid field is set to false) positions. + */ + public static final ConfigKey FILTER_INVALID = new ConfigKey( + "filter.invalid", Boolean.class); + + /** + * Filter zero coordinates. Zero latitude and longitude are theoretically valid values, but it practice it usually + * indicates invalid GPS data. + */ + public static final ConfigKey FILTER_ZERO = new ConfigKey( + "filter.zero", Boolean.class); + + /** + * Filter duplicate records (duplicates are detected by time value). + */ + public static final ConfigKey FILTER_DUPLICATE = new ConfigKey( + "filter.duplicate", Boolean.class); + + /** + * Filter records with fix time in future. The values is specified in seconds. Records that have fix time more than + * specified number of seconds later than current server time would be filtered out. + */ + public static final ConfigKey FILTER_FUTURE = new ConfigKey( + "filter.future", Long.class); + + /** + * Filter positions with accuracy less than specified value in meters. + */ + public static final ConfigKey FILTER_ACCURACY = new ConfigKey( + "filter.accuracy", Integer.class); + + /** + * Filter cell and wifi locations that are coming from geolocation provider. + */ + public static final ConfigKey FILTER_APPROXIMATE = new ConfigKey( + "filter.approximate", Boolean.class); + + /** + * Filter positions with exactly zero speed values. + */ + public static final ConfigKey FILTER_STATIC = new ConfigKey( + "filter.static", Boolean.class); + + /** + * Filter records by distance. The values is specified in meters. If the new position is less far than this value + * from the last one it gets filtered out. + */ + public static final ConfigKey FILTER_DISTANCE = new ConfigKey( + "filter.distance", Integer.class); + + /** + * Filter records by Maximum Speed value in knots. Can be used to filter jumps to far locations even if they're + * marked as valid. Shouldn't be too low. Start testing with values at about 25000. + */ + public static final ConfigKey FILTER_MAX_SPEED = new ConfigKey( + "filter.maxSpeed", Integer.class); + + /** + * Filter position if time from previous position is less than specified value in seconds. + */ + public static final ConfigKey FILTER_MIN_PERIOD = new ConfigKey( + "filter.minPeriod", Integer.class); + + /** + * Time limit for the filtering in seconds. If the time difference between last position and a new one is more than + * this limit, the new position will not be filtered out. + */ + public static final ConfigKey FILTER_SKIP_LIMIT = new ConfigKey( + "filter.skipLimit", Long.class); + + /** + * Enable attributes skipping. Attribute skipping can be enabled in the config or device attributes. + */ + public static final ConfigKey FILTER_SKIP_ATTRIBUTES_ENABLE = new ConfigKey( + "filter.skipAttributes.enable", Boolean.class); + + /** + * Replaces coordinates with last known if change is less than a 'coordinates.error' meters. Helps to avoid + * coordinates jumps during parking period. + */ + public static final ConfigKey COORDINATES_FILTER = new ConfigKey( + "coordinates.filter", Boolean.class); + + /** + * Distance in meters. Distances below this value gets handled like explained in 'coordinates.filter'. + */ + public static final ConfigKey COORDINATES_MIN_ERROR = new ConfigKey( + "coordinates.minError", Integer.class); + + /** + * Distance in meters. Distances above this value gets handled like explained in 'coordinates.filter', but only if + * Position is also marked as 'invalid'. + */ + public static final ConfigKey COORDINATES_MAX_ERROR = new ConfigKey( + "filter.maxError", Integer.class); + + /** + * Enable to save device IP addresses information. Disabled by default. + */ + public static final ConfigKey PROCESSING_REMOTE_ADDRESS_ENABLE = new ConfigKey( + "processing.remoteAddress.enable", Boolean.class); + + /** + * Enable engine hours calculation on the server side. It uses ignition value to determine engine state. + */ + public static final ConfigKey PROCESSING_ENGINE_HOURS_ENABLE = new ConfigKey( + "processing.engineHours.enable", Boolean.class); + + /** + * Enable copying of missing attributes from last position to the current one. Might be useful if device doesn't + * send some values in every message. + */ + public static final ConfigKey PROCESSING_COPY_ATTRIBUTES_ENABLE = new ConfigKey( + "processing.copyAttributes.enable", Boolean.class); + + /** + * Enable computed attributes processing. + */ + public static final ConfigKey PROCESSING_COMPUTED_ATTRIBUTES_ENABLE = new ConfigKey( + "processing.computedAttributes.enable", Boolean.class); + + /** + * Enable computed attributes processing. + */ + public static final ConfigKey PROCESSING_COMPUTED_ATTRIBUTES_DEVICE_ATTRIBUTES = new ConfigKey( + "processing.computedAttributes.deviceAttributes", Boolean.class); + + /** + * Boolean flag to enable or disable reverse geocoder. + */ + public static final ConfigKey GEOCODER_ENABLE = new ConfigKey( + "geocoder.enable", Boolean.class); + + /** + * Reverse geocoder type. Check reverse geocoding documentation for more info. By default (if the value is not + * specified) server uses Google API. + */ + public static final ConfigKey GEOCODER_TYPE = new ConfigKey( + "geocoder.type", String.class); + + /** + * Geocoder server URL. Applicable only to Nominatim and Gisgraphy providers. + */ + public static final ConfigKey GEOCODER_URL = new ConfigKey( + "geocoder.url", String.class); + + /** + * App id for use with Here provider. + */ + public static final ConfigKey GEOCODER_ID = new ConfigKey( + "geocoder.id", String.class); + + /** + * Provider API key. Most providers require API keys. + */ + public static final ConfigKey GEOCODER_KEY = new ConfigKey( + "geocoder.key", String.class); + + /** + * Language parameter for providers that support localization (e.g. Google and Nominatim). + */ + public static final ConfigKey GEOCODER_LANGUAGE = new ConfigKey( + "geocoder.language", String.class); + + /** + * Address format string. Default value is %h %r, %t, %s, %c. See AddressFormat for more info. + */ + public static final ConfigKey GEOCODER_FORMAT = new ConfigKey( + "geocoder.format", String.class); + + /** + * Cache size for geocoding results. + */ + public static final ConfigKey GEOCODER_CACHE_SIZE = new ConfigKey( + "geocoder.cacheSize", Integer.class); + + /** + * Disable automatic reverse geocoding requests for all positions. + */ + public static final ConfigKey GEOCODER_IGNORE_POSITIONS = new ConfigKey( + "geocoder.ignorePositions", Boolean.class); + + /** + * Boolean flag to apply reverse geocoding to invalid positions. + */ + public static final ConfigKey GEOCODER_PROCESS_INVALID_POSITIONS = new ConfigKey( + "geocoder.processInvalidPositions", Boolean.class); + + /** + * Optional parameter to specify minimum distance for new reverse geocoding request. If distance is less than + * specified value (in meters), then Traccar will reuse last known address. + */ + public static final ConfigKey GEOCODER_REUSE_DISTANCE = new ConfigKey( + "geocoder.reuseDistance", Integer.class); + + /** + * Boolean flag to enable LBS location resolution. Some devices send cell towers information and WiFi point when GPS + * location is not available. Traccar can determine coordinates based on that information using third party + * services. Default value is false. + */ + public static final ConfigKey GEOLOCATION_ENABLE = new ConfigKey( + "geolocation.enable", Boolean.class); + + /** + * Provider to use for LBS location. Available options: google, mozilla and opencellid. By default opencellid is + * used. You have to supply a key that you get from corresponding provider. For more information see LBS geolocation + * documentation. + */ + public static final ConfigKey GEOLOCATION_TYPE = new ConfigKey( + "geolocation.type", String.class); + + /** + * Geolocation provider API URL address. Not required for most providers. + */ + public static final ConfigKey GEOLOCATION_URL = new ConfigKey( + "geolocation.url", String.class); + + /** + * Provider API key. OpenCellID service requires API key. + */ + public static final ConfigKey GEOLOCATION_KEY = new ConfigKey( + "geolocation.key", String.class); + + /** + * Boolean flag to apply geolocation to invalid positions. + */ + public static final ConfigKey GEOLOCATION_PROCESS_INVALID_POSITIONS = new ConfigKey( + "geolocation.processInvalidPositions", Boolean.class); + + /** + * Override latitude sign / hemisphere. Useful in cases where value is incorrect because of device bug. Value can be + * N for North or S for South. + */ + public static final ConfigKey LOCATION_LATITUDE_HEMISPHERE = new ConfigKey( + "location.latitudeHemisphere", Boolean.class); + + /** + * Override longitude sign / hemisphere. Useful in cases where value is incorrect because of device bug. Value can + * be E for East or W for West. + */ + public static final ConfigKey LOCATION_LONGITUDE_HEMISPHERE = new ConfigKey( + "location.longitudeHemisphere", Boolean.class); + + private Keys() { + } + +} |