Merge "Make URL configurable in REST Requestor/Client"

4 files changed, 97 insertions, 11 deletions

diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequest.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequest.java
index 8ada5e617..08467f0bd 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequest.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequest.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ *  Modifications Copyright (C) 2019 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +21,8 @@
 
 package org.onap.policy.apex.plugins.event.carrier.restrequestor;
 
+import java.util.Properties;
+
 /**
  * This class holds a record of a REST request for the REST requestor plugin.
  *
@@ -29,6 +32,7 @@ public class ApexRestRequest {
     private long executionId;
     private String eventName;
     private Object event;
+    private Properties executionProperties;
     private long timestamp;
 
     /**
@@ -38,8 +42,10 @@ public class ApexRestRequest {
      * @param eventName the event name
      * @param event the event
      */
-    public ApexRestRequest(final long executionId, final String eventName, final Object event) {
+    public ApexRestRequest(final long executionId, final Properties executionProperties,
+            final String eventName, final Object event) {
         this.executionId = executionId;
+        this.executionProperties = executionProperties;
         this.eventName = eventName;
         this.event = event;
     }
@@ -72,6 +78,15 @@ public class ApexRestRequest {
     }
 
     /**
+     * Gets the executionProperties.
+     *
+     * @return the executionProperties
+     */
+    public Properties getExecutionProperties() {
+        return executionProperties;
+    }
+
+    /**
      * Gets the timestamp.
      *
      * @return the timestamp
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorConsumer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorConsumer.java
index cd74e183a..f1024d0fc 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorConsumer.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorConsumer.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ *  Modifications Copyright (C) 2019 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,12 +27,16 @@ import java.util.Arrays;
 import java.util.EnumMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Properties;
+import java.util.Set;
+import java.util.Optional;
 import java.util.Map.Entry;
 import java.util.Properties;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
 
 import javax.ws.rs.client.Client;
 import javax.ws.rs.client.ClientBuilder;
@@ -99,6 +104,8 @@ public class ApexRestRequestorConsumer implements ApexEventConsumer, Runnable {
     // The number of the next request runner thread
     private static long nextRequestRunnerThreadNo = 0;
 
+    private String untaggedUrl = null;
+
     @Override
     public void init(final String consumerName, final EventHandlerParameters consumerParameters,
                     final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
@@ -241,6 +248,23 @@ public class ApexRestRequestorConsumer implements ApexEventConsumer, Runnable {
                     continue;
                 }
 
+                Properties inputExecutionProperties = restRequest.getExecutionProperties();
+                untaggedUrl = restConsumerProperties.getUrl();
+                if (inputExecutionProperties != null) {
+                    Set<String> names = restConsumerProperties.getKeysFromUrl();
+                    Set<String> inputProperty = inputExecutionProperties.stringPropertyNames();
+
+                    names.stream().map(key -> Optional.of(key)).forEach(op -> {
+                        op.filter(str -> inputProperty.contains(str))
+                                .orElseThrow(() -> new ApexEventRuntimeException(
+                                        "key\"" + op.get() + "\"specified on url \"" + restConsumerProperties.getUrl() +
+                                                "\"not found in execution properties passed by the current policy"));
+                    });
+
+                    untaggedUrl = names.stream().reduce(untaggedUrl,
+                            (acc, str) -> acc.replace("{" + str + "}", (String) inputExecutionProperties.get(str)));
+                }
+
                 // Set the time stamp of the REST request
                 restRequest.setTimestamp(System.currentTimeMillis());
 
@@ -332,12 +356,12 @@ public class ApexRestRequestorConsumer implements ApexEventConsumer, Runnable {
 
             try {
                 // Execute the REST request
-                final Response response = sendEventAsRestRequest();
+                final Response response = sendEventAsRestRequest(untaggedUrl);
 
                 // Check that the event request worked
                 if (!Response.Status.Family.familyOf(response.getStatus()).equals(Response.Status.Family.SUCCESSFUL)) {
                     final String errorMessage = "reception of response to \"" + request + "\" from URL \""
-                                    + restConsumerProperties.getUrl() + "\" failed with status code "
+                                    + untaggedUrl + "\" failed with status code "
                                     + response.getStatus() + " and message \"" + response.readEntity(String.class)
                                     + "\"";
                     throw new ApexEventRuntimeException(errorMessage);
@@ -349,7 +373,7 @@ public class ApexRestRequestorConsumer implements ApexEventConsumer, Runnable {
                 // Check there is content
                 if (eventJsonString == null || eventJsonString.trim().length() == 0) {
                     final String errorMessage = "received an enpty response to \"" + request + "\" from URL \""
-                                    + restConsumerProperties.getUrl() + "\"";
+                                    + untaggedUrl + "\"";
                     throw new ApexEventRuntimeException(errorMessage);
                 }
 
@@ -380,24 +404,24 @@ public class ApexRestRequestorConsumer implements ApexEventConsumer, Runnable {
          *
          * @return the response to the REST request
          */
-        public Response sendEventAsRestRequest() {
+        public Response sendEventAsRestRequest(String untaggedUrl) {
             switch (restConsumerProperties.getHttpMethod()) {
                 case GET:
-                    return client.target(restConsumerProperties.getUrl()).request(APPLICATION_JSON)
+                    return client.target(untaggedUrl).request(APPLICATION_JSON)
                                     .headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap()).get();
 
                 case PUT:
-                    return client.target(restConsumerProperties.getUrl()).request(APPLICATION_JSON)
+                    return client.target(untaggedUrl).request(APPLICATION_JSON)
                                     .headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap())
                                     .put(Entity.json(request.getEvent()));
 
                 case POST:
-                    return client.target(restConsumerProperties.getUrl()).request(APPLICATION_JSON)
+                    return client.target(untaggedUrl).request(APPLICATION_JSON)
                                     .headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap())
                                     .post(Entity.json(request.getEvent()));
 
                 case DELETE:
-                    return client.target(restConsumerProperties.getUrl()).request(APPLICATION_JSON)
+                    return client.target(untaggedUrl).request(APPLICATION_JSON)
                                     .headers(restConsumerProperties.getHttpHeadersAsMultivaluedMap()).delete();
 
                 default:
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorProducer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorProducer.java
index bbe61f3fe..59a9ac971 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorProducer.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/ApexRestRequestorProducer.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ *  Modifications Copyright (C) 2019 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -159,7 +160,8 @@ public class ApexRestRequestorProducer implements ApexEventProducer {
 
             // Use the consumer to handle this event
             final ApexRestRequestorConsumer restRequstConsumer = (ApexRestRequestorConsumer) consumer;
-            restRequstConsumer.processRestRequest(new ApexRestRequest(executionId, eventName, event));
+            restRequstConsumer.processRestRequest(new ApexRestRequest(
+                executionId, executionProperties, eventName, event));
 
             eventsSent++;
         } else {
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParameters.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParameters.java
index 9bff0e2e4..d583b790e 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParameters.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParameters.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ *  Modifications Copyright (C) 2019 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +22,10 @@
 package org.onap.policy.apex.plugins.event.carrier.restrequestor;
 
 import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 import javax.ws.rs.core.MultivaluedHashMap;
 import javax.ws.rs.core.MultivaluedMap;
@@ -78,8 +83,12 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
     private HttpMethod httpMethod = null;
     private String[][] httpHeaders = null;
 
+    private static final Pattern patternProperKey = Pattern.compile("(?<=\\{)[^}]*(?=\\})");
+    private static final Pattern patternErrorKey = Pattern.compile(
+        "(\\{[^\\{}]*.?\\{)|(\\{[^\\{}]*$)|(\\}[^\\{}]*.?\\})|(^[^\\{}]*.?\\})|\\{\\s*\\}");
+
     /**
-     * Constructor to create a REST carrier technology parameters instance and regiaaaster the instance with the
+     * Constructor to create a REST carrier technology parameters instance and register the instance with the
      * parameter service.
      */
     public RestRequestorCarrierTechnologyParameters() {
@@ -175,6 +184,36 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
     }
 
     /**
+     * Get the tag for the REST Producer Properties.
+     *
+     * @return set of the tags
+     */
+    public Set<String> getKeysFromUrl() {
+        Matcher matcher = patternProperKey.matcher(this.url);
+        Set<String> key = new HashSet<>();
+        while (matcher.find()) {
+            key.add(matcher.group());
+        }
+        return key;
+    }
+
+    /**
+     * Validate tags in url.
+     * http://www.blah.com/{par1/somethingelse (Missing end tag) use  {[^\\{}]*$
+     * http://www.blah.com/{par1/{some}thingelse (Missing end tag2) use {[^}]*{
+     * http://www.blah.com/{par1}/some}thingelse (Missing start tag1) use }[^{}]*.}
+     * http://www.blah.com/par1}/somethingelse (Missing start tag2) use }[^{}]*}
+     * http://www.blah.com/{}/somethingelse (Empty tag) use {[\s]*}
+     *
+     * @return if url is legal
+     */
+    public boolean validateTagInUrl() {
+        // Check url tag syntax error
+        Matcher matcher = patternErrorKey.matcher(this.url);
+        return (!matcher.find());
+    }
+
+    /**
      * {@inheritDoc}.
      */
     @Override
@@ -201,6 +240,12 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
             }
         }
 
+        if (!validateTagInUrl()) {
+            result.setResult("url", ValidationStatus.INVALID,
+                "no proper URL has been set for event sending on REST client");
+        }
+
+
         return result;
     }