Modify Actors to use properties when provided
[policy/models.git] / models-interactions / model-actors / actor.sdnr / src / main / java / org / onap / policy / controlloop / actor / sdnr / SdnrOperation.java
index de498e6..4511cc3 100644 (file)
 package org.onap.policy.controlloop.actor.sdnr;
 
 import java.util.List;
-import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
-import org.apache.commons.lang3.tuple.Pair;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
+import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation;
 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
@@ -40,9 +38,16 @@ import org.onap.policy.sdnr.util.StatusCodeEnum;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessage, PciMessage> {
+public class SdnrOperation extends BidirectionalTopicOperation<PciMessage, PciMessage> {
     private static final Logger logger = LoggerFactory.getLogger(SdnrOperation.class);
 
+    /**
+     * Operation name as it should appear within config files.
+     */
+    public static final String NAME = "any";
+
+    private static final List<String> PROPERTY_NAMES = List.of(OperationProperties.EVENT_PAYLOAD);
+
     /**
      * Keys used to match the response with the request listener. The sub request ID is a
      * UUID, so it can be used to uniquely identify the response.
@@ -54,7 +59,7 @@ public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessa
                     List.of(new SelectorKey("body", "output", "CommonHeader", "SubRequestID"));
 
     public SdnrOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config) {
-        super(params, config, PciMessage.class);
+        super(params, config, PciMessage.class, PROPERTY_NAMES);
     }
 
     /**
@@ -62,7 +67,7 @@ public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessa
      */
     @Override
     protected List<String> getExpectedKeyValues(int attempt, PciMessage request) {
-        return List.of(request.getBody().getInput().getCommonHeader().getSubRequestId());
+        return List.of(getSubRequestId());
     }
 
     @Override
@@ -70,27 +75,27 @@ public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessa
         return startGuardAsync();
     }
 
+    /*
+     * NOTE: This should avoid throwing exceptions, so that a ControlLoopResponse can be
+     * added to the outcome. Consequently, it returns FAILURE if a required field is
+     * missing from the response.
+     */
     @Override
     protected Status detmStatus(String rawResponse, PciMessage responseWrapper) {
         PciResponse response = responseWrapper.getBody().getOutput();
 
         if (response.getStatus() == null) {
-            throw new IllegalArgumentException("SDNR response is missing the response status");
+            logger.warn("SDNR response is missing the response status");
+            return Status.FAILURE;
         }
 
         StatusCodeEnum code = StatusCodeEnum.fromStatusCode(response.getStatus().getCode());
 
         if (code == null) {
-            throw new IllegalArgumentException("unknown SDNR response status code: " + response.getStatus().getCode());
+            logger.warn("unknown SDNR response status code: {}", response.getStatus().getCode());
+            return Status.FAILURE;
         }
 
-        /*
-         * Response and Payload are just printed and no further action needed since
-         * casablanca release
-         */
-        logger.info("SDNR Response Code {} Message is {}", code, response.getStatus().getValue());
-        logger.info("SDNR Response Payload is {}", response.getPayload());
-
         switch (code) {
             case SUCCESS:
             case PARTIAL_SUCCESS:
@@ -100,7 +105,8 @@ public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessa
                 return Status.FAILURE;
             case ERROR:
             case REJECT:
-                throw new IllegalArgumentException("SDNR request was not accepted, code=" + code);
+                logger.warn("SDNR request was not accepted, code={}", code);
+                return Status.FAILURE;
             case ACCEPTED:
             default:
                 // awaiting a "final" response
@@ -113,42 +119,45 @@ public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessa
      */
     @Override
     public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, PciMessage responseWrapper) {
+        outcome.setResponse(responseWrapper);
+
         if (responseWrapper.getBody() == null || responseWrapper.getBody().getOutput() == null) {
             return setOutcome(outcome, result);
         }
 
-        PciResponse response = responseWrapper.getBody().getOutput();
-        if (response.getStatus() == null || response.getStatus().getValue() == null) {
+        PciResponse pciResponse = responseWrapper.getBody().getOutput();
+        if (pciResponse.getStatus() == null || pciResponse.getStatus().getValue() == null) {
             return setOutcome(outcome, result);
         }
 
         outcome.setResult(result);
-        outcome.setMessage(response.getStatus().getValue());
+        outcome.setMessage(pciResponse.getStatus().getValue());
         return outcome;
     }
 
     @Override
-    protected Pair<String, PciMessage> makeRequest(int attempt) {
-        VirtualControlLoopEvent onset = params.getContext().getEvent();
-        String subRequestId = UUID.randomUUID().toString();
+    protected PciMessage makeRequest(int attempt) {
+        String subRequestId = getSubRequestId();
 
         /* Construct an SDNR request using pci Model */
 
         PciMessage dmaapRequest = new PciMessage();
         dmaapRequest.setVersion("1.0");
-        dmaapRequest.setCorrelationId(onset.getRequestId() + "-" + subRequestId);
+        dmaapRequest.setCorrelationId(params.getRequestId() + "-" + subRequestId);
         dmaapRequest.setType("request");
+        dmaapRequest.setRpcName(params.getOperation().toLowerCase());
 
         /* This is the actual request that is placed in the dmaap wrapper. */
         final PciRequest sdnrRequest = new PciRequest();
 
         /* The common header is a required field for all SDNR requests. */
         PciCommonHeader requestCommonHeader = new PciCommonHeader();
-        requestCommonHeader.setRequestId(onset.getRequestId());
+        requestCommonHeader.setRequestId(params.getRequestId());
         requestCommonHeader.setSubRequestId(subRequestId);
 
         sdnrRequest.setCommonHeader(requestCommonHeader);
-        sdnrRequest.setPayload(onset.getPayload());
+        sdnrRequest.setPayload(getEventPayload());
+        sdnrRequest.setAction(params.getOperation());
 
         /*
          * Once the pci request is constructed, add it into the body of the dmaap wrapper.
@@ -156,9 +165,22 @@ public abstract class SdnrOperation extends BidirectionalTopicOperation<PciMessa
         PciBody body = new PciBody();
         body.setInput(sdnrRequest);
         dmaapRequest.setBody(body);
-        logger.info("SDNR Request to be sent is {}", dmaapRequest);
 
         /* Return the request to be sent through dmaap. */
-        return Pair.of(subRequestId, dmaapRequest);
+        return dmaapRequest;
+    }
+
+    /**
+     * Gets the event payload, first checking for it in the properties and then in the
+     * event.
+     *
+     * @return the event payload
+     */
+    protected String getEventPayload() {
+        if (containsProperty(OperationProperties.EVENT_PAYLOAD)) {
+            return getProperty(OperationProperties.EVENT_PAYLOAD);
+        }
+
+        return params.getContext().getEvent().getPayload();
     }
 }