/
SearchConfig.java
130 lines (109 loc) · 3.97 KB
/
SearchConfig.java
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
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.thingsearch.service.common.config;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.service.config.ServiceSpecificConfig;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
import org.eclipse.ditto.internal.utils.health.config.WithHealthCheckConfig;
import org.eclipse.ditto.internal.utils.persistence.mongo.config.WithIndexInitializationConfig;
import org.eclipse.ditto.internal.utils.persistence.mongo.config.WithMongoDbConfig;
import org.eclipse.ditto.internal.utils.persistence.operations.WithPersistenceOperationsConfig;
import com.typesafe.config.ConfigValueFactory;
/**
* Provides the configuration settings of the Search service.
*/
@Immutable
public interface SearchConfig extends ServiceSpecificConfig, WithHealthCheckConfig, WithPersistenceOperationsConfig,
WithMongoDbConfig, WithIndexInitializationConfig {
Optional<String> getMongoHintsByNamespace();
/**
* Returns the configuration settings for the search updating functionality.
*
* @return the config.
*/
UpdaterConfig getUpdaterConfig();
/**
* Returns the query persistence config.
*
* @return the config.
*/
SearchPersistenceConfig getQueryPersistenceConfig();
/**
* Returns how simple fields are mapped during query parsing.
*
* @return the simple field mapping.
*/
Map<String, String> getSimpleFieldMappings();
/**
* Returns the operator metrics configuration containing metrics to be exposed via Prometheus based on configured
* search "count" queries.
*
* @return the operator metrics configuration.
*/
OperatorMetricsConfig getOperatorMetricsConfig();
/*
* Returns a map of fields scoped by namespaces that will be explicitly included in the search index.
*
* @return the search projection fields.
* @since 3.4
*/
List<NamespaceSearchIndexConfig> getNamespaceSearchIncludeFields();
/**
* An enumeration of the known config path expressions and their associated default values for SearchConfig.
*/
enum SearchConfigValue implements KnownConfigValue {
/**
* Default value is {@code null}.
*/
MONGO_HINTS_BY_NAMESPACE("mongo-hints-by-namespace", null),
/**
* How simple fields are mapped during query parsing.
*
* @since 3.0.0
*/
SIMPLE_FIELD_MAPPINGS("simple-field-mappings", ConfigValueFactory.fromMap(
Map.of(
"thingId", "_id",
"namespace", "_namespace",
"policyId", "/policyId",
"_revision", "/_revision",
"_modified", "/_modified",
"_created", "/_created",
"definition", "/definition",
"_metadata", "/_metadata"
)
)),
/**
* Any fields to include in the search index, scoped by namespace.
*/
NAMESPACE_SEARCH_INCLUDE_FIELDS("namespace-search-include-fields", Collections.emptyList());
private final String path;
private final Object defaultValue;
SearchConfigValue(final String path, final Object defaultValue) {
this.path = path;
this.defaultValue = defaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return path;
}
}
}