summaryrefslogtreecommitdiffstats
path: root/message-router/consumer/provider/src
diff options
context:
space:
mode:
authorSmokowski, Kevin (ks6305) <kevin.smokowski@att.com>2019-05-30 22:23:52 +0000
committerKevin Smokowski <kevin.smokowski@att.com>2019-06-17 15:31:38 +0000
commitd14bb405004176e72e8722438eb95819ed11f1c7 (patch)
treeb99fb91f96bf55fa8d02823a3baae90bc3325797 /message-router/consumer/provider/src
parentfaaa1a75d85a522847acf4c7250b8da5f076cfa0 (diff)
implement message router consumer
implement message router consumer Issue-ID: CCSDK-1373 Signed-off-by: Smokowski, Kevin (ks6305) <kevin.smokowski@att.com> Change-Id: Iea4290c5b9e9bb63f152f0605dae1e715974f217
Diffstat (limited to 'message-router/consumer/provider/src')
-rwxr-xr-xmessage-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/AbstractBaseConsumer.java207
-rwxr-xr-xmessage-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/ConsumerFactory.java179
-rw-r--r--message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PollingConsumerImpl.java100
-rwxr-xr-xmessage-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PullingConsumerImpl.java17
4 files changed, 503 insertions, 0 deletions
diff --git a/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/AbstractBaseConsumer.java b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/AbstractBaseConsumer.java
new file mode 100755
index 000000000..8937f7b91
--- /dev/null
+++ b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/AbstractBaseConsumer.java
@@ -0,0 +1,207 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * openECOMP : SDN-C
+ * ================================================================================
+ * Copyright (C) 2017 - 2018 AT&T Intellectual Property. All rights
+ * reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.adaptors.messagerouter.consumer.provider.impl;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.net.HttpURLConnection;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.Base64;
+
+import javax.net.ssl.HostnameVerifier;
+import javax.net.ssl.HttpsURLConnection;
+import javax.net.ssl.SSLSession;
+
+import org.onap.ccsdk.sli.adaptors.messagerouter.consumer.api.ConsumerApi;
+import org.onap.ccsdk.sli.adaptors.messagerouter.consumer.api.RequestHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonParseException;
+
+/*
+ * java.net based client to build message router consumers
+ */
+public abstract class AbstractBaseConsumer implements ConsumerApi {
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractBaseConsumer.class);
+ private static final String REQUEST_METHOD = "GET";
+
+ private final String host;
+ private final Integer connectTimeout;
+ private final Integer readTimeout;
+ private final String group;
+ private final String id;
+ private final String filter;
+ private final Integer limit;
+ private final Integer timeoutQueryParamValue;
+ private final String authorizationString;
+
+ protected RequestHandler requestHandler;
+ protected URL url;
+ protected String topic;
+
+ public AbstractBaseConsumer(String username, String password, String host, String authentication, Integer connectTimeout, Integer readTimeout, String group, String id, String filter, Integer limit, Integer timeoutQueryParamValue) {
+ this.host = host;
+ this.connectTimeout = connectTimeout;
+ this.readTimeout = readTimeout;
+ this.group = group;
+ this.id = id;
+ this.filter = filter;
+ this.limit = limit;
+ this.timeoutQueryParamValue = timeoutQueryParamValue;
+
+ if ("basic".equals(authentication)) {
+ if (username != null && password != null && username.length() > 0 && password.length() > 0) {
+ authorizationString = buildAuthorizationString(username, password);
+ } else {
+ throw new IllegalStateException("Authentication is set to basic but username or password is missing");
+ }
+ } else if ("noauth".equals(authentication)) {
+ authorizationString = null;
+ } else {
+ throw new IllegalStateException("Unknown authentication method: " + authentication);
+ }
+ }
+
+ protected void poll() {
+ String responseBody = performHttpOperation();
+ if (responseBody != null && !responseBody.startsWith("[]")) {
+ LOG.info("New message was fetched from MessageRouter.");
+ LOG.trace("Fetched message is\n{}", responseBody);
+ try {
+ String[] requests = new Gson().fromJson(responseBody, String[].class);
+ if (requests != null) {
+ for (String request : requests) {
+ if (request != null) {
+ requestHandler.handleRequest(topic,request);
+ }
+ }
+ } else {
+ LOG.warn("Deserialization of received message results in null array.", responseBody);
+ }
+ } catch (JsonParseException e) {
+ LOG.warn("Received message has bad format. Expected format is JSON.");
+ }
+ } else {
+ LOG.trace("No new message was fetched from MessageRouter.");
+ }
+ }
+
+ private String buildlUrlString(String topic) {
+ StringBuilder sb = new StringBuilder();
+ sb.append(host + "/events/" + topic + "/" + group + "/" + id);
+ sb.append("?timeout=" + timeoutQueryParamValue);
+
+ if (limit != null) {
+ sb.append("&limit=" + limit);
+ }
+ if (filter != null) {
+ sb.append("&filter=" + filter);
+ }
+ return sb.toString();
+ }
+
+ private String performHttpOperation() {
+ HttpURLConnection httpUrlConnection = null;
+ try {
+ httpUrlConnection = buildHttpURLConnection(url);
+ httpUrlConnection.setRequestMethod(REQUEST_METHOD);
+ httpUrlConnection.connect();
+ int status = httpUrlConnection.getResponseCode();
+ if (status < 300) {
+ return readFromStream(httpUrlConnection.getInputStream());
+ } else {
+ String response = readFromStream(httpUrlConnection.getErrorStream());
+ LOG.warn("Fetching message from MessageRouter on url {} failed with http status {}. Error message is\n{}.", url, status, response);
+ }
+ } catch (Exception e) {
+ LOG.warn("Exception was thrown during fetching message from MessageRouter on url {}.", url, e);
+ } finally {
+ if (httpUrlConnection != null) {
+ httpUrlConnection.disconnect();
+ }
+ }
+ return null;
+ }
+
+ private String buildAuthorizationString(String userName, String password) {
+ String basicAuthString = userName + ":" + password;
+ basicAuthString = Base64.getEncoder().encodeToString(basicAuthString.getBytes());
+ return "Basic " + basicAuthString;
+ }
+
+ protected HttpURLConnection buildHttpURLConnection(URL url) throws IOException {
+ HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection();
+ if (authorizationString != null) {
+ httpUrlConnection.setRequestProperty("Authorization", authorizationString);
+ }
+ httpUrlConnection.setRequestProperty("Accept", "application/json");
+ httpUrlConnection.setUseCaches(false);
+ httpUrlConnection.setConnectTimeout(connectTimeout);
+ httpUrlConnection.setReadTimeout(readTimeout);
+
+ // ignore hostname errors when dealing with HTTPS connections
+ if (httpUrlConnection instanceof HttpsURLConnection) {
+ HttpsURLConnection conn = (HttpsURLConnection) httpUrlConnection;
+ conn.setHostnameVerifier(new HostnameVerifier() {
+ @Override
+ public boolean verify(String arg0, SSLSession arg1) {
+ return true;
+ }
+ });
+ }
+ return httpUrlConnection;
+ }
+
+ protected String readFromStream(InputStream stream) throws IOException {
+ BufferedReader br = new BufferedReader(new InputStreamReader(stream));
+ StringBuilder sb = new StringBuilder();
+ String line;
+ while ((line = br.readLine()) != null) {
+ sb.append(line);
+ sb.append("\n");
+ }
+ br.close();
+ return sb.toString();
+ }
+
+ @Override
+ public void registerHandler(String topic, RequestHandler requestHandler) {
+ this.topic = topic;
+ try {
+ this.url = new URL(buildlUrlString(topic));
+ } catch (MalformedURLException e) {
+ LOG.error("Topic " + topic + " resulted in MalformedURLException", e);
+ }
+ this.requestHandler = requestHandler;
+ }
+
+ @Override
+ public void close() throws Exception {
+ //BaseConsumer doesn't spawn any threads
+ }
+
+}
diff --git a/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/ConsumerFactory.java b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/ConsumerFactory.java
new file mode 100755
index 000000000..051380e1a
--- /dev/null
+++ b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/ConsumerFactory.java
@@ -0,0 +1,179 @@
+package org.onap.ccsdk.sli.adaptors.messagerouter.consumer.provider.impl;
+
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.util.Properties;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ConsumerFactory {
+ private static final Logger LOG = LoggerFactory.getLogger(ConsumerFactory.class);
+
+ // Default values to minimize required configuration
+ private static final int DEFAULT_FETCH_PAUSE = 5000;
+ private static final int DEFAULT_CONNECT_TIMEOUT = 30000;
+ private static final int DEFAULT_READ_TIMEOUT = 180000;
+ private static final int DEFAULT_LIMIT = 5; // Limits the number of messages pulled in a single GET request
+ private static final int DEFAULT_TIMEOUT_QUERY_PARAM_VALUE = 15000;
+ private static final String DEFAULT_AUTH_METHOD = "basic";
+
+ // Required properties
+ protected final String username;
+ protected final String password;
+ protected final String host;
+ private final String group;
+ private final String id;
+
+ // Optional properties
+ protected Integer connectTimeout;
+ protected Integer readTimeout;
+ private Integer fetchPause;
+ private Integer limit;
+ private Integer timeoutQueryParamValue;
+ private String filter;
+ protected String auth;
+
+ public String getAuth() {
+ return auth;
+ }
+
+ public void setAuth(String auth) {
+ this.auth = auth;
+ }
+
+ public Integer getConnectTimeout() {
+ return connectTimeout;
+ }
+
+ public void setConnectTimeout(Integer connectTimeout) {
+ this.connectTimeout = connectTimeout;
+ }
+
+ public Integer getReadTimeout() {
+ return readTimeout;
+ }
+
+ public void setReadTimeout(Integer readTimeout) {
+ this.readTimeout = readTimeout;
+ }
+
+ public Integer getFetchPause() {
+ return fetchPause;
+ }
+
+ public void setFetchPause(Integer fetchPause) {
+ this.fetchPause = fetchPause;
+ }
+
+ public Integer getLimit() {
+ return limit;
+ }
+
+ public void setLimit(Integer limit) {
+ this.limit = limit;
+ }
+
+ public Integer getTimeoutQueryParamValue() {
+ return timeoutQueryParamValue;
+ }
+
+ public void setTimeoutQueryParamValue(Integer timeoutQueryParamValue) {
+ this.timeoutQueryParamValue = timeoutQueryParamValue;
+ }
+
+ public String getFilter() {
+ return filter;
+ }
+
+ public void setFilter(String filter) {
+ processFilter(filter);
+ }
+
+ public ConsumerFactory(String username, String password, String host, String group, String id, Integer connectTimeout, Integer readTimeout) {
+ this.username = username;
+ this.password = password;
+ this.host = host;
+ this.group = group;
+ this.id = id;
+ setDefaults();
+ }
+
+ public ConsumerFactory(Properties properties) {
+ // Required properties
+ username = properties.getProperty("username");
+ password = properties.getProperty("password");
+ host = properties.getProperty("host");
+ auth = properties.getProperty("auth");
+ group = properties.getProperty("group");
+ id = properties.getProperty("id");
+
+ // Optional properties
+ connectTimeout = readOptionalInteger(properties, "connectTimeoutSeconds");
+ readTimeout = readOptionalInteger(properties, "readTimeoutMinutes");
+ fetchPause = readOptionalInteger(properties, "fetchPause");
+ limit = readOptionalInteger(properties, "limit");
+ timeoutQueryParamValue = readOptionalInteger(properties, "timeout");
+ processFilter(properties.getProperty("filter"));
+
+ setDefaults();
+ }
+
+ private Integer readOptionalInteger(Properties properties, String propertyName) {
+ String stringValue = properties.getProperty(propertyName);
+ if (stringValue != null && stringValue.length() > 0) {
+ try {
+ return Integer.valueOf(stringValue);
+ } catch (NumberFormatException e) {
+ LOG.error("property " + propertyName + " had the value " + stringValue + " that could not be converted to an Integer", e);
+ }
+ }
+ return null;
+ }
+
+ public PollingConsumerImpl createPollingClient() {
+ return new PollingConsumerImpl(username, password, host, auth, connectTimeout, readTimeout, fetchPause, group, id, filter, limit, timeoutQueryParamValue);
+ }
+
+ public PullingConsumerImpl createPullingClient() {
+ return new PullingConsumerImpl(username, password, host, auth, connectTimeout, readTimeout, group, id, filter, limit, timeoutQueryParamValue);
+ }
+
+ private void processFilter(String filterString) {
+ if (filterString != null) {
+ if (filterString.length() > 0) {
+ try {
+ filter = URLEncoder.encode(filterString, StandardCharsets.UTF_8.name());
+ } catch (UnsupportedEncodingException e) {
+ LOG.warn("Couldn't encode filter string. Filter will be ignored.", e);
+ filter = null;
+ }
+ } else {
+ filter = null;
+ }
+ }
+ }
+
+ private void setDefaults() {
+ if (connectTimeout == null) {
+ connectTimeout = DEFAULT_CONNECT_TIMEOUT;
+ }
+ if (readTimeout == null) {
+ readTimeout = DEFAULT_READ_TIMEOUT;
+ }
+ if (fetchPause == null) {
+ fetchPause = DEFAULT_FETCH_PAUSE;
+ }
+ if (limit == null) {
+ limit = DEFAULT_LIMIT;
+ }
+ if (timeoutQueryParamValue == null) {
+ timeoutQueryParamValue = DEFAULT_TIMEOUT_QUERY_PARAM_VALUE;
+ }
+ if (auth == null) {
+ auth = DEFAULT_AUTH_METHOD;
+ }
+ }
+
+}
diff --git a/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PollingConsumerImpl.java b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PollingConsumerImpl.java
new file mode 100644
index 000000000..263e94ca9
--- /dev/null
+++ b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PollingConsumerImpl.java
@@ -0,0 +1,100 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * openECOMP : SDN-C
+ * ================================================================================
+ * Copyright (C) 2017 - 2018 AT&T Intellectual Property. All rights
+ * reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.adaptors.messagerouter.consumer.provider.impl;
+
+import org.onap.ccsdk.sli.adaptors.messagerouter.consumer.api.PollingConsumer;
+import org.onap.ccsdk.sli.adaptors.messagerouter.consumer.api.RequestHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/*
+ * java.net based client to build message router consumers
+ */
+public class PollingConsumerImpl implements PollingConsumer {
+
+ //RunnableConsumer is a private inner class so run cannot be called from other code
+ private class RunnableConsumer extends AbstractBaseConsumer implements Runnable, PollingConsumer {
+ private final Logger LOG = LoggerFactory.getLogger(PollingConsumerImpl.class);
+ private volatile Thread t;
+ private final Integer fetchPause;
+
+ public RunnableConsumer(String username, String password, String host, String authentication, Integer connectTimeout, Integer readTimeout, Integer fetchPause, String group, String id, String filter, Integer limit, Integer timeoutQueryParamValue) {
+ super(username, password, host, authentication, connectTimeout, readTimeout, group, id, filter, limit, timeoutQueryParamValue);
+ this.fetchPause = fetchPause;
+ }
+
+ public void start() {
+ t = new Thread(this);
+ t.start();
+ LOG.info("ConsumerImpl started. Fetch period is {} ms.", fetchPause);
+ }
+
+ public void stop() {
+ t = null;
+ LOG.info("ConsumerImpl stopped.");
+ }
+
+ @Override
+ public void run() {
+ if (this.url != null) {
+ Thread thisThread = Thread.currentThread();
+ while (t == thisThread) {
+ poll();
+ try {
+ LOG.trace("Next fetch from MessageRouter url {} after {} milliseconds.", url, fetchPause);
+ Thread.sleep(fetchPause);
+ } catch (InterruptedException e) {
+ LOG.warn("Thread sleep was interrupted.", e);
+ }
+ }
+ } else {
+ LOG.error("URL is null, can't listen for messages");
+ }
+ }
+
+ @Override
+ public void close() throws Exception {
+ stop();
+ }
+ }
+
+ private RunnableConsumer c;
+
+ public PollingConsumerImpl(String username, String password, String host, String authentication, Integer connectTimeout, Integer readTimeout, Integer fetchPause, String group, String id, String filter, Integer limit, Integer timeoutQueryParamValue) {
+ c = new RunnableConsumer(username, password, host, authentication, connectTimeout, readTimeout, fetchPause, group, id, filter, limit, timeoutQueryParamValue);
+ }
+
+ @Override
+ public void start() {
+ c.start();
+ }
+
+ @Override
+ public void registerHandler(String topic, RequestHandler requestHandler) {
+ c.registerHandler(topic, requestHandler);
+ }
+
+ @Override
+ public void close() throws Exception {
+ c.close();
+ }
+}
diff --git a/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PullingConsumerImpl.java b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PullingConsumerImpl.java
new file mode 100755
index 000000000..b3f0aef4e
--- /dev/null
+++ b/message-router/consumer/provider/src/main/java/org/onap/ccsdk/sli/adaptors/messagerouter/consumer/provider/impl/PullingConsumerImpl.java
@@ -0,0 +1,17 @@
+package org.onap.ccsdk.sli.adaptors.messagerouter.consumer.provider.impl;
+
+import org.onap.ccsdk.sli.adaptors.messagerouter.consumer.api.PullingConsumer;
+import org.onap.ccsdk.sli.adaptors.messagerouter.consumer.api.RequestHandler;
+
+public class PullingConsumerImpl extends AbstractBaseConsumer implements PullingConsumer {
+
+ public PullingConsumerImpl(String username, String password, String host, String authentication, Integer connectTimeout, Integer readTimeout, String group, String id, String filter, Integer limit, Integer timeoutQueryParamValue) {
+ super(username, password, host, authentication, connectTimeout, readTimeout, group, id, filter, limit, timeoutQueryParamValue);
+ }
+
+ @Override
+ public void pull() {
+ this.poll();
+ }
+
+}