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
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.controlloop.actor.guard;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.controlloop.actorserviceprovider.CallbackManager;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.models.decisions.concepts.DecisionRequest;
import org.onap.policy.models.decisions.concepts.DecisionResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Guard Operation. The outcome message is set to the guard response. If the guard is
* permitted or indeterminate, then the outcome is set to SUCCESS.
* <p/>
* The input to the request is taken from the payload, where properties are mapped to the
* field names in the {@link DecisionRequest} object. Properties whose names begin with
* "resource." are placed into the "resource" field of the {@link DecisionRequest}. The
* following will be provided, if not specified in the payload:
* <dl>
* <dt>action</dt>
* <dd>"guard"</dd>
* <dt>request ID</dt>
* <dd>generated</dd>
* </dl>
*/
public class DecisionOperation extends HttpOperation<DecisionResponse> {
private static final Logger logger = LoggerFactory.getLogger(DecisionOperation.class);
// operation name
public static final String NAME = OperationPartial.GUARD_OPERATION_NAME;
public static final String PERMIT = "Permit";
public static final String DENY = "Deny";
public static final String INDETERMINATE = "Indeterminate";
/**
* Prefix for properties in the payload that should be copied to the "resource" field
* of the request.
*/
public static final String RESOURCE_PREFIX = "resource.";
private final GuardConfig config;
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
*/
public DecisionOperation(ControlLoopOperationParams params, HttpConfig config) {
super(params, config, DecisionResponse.class, Collections.emptyList());
this.config = (GuardConfig) config;
}
@Override
public CompletableFuture<OperationOutcome> start() {
if (!config.isDisabled()) {
// enabled - do full guard operation
return super.start();
}
// guard is disabled, thus it is always treated as a success
logger.info("{}: guard disabled, always succeeds for {}", getFullName(), params.getRequestId());
final var executor = params.getExecutor();
final var callbacks = new CallbackManager();
return CompletableFuture.completedFuture(makeOutcome())
.whenCompleteAsync(callbackStarted(callbacks), executor)
.whenCompleteAsync(callbackCompleted(callbacks), executor);
}
@Override
protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
DecisionRequest request = makeRequest();
Map<String, Object> headers = makeHeaders();
headers.put("Accept", MediaType.APPLICATION_JSON);
String url = getUrl();
String strRequest = prettyPrint(request);
logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
// @formatter:off
return handleResponse(outcome, url,
callback -> getClient().post(callback, getPath(), entity, headers));
// @formatter:on
}
/**
* Makes a request from the payload.
*
* @return a new request
*/
protected DecisionRequest makeRequest() {
if (params.getPayload() == null) {
throw new IllegalArgumentException("missing payload");
}
DecisionRequest req = config.makeRequest();
req.setRequestId(getSubRequestId());
req.setResource(Map.of("guard", params.getPayload()));
return req;
}
@Override
protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
Response rawResponse, DecisionResponse response) {
outcome.setResponse(response);
// determine the result
String status = response.getStatus();
if (status == null) {
outcome.setResult(OperationResult.FAILURE);
outcome.setMessage("response contains no status");
return CompletableFuture.completedFuture(outcome);
}
if (PERMIT.equalsIgnoreCase(status) || INDETERMINATE.equalsIgnoreCase(status)) {
outcome.setResult(OperationResult.SUCCESS);
} else {
outcome.setResult(OperationResult.FAILURE);
}
// set the message
outcome.setMessage(response.getStatus());
return CompletableFuture.completedFuture(outcome);
}
}
|
