models-interactions/model-actors/actor.sdnc/src/main/java/org/onap/policy/controlloop/actor/sdnc/SdncOperation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actor.sdnc;
  22
  23 import java.util.Map;
  24 import java.util.concurrent.CompletableFuture;
  25 import javax.ws.rs.client.Entity;
  26 import javax.ws.rs.core.MediaType;
  27 import javax.ws.rs.core.Response;
  28 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  29 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  30 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  31 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
  32 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
  33 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  34 import org.onap.policy.sdnc.SdncRequest;
  35 import org.onap.policy.sdnc.SdncResponse;
  36
  37 /**
  38  * Superclass for SDNC Operators.
  39  */
  40 public abstract class SdncOperation extends HttpOperation<SdncResponse> {
  41
  42     /**
  43      * Constructs the object.
  44      *
  45      * @param params operation parameters
  46      * @param operator operator that created this operation
  47      */
  48     public SdncOperation(ControlLoopOperationParams params, HttpOperator operator) {
  49         super(params, operator, SdncResponse.class);
  50     }
  51
  52     /**
  53      * Starts the GUARD.
  54      */
  55     @Override
  56     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  57         return startGuardAsync();
  58     }
  59
  60     @Override
  61     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
  62
  63         SdncRequest request = makeRequest(attempt);
  64
  65         Entity<SdncRequest> entity = Entity.entity(request, MediaType.APPLICATION_JSON);
  66
  67         Map<String, Object> headers = makeHeaders();
  68
  69         headers.put("Accept", MediaType.APPLICATION_JSON);
  70         String url = makeUrl();
  71
  72         logMessage(EventType.OUT, CommInfrastructure.REST, url, request);
  73
  74         // @formatter:off
  75         return handleResponse(outcome, url,
  76             callback -> operator.getClient().post(callback, makePath(), entity, headers));
  77         // @formatter:on
  78     }
  79
  80     /**
  81      * Makes the request.
  82      *
  83      * @param attempt current attempt, starting with "1"
  84      * @return a new request to be posted
  85      */
  86     protected abstract SdncRequest makeRequest(int attempt);
  87
  88     /**
  89      * Checks that the response has an "output" and that the output indicates success.
  90      */
  91     @Override
  92     protected boolean isSuccess(Response rawResponse, SdncResponse response) {
  93         return response.getResponseOutput() != null && "200".equals(response.getResponseOutput().getResponseCode());
  94     }
  95 }