aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-event/plugins-event-carrier
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2020-02-24 14:38:07 +0000
committerGerrit Code Review <gerrit@onap.org>2020-02-24 14:38:07 +0000
commit0c200b611ee7d56753915281f9a168f7f6e00e7e (patch)
tree79e63973201b6c0a97bf8b907be9b1c423088710 /plugins/plugins-event/plugins-event-carrier
parent8f8df7ee1ddb20b03cedb17dccdc79fc291cc678 (diff)
parentffe99e4b5c10956ed05c8cd11c8a3fca78427cbb (diff)
Merge "remove code duplication in plugin-event-carrier"
Diffstat (limited to 'plugins/plugins-event/plugins-event-carrier')
-rw-r--r--plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParameters.java204
-rw-r--r--plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParametersTest.java2
-rw-r--r--plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/main/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParameters.java180
-rw-r--r--plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/test/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParametersTest.java2
4 files changed, 21 insertions, 367 deletions
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParameters.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParameters.java
index 8d783c5cd..0b73a8793 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParameters.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParameters.java
@@ -34,7 +34,7 @@ import javax.ws.rs.core.MultivaluedMap;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;
-import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
+import org.onap.policy.apex.service.parameters.carriertechnology.RestPluginCarrierTechnologyParameters;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.common.utils.validation.ParameterValidationUtils;
@@ -62,211 +62,23 @@ import org.slf4j.LoggerFactory;
//@formatter:on
@Setter
@Getter
-public class RestClientCarrierTechnologyParameters extends CarrierTechnologyParameters {
+public class RestClientCarrierTechnologyParameters extends RestPluginCarrierTechnologyParameters {
// Get a reference to the logger
private static final Logger LOGGER = LoggerFactory.getLogger(RestClientCarrierTechnologyParameters.class);
-
- /** The supported HTTP methods. */
- public enum HttpMethod {
- GET, PUT, POST, DELETE
- }
-
- /** The label of this carrier technology. */
- public static final String RESTCLIENT_CARRIER_TECHNOLOGY_LABEL = "RESTCLIENT";
-
- /** The producer plugin class for the REST carrier technology. */
- public static final String RESTCLIENT_EVENT_PRODUCER_PLUGIN_CLASS = ApexRestClientProducer.class.getName();
-
- /** The consumer plugin class for the REST carrier technology. */
- public static final String RESTCLIENT_EVENT_CONSUMER_PLUGIN_CLASS = ApexRestClientConsumer.class.getName();
-
- /** The default HTTP code filter, allows 2xx HTTP codes through. */
- public static final String DEFAULT_HTTP_CODE_FILTER = "[2][0-9][0-9]";
-
- // Commonly occurring strings
- private static final String HTTP_HEADERS = "httpHeaders";
- private static final String HTTP_CODE_FILTER = "httpCodeFilter";
-
- // Regular expression patterns for finding and checking keys in URLs
- private static final Pattern patternProperKey = Pattern.compile("(?<=\\{)[^}]*(?=\\})");
- private static final Pattern patternErrorKey =
- Pattern.compile("(\\{[^\\{}]*.?\\{)|(\\{[^\\{}]*$)|(\\}[^\\{}]*.?\\})|(^[^\\{}]*.?\\})|\\{\\s*\\}");
-
- private String url = null;
- private HttpMethod httpMethod = null;
- private String[][] httpHeaders = null;
- private String httpCodeFilter = DEFAULT_HTTP_CODE_FILTER;
-
/**
* Constructor to create a REST carrier technology parameters instance and register the instance with the parameter
* service.
*/
public RestClientCarrierTechnologyParameters() {
super();
-
+ CARRIER_TECHNOLOGY_LABEL = "RESTCLIENT";
+ EVENT_PRODUCER_PLUGIN_CLASS = ApexRestClientProducer.class.getName();
+ EVENT_CONSUMER_PLUGIN_CLASS = ApexRestClientConsumer.class.getName();
// Set the carrier technology properties for the web socket carrier technology
- this.setLabel(RESTCLIENT_CARRIER_TECHNOLOGY_LABEL);
- this.setEventProducerPluginClass(RESTCLIENT_EVENT_PRODUCER_PLUGIN_CLASS);
- this.setEventConsumerPluginClass(RESTCLIENT_EVENT_CONSUMER_PLUGIN_CLASS);
- }
-
- /**
- * Check if http headers have been set for the REST request.
- *
- * @return true if headers have been set
- */
- public boolean checkHttpHeadersSet() {
- return httpHeaders != null && httpHeaders.length > 0;
+ this.setLabel(CARRIER_TECHNOLOGY_LABEL);
+ this.setEventProducerPluginClass(EVENT_PRODUCER_PLUGIN_CLASS);
+ this.setEventConsumerPluginClass(EVENT_CONSUMER_PLUGIN_CLASS);
}
- /**
- * Gets the http headers for the REST request as a multivalued map.
- *
- * @return the headers
- */
- public MultivaluedMap<String, Object> getHttpHeadersAsMultivaluedMap() {
- if (httpHeaders == null) {
- return null;
- }
-
- // Load the HTTP headers into the map
- MultivaluedMap<String, Object> httpHeaderMap = new MultivaluedHashMap<>();
-
- for (String[] httpHeader : httpHeaders) {
- httpHeaderMap.putSingle(httpHeader[0], httpHeader[1]);
- }
-
- return httpHeaderMap;
- }
-
- /**
- * Sets the header for the REST request.
- *
- * @param httpHeaders the incoming HTTP headers
- */
- public void setHttpHeaders(final String[][] httpHeaders) {
- this.httpHeaders = httpHeaders;
- }
-
- /**
- * Get the tag for the REST Producer Properties.
- *
- * @return set of the tags
- */
- public Set<String> getKeysFromUrl() {
- Matcher matcher = patternProperKey.matcher(getUrl());
- Set<String> key = new HashSet<>();
- while (matcher.find()) {
- key.add(matcher.group());
- }
- return key;
- }
- /**
- * {@inheritDoc}.
- */
- @Override
- public GroupValidationResult validate() {
- GroupValidationResult result = super.validate();
-
- result = validateUrl(result);
-
- result = validateHttpHeaders(result);
-
- return validateHttpCodeFilter(result);
- }
-
- // @formatter:off
- /**
- * Validate the URL.
- *
- * <p>Checks:
- * http://www.blah.com/{par1/somethingelse (Missing end tag) use {[^\\{}]*$
- * http://www.blah.com/{par1/{some}thingelse (Nested tag) 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]*}
- * @param result the result of the validation
- */
- // @formatter:on
- private GroupValidationResult validateUrl(final GroupValidationResult result) {
- // Check if the URL has been set for event output
- if (getUrl() == null) {
- result.setResult("url", ValidationStatus.INVALID, "no URL has been set for event sending on REST client");
- return result;
- }
-
- Matcher matcher = patternErrorKey.matcher(getUrl());
- if (matcher.find()) {
- result.setResult("url", ValidationStatus.INVALID,
- "no proper URL has been set for event sending on REST client");
- }
-
- return result;
- }
-
- /**
- * Validate the HTTP headers.
- *
- * @param result the result of the validation
- */
- private GroupValidationResult validateHttpHeaders(final GroupValidationResult result) {
- if (httpHeaders == null) {
- return result;
- }
-
- for (String[] httpHeader : httpHeaders) {
- if (httpHeader == null) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID, "HTTP header array entry is null");
- } else if (httpHeader.length != 2) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID,
- "HTTP header array entries must have one key and one value: "
- + Arrays.deepToString(httpHeader));
- } else if (!ParameterValidationUtils.validateStringParameter(httpHeader[0])) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID,
- "HTTP header key is null or blank: " + Arrays.deepToString(httpHeader));
- } else if (!ParameterValidationUtils.validateStringParameter(httpHeader[1])) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID,
- "HTTP header value is null or blank: " + Arrays.deepToString(httpHeader));
- }
- }
-
- return result;
- }
-
- /**
- * Validate the HTTP code filter.
- *
- * @param result the result of the validation
- */
- public GroupValidationResult validateHttpCodeFilter(final GroupValidationResult result) {
- if (httpCodeFilter == null) {
- httpCodeFilter = DEFAULT_HTTP_CODE_FILTER;
-
- } else if (StringUtils.isBlank(httpCodeFilter)) {
- result.setResult(HTTP_CODE_FILTER, ValidationStatus.INVALID,
- "HTTP code filter must be specified as a three digit regular expression");
- } else {
- try {
- Pattern.compile(httpCodeFilter);
- } catch (PatternSyntaxException pse) {
- String message =
- "Invalid HTTP code filter, the filter must be specified as a three digit regular expression: "
- + pse.getMessage();
- result.setResult(HTTP_CODE_FILTER, ValidationStatus.INVALID, message);
- LOGGER.debug(message, pse);
- }
- }
-
- return result;
- }
-
- /**
- * {@inheritDoc}.
- */
- @Override
- public String toString() {
- return "RestClientCarrierTechnologyParameters [url=" + url + ", httpMethod=" + httpMethod + ", httpHeaders="
- + Arrays.deepToString(httpHeaders) + ", httpCodeFilter=" + httpCodeFilter + "]";
- }
}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParametersTest.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParametersTest.java
index ef0384f9c..0e4ddd0a3 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParametersTest.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/RestClientCarrierTechnologyParametersTest.java
@@ -175,7 +175,7 @@ public class RestClientCarrierTechnologyParametersTest {
rrctp.setHttpMethod(RestClientCarrierTechnologyParameters.HttpMethod.DELETE);
assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.DELETE, rrctp.getHttpMethod());
- assertEquals("RestClientCarrierTechnologyParameters "
+ assertEquals("RESTCLIENTCarrierTechnologyParameters "
+ "[url=http://some.where, httpMethod=DELETE, httpHeaders=[[aaa, bbb], [ccc, ddd]], "
+ "httpCodeFilter=[1-5][0][0-5]]", rrctp.toString());
}
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 e66ff608a..0d122c67b 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
@@ -34,7 +34,7 @@ import javax.ws.rs.core.MultivaluedMap;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;
-import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
+import org.onap.policy.apex.service.parameters.carriertechnology.RestPluginCarrierTechnologyParameters;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.common.utils.validation.ParameterValidationUtils;
@@ -63,25 +63,11 @@ import org.slf4j.LoggerFactory;
//@formatter:on
@Getter
@Setter
-public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyParameters {
+public class RestRequestorCarrierTechnologyParameters extends RestPluginCarrierTechnologyParameters {
// Get a reference to the logger
private static final Logger LOGGER = LoggerFactory.getLogger(RestRequestorCarrierTechnologyParameters.class);
- /** The supported HTTP methods. */
- public enum HttpMethod {
- GET, PUT, POST, DELETE
- }
-
- /** The label of this carrier technology. */
- public static final String RESTREQUESTOR_CARRIER_TECHNOLOGY_LABEL = "RESTREQUESTOR";
-
- /** The producer plugin class for the REST carrier technology. */
- public static final String RESTREQUSTOR_EVENT_PRODUCER_PLUGIN_CLASS =
- ApexRestRequestorProducer.class.getName();
- /** The consumer plugin class for the REST carrier technology. */
- public static final String RESTREQUSTOR_EVENT_CONSUMER_PLUGIN_CLASS =
- ApexRestRequestorConsumer.class.getName();
/** The default HTTP method for request events. */
public static final HttpMethod DEFAULT_REQUESTOR_HTTP_METHOD = HttpMethod.GET;
@@ -89,23 +75,6 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
/** The default timeout for REST requests. */
public static final long DEFAULT_REST_REQUEST_TIMEOUT = 500;
- /** The default HTTP code filter, allows 2xx HTTP codes through. */
- public static final String DEFAULT_HTTP_CODE_FILTER = "[2][0-9][0-9]";
-
- // Commonly occurring strings
- private static final String HTTP_HEADERS = "httpHeaders";
- private static final String HTTP_CODE_FILTER = "httpCodeFilter";
-
- // Regular expression patterns for finding and checking keys in URLs
- private static final Pattern patternProperKey = Pattern.compile("(?<=\\{)[^}]*(?=\\})");
- private static final Pattern patternErrorKey =
- Pattern.compile("(\\{[^\\{}]*.?\\{)|(\\{[^\\{}]*$)|(\\}[^\\{}]*.?\\})|(^[^\\{}]*.?\\})|\\{\\s*\\}");
-
- private String url = null;
- private HttpMethod httpMethod = null;
- private String[][] httpHeaders = null;
- private String httpCodeFilter = DEFAULT_HTTP_CODE_FILTER;
-
/**
* Constructor to create a REST carrier technology parameters instance and register the instance with the parameter
* service.
@@ -114,76 +83,13 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
super();
// Set the carrier technology properties for the web socket carrier technology
- this.setLabel(RESTREQUESTOR_CARRIER_TECHNOLOGY_LABEL);
- this.setEventProducerPluginClass(RESTREQUSTOR_EVENT_PRODUCER_PLUGIN_CLASS);
- this.setEventConsumerPluginClass(RESTREQUSTOR_EVENT_CONSUMER_PLUGIN_CLASS);
- }
-
- /**
- * Check if http headers have been set for the REST request.
- *
- * @return true if headers have beenset
- */
- public boolean checkHttpHeadersSet() {
- return httpHeaders != null && httpHeaders.length > 0;
- }
-
- /**
- * Gets the http headers for the REST request as a multivalued map.
- *
- * @return the headers
- */
- public MultivaluedMap<String, Object> getHttpHeadersAsMultivaluedMap() {
- if (httpHeaders == null) {
- return null;
- }
-
- // Load the HTTP headers into the map
- MultivaluedMap<String, Object> httpHeaderMap = new MultivaluedHashMap<>();
-
- for (String[] httpHeader : httpHeaders) {
- httpHeaderMap.putSingle(httpHeader[0], httpHeader[1]);
- }
-
- return httpHeaderMap;
- }
-
- /**
- * Sets the header for the REST request.
- *
- * @param httpHeaders the incoming HTTP headers
- */
- public void setHttpHeaders(final String[][] httpHeaders) {
- this.httpHeaders = httpHeaders;
- }
-
- /**
- * Get the tag for the REST Producer Properties.
- *
- * @return set of the tags
- */
- public Set<String> getKeysFromUrl() {
- Matcher matcher = patternProperKey.matcher(getUrl());
- Set<String> key = new HashSet<>();
- while (matcher.find()) {
- key.add(matcher.group());
- }
- return key;
- }
-
-
- /**
- * {@inheritDoc}.
- */
- @Override
- public GroupValidationResult validate() {
- GroupValidationResult result = super.validate();
-
- result = validateUrl(result);
-
- result = validateHttpHeaders(result);
-
- return validateHttpCodeFilter(result);
+ CARRIER_TECHNOLOGY_LABEL = "RESTREQUESTOR";
+ EVENT_PRODUCER_PLUGIN_CLASS = ApexRestRequestorProducer.class.getName();
+ EVENT_CONSUMER_PLUGIN_CLASS = ApexRestRequestorConsumer.class.getName();
+ // Set the carrier technology properties for the web socket carrier technology
+ this.setLabel(CARRIER_TECHNOLOGY_LABEL);
+ this.setEventProducerPluginClass(EVENT_PRODUCER_PLUGIN_CLASS);
+ this.setEventConsumerPluginClass(EVENT_CONSUMER_PLUGIN_CLASS);
}
// @formatter:off
@@ -199,7 +105,8 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
* @param result the result of the validation
*/
// @formatter:on
- private GroupValidationResult validateUrl(final GroupValidationResult result) {
+ @Override
+ public GroupValidationResult validateUrl(final GroupValidationResult result) {
// URL is only set on Requestor consumers
if (getUrl() == null) {
return result;
@@ -213,69 +120,4 @@ public class RestRequestorCarrierTechnologyParameters extends CarrierTechnologyP
return result;
}
-
- /**
- * Validate the HTTP headers.
- *
- * @param result the result of the validation
- */
- private GroupValidationResult validateHttpHeaders(final GroupValidationResult result) {
- if (httpHeaders == null) {
- return result;
- }
-
- for (String[] httpHeader : httpHeaders) {
- if (httpHeader == null) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID, "HTTP header array entry is null");
- } else if (httpHeader.length != 2) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID,
- "HTTP header array entries must have one key and one value: "
- + Arrays.deepToString(httpHeader));
- } else if (!ParameterValidationUtils.validateStringParameter(httpHeader[0])) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID,
- "HTTP header key is null or blank: " + Arrays.deepToString(httpHeader));
- } else if (!ParameterValidationUtils.validateStringParameter(httpHeader[1])) {
- result.setResult(HTTP_HEADERS, ValidationStatus.INVALID,
- "HTTP header value is null or blank: " + Arrays.deepToString(httpHeader));
- }
- }
-
- return result;
- }
-
- /**
- * Validate the HTTP code filter.
- *
- * @param result the result of the validation
- */
- public GroupValidationResult validateHttpCodeFilter(final GroupValidationResult result) {
- if (httpCodeFilter == null) {
- httpCodeFilter = DEFAULT_HTTP_CODE_FILTER;
-
- } else if (StringUtils.isBlank(httpCodeFilter)) {
- result.setResult(HTTP_CODE_FILTER, ValidationStatus.INVALID,
- "HTTP code filter must be specified as a three digit regular expression");
- } else {
- try {
- Pattern.compile(httpCodeFilter);
- } catch (PatternSyntaxException pse) {
- String message =
- "Invalid HTTP code filter, the filter must be specified as a three digit regular expression: "
- + pse.getMessage();
- result.setResult(HTTP_CODE_FILTER, ValidationStatus.INVALID, message);
- LOGGER.debug(message, pse);
- }
- }
-
- return result;
- }
-
- /**
- * {@inheritDoc}.
- */
- @Override
- public String toString() {
- return "RESTRequestorCarrierTechnologyParameters [url=" + url + ", httpMethod=" + httpMethod + ", httpHeaders="
- + Arrays.deepToString(httpHeaders) + ", httpCodeFilter=" + httpCodeFilter + "]";
- }
}
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/test/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParametersTest.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/test/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParametersTest.java
index 96cf8490b..b9b997f09 100644
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/test/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParametersTest.java
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor/src/test/java/org/onap/policy/apex/plugins/event/carrier/restrequestor/RestRequestorCarrierTechnologyParametersTest.java
@@ -162,7 +162,7 @@ public class RestRequestorCarrierTechnologyParametersTest {
rrctp.setHttpMethod(RestRequestorCarrierTechnologyParameters.HttpMethod.DELETE);
assertEquals(RestRequestorCarrierTechnologyParameters.HttpMethod.DELETE, rrctp.getHttpMethod());
- assertEquals("RESTRequestorCarrierTechnologyParameters "
+ assertEquals("RESTREQUESTORCarrierTechnologyParameters "
+ "[url=http://some.where, httpMethod=DELETE, httpHeaders=[[aaa, bbb], [ccc, ddd]],"
+ " httpCodeFilter=[1-5][0][0-5]]", rrctp.toString());
}