-
Notifications
You must be signed in to change notification settings - Fork 214
/
EnforcementReloaded.java
79 lines (69 loc) · 2.45 KB
/
EnforcementReloaded.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
/*
* Copyright (c) 2022 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.policies.enforcement;
import java.util.concurrent.CompletionStage;
import java.util.function.Consumer;
import java.util.function.Function;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.base.model.signals.commands.CommandResponse;
import org.eclipse.ditto.policies.model.Policy;
import org.eclipse.ditto.policies.model.PolicyId;
/**
* TODO TJ doc
*
* @param <S>
* @param <R>
*/
public interface EnforcementReloaded<S extends Signal<?>, R extends CommandResponse<?>> {
/**
*
* @param signal
* @param enforcer
* @return
*/
CompletionStage<S> authorizeSignal(S signal, PolicyEnforcer enforcer);
/**
*
* @param signal
* @return
*/
CompletionStage<S> authorizeSignalWithMissingEnforcer(S signal);
/**
* TODO TJ doc
* @param commandResponse
* @return
*/
boolean shouldFilterCommandResponse(R commandResponse);
/**
* Filters the given {@code commandResponse} by using the given {@code enforcer}.
*
* @param commandResponse the command response that needs to be filtered.
* @param enforcer the enforcer that should be used for filtering.
* @return the filtered command response.
*/
CompletionStage<R> filterResponse(R commandResponse, PolicyEnforcer enforcer);
/**
* TODO TJ doc
* @param policyEnforcerLoader
*/
void registerPolicyEnforcerLoader(Function<PolicyId, CompletionStage<PolicyEnforcer>> policyEnforcerLoader);
/**
* Allows to register consumers which should be notified if this enforcement implementation received a Policy, e.g.
* as response of a {@code CreatePolicy} command issued by this implementation.
* This can optimize the registered consumer as it does not have to load the policy of the policy shard region as
* a consequence.
*
* @param policyInjectionConsumer the consumer to register which shall be notified about an injected Policy.
*/
void registerPolicyInjectionConsumer(Consumer<Policy> policyInjectionConsumer);
}