-
Notifications
You must be signed in to change notification settings - Fork 215
/
QueryCriteriaValidator.java
66 lines (57 loc) · 2.71 KB
/
QueryCriteriaValidator.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
/*
* Copyright (c) 2021 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.persistence.query.validation;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.util.List;
import java.util.concurrent.CompletionStage;
import org.eclipse.ditto.base.service.DittoExtensionPoint;
import org.eclipse.ditto.internal.utils.akka.AkkaClassLoader;
import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig;
import org.eclipse.ditto.thingsearch.model.signals.commands.query.ThingSearchQueryCommand;
import org.eclipse.ditto.thingsearch.service.common.config.DittoSearchConfig;
import akka.actor.ActorSystem;
/**
* Search Query Validator to be loaded by reflection.
* Can be used as an extension point to use custom validation of search queries.
* Implementations MUST have a public constructor taking an actorSystem as argument.
*/
public interface QueryCriteriaValidator extends DittoExtensionPoint {
/**
* Gets the criteria of a {@link org.eclipse.ditto.thingsearch.model.signals.commands.query.ThingSearchQueryCommand} and
* validates it.
* <p>
* May throw an exception depending on the implementation in the used QueryCriteriaValidator.
*
* @param command the command to validate.
* @return the validated command in a future if it is valid, or a failed future if it is not.
*/
public CompletionStage<ThingSearchQueryCommand<?>> validateCommand(
final ThingSearchQueryCommand<?> command);
/**
* Loads the implementation of {@code QueryCriteriaValidator} which is configured for the
* {@code ActorSystem}.
*
* @param actorSystem the actorSystem in which the {@code QueryCriteriaValidator} should be loaded.
* @return the {@code QueryCriteriaValidator} implementation.
* @throws NullPointerException if {@code actorSystem} is {@code null}.
*/
static QueryCriteriaValidator get(final ActorSystem actorSystem) {
checkNotNull(actorSystem, "actorSystem");
final var implementation = DittoSearchConfig.of(DefaultScopedConfig.dittoScoped(
actorSystem.settings().config())).getQueryValidatorImplementation();
return AkkaClassLoader.instantiate(actorSystem, QueryCriteriaValidator.class,
implementation,
List.of(ActorSystem.class),
List.of(actorSystem));
}
}