2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.controlloop.actor.guard;
24 import java.util.concurrent.CompletableFuture;
25 import java.util.concurrent.Executor;
26 import javax.ws.rs.client.Entity;
27 import javax.ws.rs.core.MediaType;
28 import javax.ws.rs.core.Response;
29 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
30 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
31 import org.onap.policy.controlloop.actorserviceprovider.CallbackManager;
32 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
33 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
34 import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial;
35 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
36 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
37 import org.onap.policy.controlloop.policy.PolicyResult;
38 import org.onap.policy.models.decisions.concepts.DecisionRequest;
39 import org.onap.policy.models.decisions.concepts.DecisionResponse;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
44 * Guard Operation. The outcome message is set to the guard response. If the guard is
45 * permitted or indeterminate, then the outcome is set to SUCCESS.
47 * The input to the request is taken from the payload, where properties are mapped to the
48 * field names in the {@link DecisionRequest} object. Properties whose names begin with
49 * "resource." are placed into the "resource" field of the {@link DecisionRequest}. The
50 * following will be provided, if not specified in the payload:
58 public class DecisionOperation extends HttpOperation<DecisionResponse> {
59 private static final Logger logger = LoggerFactory.getLogger(DecisionOperation.class);
62 public static final String NAME = OperationPartial.GUARD_OPERATION_NAME;
64 public static final String PERMIT = "Permit";
65 public static final String DENY = "Deny";
66 public static final String INDETERMINATE = "Indeterminate";
69 * Prefix for properties in the payload that should be copied to the "resource" field
72 public static final String RESOURCE_PREFIX = "resource.";
74 private final GuardConfig config;
78 * Constructs the object.
80 * @param params operation parameters
81 * @param config configuration for this operation
83 public DecisionOperation(ControlLoopOperationParams params, HttpConfig config) {
84 super(params, config, DecisionResponse.class);
85 this.config = (GuardConfig) config;
89 public CompletableFuture<OperationOutcome> start() {
90 if (!config.isDisabled()) {
91 // enabled - do full guard operation
95 // guard is disabled, thus it is always treated as a success
96 logger.info("{}: guard disabled, always succeeds for {}", getFullName(), params.getRequestId());
98 final Executor executor = params.getExecutor();
99 final CallbackManager callbacks = new CallbackManager();
101 return CompletableFuture.completedFuture(params.makeOutcome())
102 .whenCompleteAsync(callbackStarted(callbacks), executor)
103 .whenCompleteAsync(callbackCompleted(callbacks), executor);
107 protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
108 DecisionRequest request = makeRequest();
110 Map<String, Object> headers = makeHeaders();
112 headers.put("Accept", MediaType.APPLICATION_JSON);
113 String url = getUrl();
115 String strRequest = prettyPrint(request);
116 logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
118 Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
121 return handleResponse(outcome, url,
122 callback -> getClient().post(callback, getPath(), entity, headers));
127 * Makes a request from the payload.
129 * @return a new request
131 protected DecisionRequest makeRequest() {
132 if (params.getPayload() == null) {
133 throw new IllegalArgumentException("missing payload");
136 DecisionRequest req = config.makeRequest();
137 req.setRequestId(getSubRequestId());
138 req.setResource(Map.of("guard", params.getPayload()));
144 protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
145 Response rawResponse, DecisionResponse response) {
147 outcome.setResponse(response);
149 // determine the result
150 String status = response.getStatus();
151 if (status == null) {
152 outcome.setResult(PolicyResult.FAILURE);
153 outcome.setMessage("response contains no status");
154 return CompletableFuture.completedFuture(outcome);
157 if (PERMIT.equalsIgnoreCase(status) || INDETERMINATE.equalsIgnoreCase(status)) {
158 outcome.setResult(PolicyResult.SUCCESS);
160 outcome.setResult(PolicyResult.FAILURE);
164 outcome.setMessage(response.getStatus());
166 return CompletableFuture.completedFuture(outcome);