Skip to content

Package: SystemSettingKey

SystemSettingKey

nameinstructionbranchcomplexitylinemethod
SystemSettingKey(String, int, String)
M: 8 C: 0
0%
M: 0 C: 0
100%
M: 1 C: 0
0%
M: 3 C: 0
0%
M: 1 C: 0
0%
key()
M: 3 C: 0
0%
M: 0 C: 0
100%
M: 1 C: 0
0%
M: 1 C: 0
0%
M: 1 C: 0
0%
static {...}
M: 686 C: 0
0%
M: 0 C: 0
100%
M: 1 C: 0
0%
M: 63 C: 0
0%
M: 1 C: 0
0%

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2016, 2020 Eurotech and/or its affiliates and others
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License v1.0
6: * which accompanies this distribution, and is available at
7: * http://www.eclipse.org/legal/epl-v10.html
8: *
9: * Contributors:
10: * Eurotech - initial API and implementation
11: *******************************************************************************/
12: package org.eclipse.kapua.commons.setting.system;
13:
14: import javax.persistence.EntityExistsException;
15:
16: import org.eclipse.kapua.commons.setting.SettingKey;
17:
18: /**
19: * Setting system key implementation.
20: *
21: * @since 1.0
22: */
23: public enum SystemSettingKey implements SettingKey {
24: /**
25: * Provisioning account name
26: */
27: SYS_PROVISION_ACCOUNT_NAME("commons.sys.provision.account.name"),
28: /**
29: * System administration account name
30: */
31: SYS_ADMIN_ACCOUNT("commons.sys.admin.account"),
32: /**
33: * System administration user name
34: */
35: SYS_ADMIN_USERNAME("commons.sys.admin.userName"),
36:
37: /**
38: * Software version
39: */
40: VERSION("commons.version"),
41: /**
42: * Build version
43: */
44: BUILD_VERSION("commons.build.version"),
45: /**
46: * Build number
47: */
48: BUILD_NUMBER("commons.build.number"),
49:
50: /**
51: * Character encoding
52: */
53: CHAR_ENCODING("character.encoding"),
54:
55: /**
56: * Jdbc url connection resolver implementation
57: */
58: DB_JDBC_CONNECTION_URL_RESOLVER("commons.db.jdbcConnectionUrlResolver"),
59:
60: /**
61: * Database name
62: */
63: DB_NAME("commons.db.name"),
64: /**
65: * Database username
66: */
67: DB_USERNAME("commons.db.username"),
68: /**
69: * Database password
70: */
71: DB_PASSWORD("commons.db.password"),
72:
73: /**
74: * Database jdbc driver class
75: */
76: DB_JDBC_DRIVER("commons.db.jdbc.driver"),
77: /**
78: * Database connection schema
79: */
80: DB_CONNECTION_SCHEME("commons.db.connection.scheme"),
81: /**
82: * Database host
83: */
84: DB_CONNECTION_HOST("commons.db.connection.host"),
85: /**
86: * Database port
87: */
88: DB_CONNECTION_PORT("commons.db.connection.port"),
89: /**
90: * Database use ssl connection
91: */
92: DB_CONNECTION_USE_SSL("commons.db.connection.useSsl"),
93: /**
94: * Database TLS/SSL Protocol Version Selection (for MariaDB only)
95: */
96: DB_CONNECTION_ENABLED_SSL_PROTOCOL_SUITES("commons.db.connection.enabledSslProtocolSuites"),
97: /**
98: * Database truststore url
99: */
100: DB_CONNECTION_TRUSTSTORE_URL("commons.db.connection.trust.store.url"),
101: /**
102: * Database truststore password
103: */
104: DB_CONNECTION_TRUSTSTORE_PWD("commons.db.connection.trust.store.pwd"),
105: /**
106: * Any additional option that can be passed to the JDBC connection string
107: */
108: DB_CONNECTION_ADDITIONAL_OPTIONS("commons.db.connection.additionalOptions"),
109: /**
110: * Database schema name
111: */
112: DB_SCHEMA("commons.db.schema"),
113:
114: /**
115: * Database schema name
116: */
117: DB_SCHEMA_ENV("COMMONS_DB_SCHEMA"),
118:
119: /**
120: * Update database schema on startup
121: */
122: DB_SCHEMA_UPDATE("commons.db.schema.update"),
123:
124: /**
125: * Database timezone to use
126: */
127: DB_USE_TIMEZONE("commons.db.useTimezone"),
128: /**
129: * Database use legacy date time flag
130: */
131: DB_USE_LEGACY_DATETIME_CODE("commons.db.useLegacyDatetimeCode"),
132: /**
133: * Database server timezone
134: */
135: DB_SERVER_TIMEZONE("commons.db.serverTimezone"),
136: /**
137: * Database character encoding
138: */
139: DB_CHAR_ENCODING("commons.db.characterEncoding"),
140:
141: /**
142: * Database pool initial pool size
143: */
144: DB_POOL_SIZE_INITIAL("commons.db.pool.size.initial"),
145: /**
146: * Database pool minimum pool size
147: */
148: DB_POOL_SIZE_MIN("commons.db.pool.size.min"),
149: /**
150: * Database pool maximum pool size
151: */
152: DB_POOL_SIZE_MAX("commons.db.pool.size.max"),
153: /**
154: * Database pool connection borrow timeout
155: */
156: DB_POOL_BORROW_TIMEOUT("commons.db.pool.borrow.timeout"),
157: /**
158: * Character used in DB query to escape other special characters
159: */
160: DB_CHARACTER_ESCAPE("commons.db.character.escape"),
161: /**
162: * Character used in DB query to use as wildcard
163: */
164: DB_CHARACTER_WILDCARD_ANY("commons.db.character.wildcard.any"),
165: /**
166: * Character used in DB query to use as single character wildcard
167: */
168: DB_CHARACTER_WILDCARD_SINGLE("commons.db.character.wildcard.single"),
169:
170: /**
171: * Broker schema (e.g. mqtt, mqtts, ..)
172: */
173: BROKER_SCHEME("broker.scheme"),
174: /**
175: * Broker host
176: */
177: BROKER_HOST("broker.host"),
178: /**
179: * Broker internal port
180: */
181: BROKER_INTERNAL_CONNECTOR_PORT("broker.connector.internal.port"),
182: /**
183: * Broker internal connector name
184: */
185: BROKER_INTERNAL_CONNECTOR_NAME("broker.connector.internal.name"),
186: /**
187: * Internal connector username
188: */
189: BROKER_INTERNAL_CONNECTOR_USERNAME("broker.connector.internal.username"),
190: /**
191: * Internal connector password
192: */
193: BROKER_INTERNAL_CONNECTOR_PASSWORD("broker.connector.internal.password"),
194:
195: /**
196: * Metrics JMX disabled
197: */
198: METRICS_ENABLE_JMX("metrics.enable.jmx"),
199:
200: /**
201: * Set the Kapua key size (the size is expressed in bits)
202: */
203: KAPUA_KEY_SIZE("commons.entity.key.size"),
204:
205: /**
206: * Maximum allowed retry (due to a {@link EntityExistsException}, so already exists key) on insert operation
207: */
208: KAPUA_INSERT_MAX_RETRY("commons.entity.insert.max.retry"),
209:
210: /**
211: * Url of the event bus
212: */
213: EVENT_BUS_URL("commons.eventbus.url"),
214:
215: /**
216: * Username to connect to the event bus
217: */
218: EVENT_BUS_USERNAME("commons.eventbus.username"),
219:
220: /**
221: * Password to connect to the event bus
222: */
223: EVENT_BUS_PASSWORD("commons.eventbus.password"),
224:
225: /**
226: * Producers pool min size (per microservice)
227: */
228: EVENT_BUS_PRODUCER_POOL_MIN_SIZE("commons.eventbus.producerPool.minSize"),
229:
230: /**
231: * Producers pool max size (per microservice)
232: */
233: EVENT_BUS_PRODUCER_POOL_MAX_SIZE("commons.eventbus.producerPool.maxSize"),
234:
235: /**
236: * Producers pool max wait on borrow
237: */
238: EVENT_BUS_PRODUCER_POOL_BORROW_WAIT_MAX("commons.eventbus.producerPool.maxWaitOnBorrow"),
239:
240: /**
241: * Producers pool eviction interval
242: */
243: EVENT_BUS_PRODUCER_EVICTION_INTERVAL("commons.eventbus.producerPool.evictionInterval"),
244:
245: /**
246: * Consumers pool size (per microservice)
247: */
248: EVENT_BUS_CONSUMER_POOL_SIZE("commons.eventbus.consumerPool.size"),
249:
250: /**
251: * Event message serializer class
252: */
253: EVENT_BUS_MESSAGE_SERIALIZER("commons.eventbus.messageSerializer"),
254:
255: /**
256: * If true the transport will use the native Epoll layer when available instead of the NIO layer.
257: */
258: EVENT_BUS_TRANSPORT_USE_EPOLL("commons.eventbus.transport.useEpoll"),
259:
260: /**
261: * Wait time between housekeeper executions (in milliseconds)
262: */
263: HOUSEKEEPER_EXECUTION_WAIT_TIME("commons.eventbus.houskeeper.waitTime"),
264: /**
265: * Housekeeper event scan window
266: */
267: HOUSEKEEPER_EVENT_SCAN_WINDOW("commons.eventbus.houskeeper.eventScanWindow"),
268: /**
269: * Time window to consider FIRED messages as "old" messages so ready to be processed by the housekeeper (in milliseconds)
270: */
271: HOUSEKEEPER_OLD_MESSAGES_TIME_WINDOW("commons.eventbus.houskeeper.oldMessagesTimeWindow"),
272: /**
273: * Allow System Settings to be updatable at runtime via System.setProperty()
274: */
275: SETTINGS_HOTSWAP("commons.settings.hotswap"),
276:
277: /**
278: * Provide the classname for the Cache Provider
279: */
280: CACHING_PROVIDER("commons.cache.provider.classname"),
281: /**
282: * Size of the local cache for the KapuaTmetadata
283: */
284: TMETADATA_LOCAL_CACHE_SIZE_MAXIMUM("commons.cache.local.tmetadata.maxsize"),
285: /**
286: * Provide the CacheManager config file URL
287: */
288: CACHE_CONFIG_URL("commons.cache.config.url"),
289: /**
290: * Provide the Cache TTL
291: */
292: CACHE_TTL("commons.cache.config.ttl"),
293: /**
294: * Provide the JCache Expiry Policy. Allowed values: MODIFIED, TOUCHED
295: */
296: JCACHE_EXPIRY_POLICY("commons.cache.config.expiryPolicy");
297:
298: private String key;
299:
300: /**
301: * Constructor
302: *
303: * @param key
304: */
305: private SystemSettingKey(String key) {
306: this.key = key;
307: }
308:
309: @Override
310: public String key() {
311: return key;
312: }
313: }