/**
* Create element configuration for MonogoDB tenant datastore.
*
* @return
*/
protected ElementNode createMongoTenantDatastoreElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"MongoDB Tenant Datastore",
TenantDatastoreParser.Elements.MongoTenantDatastore.getLocalName(),
"database",
ElementRole.DataManagement_Datastore);
builder.description(
"Store tenant data using a MongoDB database. Note that the "
+ "global datastore must be configured to use MongoDB if this tenant datastore is to "
+ "be used. Most core MongoDB settings are configured at the global level.");
builder.attributeGroup("bulk", "Bulk Insert for Events");
builder.attribute(
(new AttributeNode.Builder("Use bulk inserts", "useBulkEventInserts", AttributeType.Boolean)
.description(
"Use the MongoDB bulk insert API to add "
+ "events in groups and improve performance.")
.group("bulk")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Bulk insert max chunk size", "bulkInsertMaxChunkSize", AttributeType.Integer)
.description(
"Maximum number of records to send "
+ "in a single bulk insert (if bulk inserts are enabled).")
.group("bulk")
.build()));
return builder.build();
}
/**
* Create the container for datastore information.
*
* @return
*/
protected ElementNode createDataManagement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"Data Management",
TenantConfigurationParser.Elements.TenantDatastore.getLocalName(),
"database",
ElementRole.DataManagement);
builder.description(
"Configure the datastore and related aspects such as caching and "
+ "data model initialization.");
return builder.build();
}
/**
* Create element configuration for HBase tenant datastore.
*
* @return
*/
protected ElementNode createHBaseTenantDatastoreElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"HBase Tenant Datastore",
TenantDatastoreParser.Elements.HBaseTenantDatastore.getLocalName(),
"database",
ElementRole.DataManagement_Datastore);
builder.description(
"Store tenant data using tables in an HBase instance. Note that the "
+ "global datastore must be configured to use HBase if this tenant datastore is to "
+ "be used. Most core HBase settings are configured at the global level.");
return builder.build();
}
/**
* Create element configuration for Hazelcast cache.
*
* @return
*/
@SuppressWarnings("deprecation")
protected ElementNode createHazelcastCacheElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"Hazelcast Distributed Cache Provider",
TenantDatastoreParser.Elements.HazelcastCache.getLocalName(),
"folder-open-o",
ElementRole.DataManagement_CacheProvider);
builder.description(
"Cache device management data using Hazelcast distributed maps. "
+ "This cache allows data to be shared between clustered SiteWhere instances. "
+ "This element has been deprecated since a Hazelcast cache is used by default.");
builder.makeDeprecated();
return builder.build();
}
/**
* Create element configuration for device model initializer.
*
* @return
*/
@SuppressWarnings("deprecation")
protected ElementNode createDefaultScheduleModelInitializerElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"Default Schedule Model Initializer",
TenantDatastoreParser.Elements.DefaultScheduleModelInitializer.getLocalName(),
"flash",
ElementRole.DataManagement_ScheduleModelInitializer);
builder.description(
"This component creates sample data when no existing schedule data "
+ "is detected in the datastore. It provides examples of both simple and cron-based "
+ "schedules that are commonly used. "
+ "<strong>Deprecated: Initialization is now done based on the tenant template.</strong>");
builder.makeDeprecated();
return builder.build();
}
/**
* Create element configuration for device model initializer.
*
* @return
*/
@SuppressWarnings("deprecation")
protected ElementNode createDefaultAssetModelInitializerElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"Default Asset Model Initializer",
TenantDatastoreParser.Elements.DefaultAssetModelInitializer.getLocalName(),
"flash",
ElementRole.DataManagement_AssetModelInitializer);
builder.description(
"This component creates sample data when no existing asset data "
+ "is detected in the datastore. If using the <strong>device model initializer</strong> "
+ "this component should be used as well so that assets in the sample data can be resolved. "
+ "<strong>Deprecated: Initialization is now done based on the tenant template.</strong>");
builder.makeDeprecated();
return builder.build();
}
/**
* Create element configuration for device model initializer.
*
* @return
*/
@SuppressWarnings("deprecation")
protected ElementNode createDefaultDeviceModelInitializerElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"Default Device Model Initializer",
TenantDatastoreParser.Elements.DefaultDeviceModelInitializer.getLocalName(),
"flash",
ElementRole.DataManagement_DeviceModelInitializer);
builder.description(
"This component creates sample data when no existing device data "
+ "is detected in the datastore. A site with device specifications, devices, "
+ "assignments, events and other example data is created on instance startup. "
+ "<strong>Deprecated: Initialization is now done based on the tenant template.</strong>");
builder.makeDeprecated();
return builder.build();
}
/**
* Create element configuration for Groovy device model initializer.
*
* @return
*/
@SuppressWarnings("deprecation")
protected ElementNode createGroovyDeviceModelInitializerElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"Groovy Device Model Initializer",
TenantDatastoreParser.Elements.GroovyDeviceModelInitializer.getLocalName(),
"cogs",
ElementRole.DataManagement_DeviceModelInitializer);
builder.description(
"Generates sample data for the device model by delegating creation logic to a Groovy script. "
+ "<strong>Deprecated: Initialization is now done based on the tenant template.</strong>");
builder.attribute(
(new AttributeNode.Builder("Script path", "scriptPath", AttributeType.String)
.description("Script path relative to Groovy script root.")
.makeRequired()
.build()));
builder.makeDeprecated();
return builder.build();
}
/**
* Create element configuration for EHCache cache.
*
* @return
*/
@SuppressWarnings("deprecation")
protected ElementNode createEHCacheElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"EHCache Cache Provider",
TenantDatastoreParser.Elements.EHCacheDeviceManagementCache.getLocalName(),
"folder-open-o",
ElementRole.DataManagement_CacheProvider);
builder.description(
"Cache device management data using EHCache. Note that this "
+ "cache is not intended for use on clustered installations. "
+ "This element has been deprecated in favor of using the Hazelcast cache.");
builder.attributeGroup("max", "Max Entries in Cache");
builder.attributeGroup("ttl", "Cache Entry Time to Live");
builder.attribute(
(new AttributeNode.Builder(
"Site cache max entries", "siteCacheMaxEntries", AttributeType.Integer)
.description("Maximum number entries in site cache.")
.defaultValue("1000")
.group("max")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Specification cache max entries",
"deviceSpecificationCacheMaxEntries",
AttributeType.Integer)
.description("Maximum number entries in device specification cache.")
.defaultValue("1000")
.group("max")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Device cache max entries", "deviceCacheMaxEntries", AttributeType.Integer)
.description("Maximum number entries in device cache.")
.defaultValue("10000")
.group("max")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Assignment cache max entries",
"deviceAssignmentCacheMaxEntries",
AttributeType.Integer)
.description("Maximum number entries in device assignment cache.")
.defaultValue("10000")
.group("max")
.build()));
builder.attribute(
(new AttributeNode.Builder("Site cache TTL seconds", "siteCacheTtl", AttributeType.Integer)
.description("Maximum time to live (in seconds) for site cache.")
.defaultValue("6000")
.group("ttl")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Specification cache TTL seconds",
"deviceSpecificationCacheTtl",
AttributeType.Integer)
.description("Maximum time to live (in seconds) for device specification cache.")
.defaultValue("6000")
.group("ttl")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Device cache TTL seconds", "deviceCacheTtl", AttributeType.Integer)
.description("Maximum time to live (in seconds) for device cache.")
.defaultValue("600")
.group("ttl")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Assignment cache TTL seconds", "deviceAssignmentCacheTtl", AttributeType.Integer)
.description("Maximum time to live (in seconds) for device assignment cache.")
.defaultValue("600")
.group("ttl")
.build()));
builder.makeDeprecated();
return builder.build();
}
/**
* Create element configuration for MonogoDB/InfluxDB tenant datastore.
*
* @return
*/
protected ElementNode createMongoInfluxDbTenantDatastoreElement() {
ElementNode.Builder builder =
new ElementNode.Builder(
"MongoDB/InfluxDB Tenant Datastore",
TenantDatastoreParser.Elements.MongoInfluxDbTenantDatastore.getLocalName(),
"database",
ElementRole.DataManagement_Datastore);
builder.description(
"Store tenant master data using a MongoDB database and store tenant event "
+ "data in InfluxDB. Note that the global datastore must be configured to "
+ "use MongoDB if this tenant datastore is to be used. Most core "
+ "MongoDB settings are configured at the global level.");
builder.attributeGroup("conn", "InfluxDB Connectivity");
builder.attribute(
(new AttributeNode.Builder("Connection URL", "connectUrl", AttributeType.String)
.description("Specifies URL used to connect to InfluxDB.")
.group("conn")
.defaultValue("http://localhost:8086")
.build()));
builder.attribute(
(new AttributeNode.Builder("Username", "username", AttributeType.String)
.description("Username for InfluxDB authentication.")
.group("conn")
.defaultValue("root")
.build()));
builder.attribute(
(new AttributeNode.Builder("Password", "password", AttributeType.String)
.description("Password for InfluxDB authentication.")
.group("conn")
.defaultValue("root")
.build()));
builder.attribute(
(new AttributeNode.Builder("Database", "database", AttributeType.String)
.description("InfluxDB database name.")
.group("conn")
.defaultValue("sitewhere")
.build()));
builder.attribute(
(new AttributeNode.Builder("Retention policy", "retention", AttributeType.String)
.description("InfluxDB retention policy name.")
.group("conn")
.defaultValue("autogen")
.build()));
builder.attribute(
(new AttributeNode.Builder("Log level", "logLevel", AttributeType.String)
.description("Log level for debugging InfluxDB interactions.")
.group("conn")
.choice("none")
.choice("basic")
.choice("headers")
.choice("full")
.defaultValue("none")
.build()));
builder.attributeGroup("batch", "InfluxDB Batch Event Processing");
builder.attribute(
(new AttributeNode.Builder("Enable batch processing", "enableBatch", AttributeType.Boolean)
.description("Enable delivery of events in batches.")
.group("batch")
.defaultValue("true")
.build()));
builder.attribute(
(new AttributeNode.Builder("Max batch chunk size", "batchChunkSize", AttributeType.Integer)
.description("Maximum number of events to send in a batch.")
.group("batch")
.defaultValue("1000")
.build()));
builder.attribute(
(new AttributeNode.Builder(
"Max batch send interval (ms)", "batchIntervalMs", AttributeType.Integer)
.description("Maximum amount of time (in ms) to wait before sending a batch.")
.group("batch")
.defaultValue("100")
.build()));
return builder.build();
}