1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*
* 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);
/**
* 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);
/**
* 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() {
}
}
|
