From ffe99e4b5c10956ed05c8cd11c8a3fca78427cbb Mon Sep 17 00:00:00 2001 From: "ning.xi" Date: Thu, 20 Feb 2020 11:17:28 +0800 Subject: remove code duplication in plugin-event-carrier Issue-ID: POLICY-1884 Change-Id: I610d7ee34d640cc3a7d3381b24993ee9b6f76f2d Signed-off-by: ning.xi --- .../RestRequestorCarrierTechnologyParameters.java | 180 ++------------------- ...stRequestorCarrierTechnologyParametersTest.java | 2 +- 2 files changed, 12 insertions(+), 170 deletions(-) (limited to 'plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restrequestor') 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 getHttpHeadersAsMultivaluedMap() { - if (httpHeaders == null) { - return null; - } - - // Load the HTTP headers into the map - MultivaluedMap 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 getKeysFromUrl() { - Matcher matcher = patternProperKey.matcher(getUrl()); - Set 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()); } -- cgit 1.2.3-korg