-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ConnectorValidator.java
262 lines (228 loc) · 8.41 KB
/
ConnectorValidator.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
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.configuration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;
import java.util.stream.Stream;
import javax.annotation.Nonnull;
import org.neo4j.graphdb.config.InvalidSettingException;
import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.config.SettingGroup;
import static java.lang.String.format;
import static java.util.stream.Collectors.joining;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Collectors.toSet;
public abstract class ConnectorValidator implements SettingGroup<Object>
{
private static final Set<String> validTypes =
Arrays.stream( Connector.ConnectorType.values() )
.map( Enum::name )
.collect( toSet() );
static final String DEPRECATED_CONNECTOR_MSG =
"Warning: connectors with names other than [http,https,bolt] are%n" +
"deprecated and support for them will be removed in a future%n" +
"version of Neo4j. Offending lines in " + Config.DEFAULT_CONFIG_FILE_NAME + ":%n%n%s";
protected final Connector.ConnectorType type;
public ConnectorValidator( @Nonnull Connector.ConnectorType type )
{
this.type = type;
}
/**
* Determine if this instance is responsible for validating a setting.
*
* @param key the key of the setting
* @param rawConfig raw map of config settings to validate
* @return true if this instance is responsible for parsing the setting, false otherwise.
* @throws InvalidSettingException if an answer can not be determined, for example in case of a missing second
* mandatory setting.
*/
public boolean owns( @Nonnull String key, @Nonnull Map<String,String> rawConfig ) throws InvalidSettingException
{
String[] parts = key.split( "\\." );
if ( parts.length < 2 )
{
return false;
}
if ( !parts[0].equals( "dbms" ) || !parts[1].equals( "connector" ) )
{
return false;
}
// Do not allow invalid settings under 'dbms.connector.**'
if ( parts.length != 4 )
{
throw new InvalidSettingException( format( "Invalid connector setting: %s", key ) );
}
/*if ( !subSettings().contains( parts[3] ) )
{
return false;
}*/
// A type must be specified, or it is not possible to know who owns this setting
String groupKey = parts[2];
String typeKey = String.join( ".", parts[0], parts[1], groupKey, "type" );
String typeValue = rawConfig.get( typeKey );
if ( typeValue == null )
{
// We can infer the type of the connector from some names
if ( groupKey.equalsIgnoreCase( "http" ) || groupKey.equalsIgnoreCase( "https" ) )
{
typeValue = Connector.ConnectorType.HTTP.name();
}
else if ( groupKey.equalsIgnoreCase( "bolt" ) )
{
typeValue = Connector.ConnectorType.BOLT.name();
}
}
// If this is a connector not called bolt or http, then we require the type
if ( typeValue == null )
{
throw new InvalidSettingException( format( "Missing mandatory value for '%s'", typeKey ) );
}
if ( !validTypes.contains( typeValue ) )
{
throw new InvalidSettingException(
format( "'%s' must be one of %s; not '%s'",
typeKey, String.join( ", ", validTypes ), typeValue ) );
}
return this.type.name().equals( typeValue );
}
@Nonnull
public Stream<Entry<String,String>> ownedEntries( @Nonnull Map<String,String> params )
throws InvalidSettingException
{
return params.entrySet().stream()
.filter( it -> owns( it.getKey(), params ) );
}
@Override
@Nonnull
public Map<String,String> validate( @Nonnull Map<String,String> rawConfig, @Nonnull Consumer<String> warningConsumer )
throws InvalidSettingException
{
final HashMap<String,String> result = new HashMap<>();
ownedEntries( rawConfig ).forEach( s ->
result.putAll( getSettingFor( s.getKey(), rawConfig )
.orElseThrow( () -> new InvalidSettingException(
format( "Invalid connector setting: %s", s.getKey() ) ) )
.validate( rawConfig, warningConsumer ) ) );
warnAboutDeprecatedConnectors( result, warningConsumer );
return result;
}
private void warnAboutDeprecatedConnectors( @Nonnull Map<String,String> connectorSettings,
@Nonnull Consumer<String> warningConsumer )
{
final HashSet<String> nonDefaultConnectors = new HashSet<>();
connectorSettings.entrySet().stream()
.map( Entry::getKey )
.filter( settingKey ->
{
String name = settingKey.split( "\\." )[2];
return isDeprecatedConnectorName( name );
} )
.forEach( nonDefaultConnectors::add );
if ( !nonDefaultConnectors.isEmpty() )
{
warningConsumer.accept( format(
DEPRECATED_CONNECTOR_MSG,
nonDefaultConnectors.stream()
.sorted()
.map( s -> format( "> %s%n", s ) )
.collect( joining() ) ) );
}
}
protected boolean isDeprecatedConnectorName( String name )
{
return !( name.equalsIgnoreCase( "http" ) || name.equalsIgnoreCase( "https" ) || name
.equalsIgnoreCase( "bolt" ) );
}
@Override
@Nonnull
public Map<String,Object> values( @Nonnull Map<String,String> params )
{
final HashMap<String,Object> result = new HashMap<>();
ownedEntries( params ).forEach( s ->
result.putAll( getSettingFor( s.getKey(), params )
.orElseThrow( () -> new InvalidSettingException(
format( "Invalid connector setting: %s", s.getKey() ) ) )
.values( params ) ) );
return result;
}
/**
*
* @return a setting which is not necessarily literally defined in the map provided
*/
@Nonnull
protected abstract Optional<Setting<Object>> getSettingFor( @Nonnull String settingName,
@Nonnull Map<String,String> params );
@Override
public List<Setting<Object>> settings( @Nonnull Map<String,String> params )
{
return ownedEntries( params )
.map( e -> getSettingFor( e.getKey(), params ) )
.filter( Optional::isPresent )
.map( Optional::get )
.collect( toList() );
}
@Override
public boolean deprecated()
{
return false;
}
@Override
public Optional<String> replacement()
{
return Optional.empty();
}
@Override
public boolean internal()
{
return false;
}
@Override
public boolean secret()
{
return false;
}
@Override
public Optional<String> documentedDefaultValue()
{
return Optional.empty();
}
@Override
public String valueDescription()
{
return "a group of connector settings";
}
@Override
public Optional<String> description()
{
return Optional.empty();
}
@Override
public boolean dynamic()
{
return false;
}
}