diff options
Diffstat (limited to 'adaptors/base/http/provider')
6 files changed, 240 insertions, 0 deletions
diff --git a/adaptors/base/http/provider/pom.xml b/adaptors/base/http/provider/pom.xml new file mode 100644 index 000000000..5a3642fd2 --- /dev/null +++ b/adaptors/base/http/provider/pom.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.onap.ccsdk.parent</groupId> + <artifactId>binding-parent</artifactId> + <version>2.1.0</version> + <relativePath/> + </parent> + + <groupId>org.onap.ccsdk.sli.adaptors</groupId> + <artifactId>base-http-provider</artifactId> + <version>1.1.1-SNAPSHOT</version> + <packaging>bundle</packaging> + + <dependencies> + <dependency> + <groupId>javax.ws.rs</groupId> + <artifactId>javax.ws.rs-api</artifactId> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.glassfish.jersey.core</groupId> + <artifactId>jersey-client</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.onap.logging-analytics</groupId> + <artifactId>logging-filter-base</artifactId> + <scope>provided</scope> + </dependency> + </dependencies> +</project> diff --git a/adaptors/base/http/provider/src/main/java/org/onap/ccsdk/sli/adaptors/base/http/AbstractHttpAdapter.java b/adaptors/base/http/provider/src/main/java/org/onap/ccsdk/sli/adaptors/base/http/AbstractHttpAdapter.java new file mode 100644 index 000000000..cc6f06a4d --- /dev/null +++ b/adaptors/base/http/provider/src/main/java/org/onap/ccsdk/sli/adaptors/base/http/AbstractHttpAdapter.java @@ -0,0 +1,114 @@ +package org.onap.ccsdk.sli.adaptors.base.http; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.util.Base64; +import java.util.Properties; +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.SSLSession; +import javax.ws.rs.client.ClientBuilder; +import org.onap.logging.filter.base.MetricLogClientFilter; +import org.onap.logging.filter.base.PayloadLoggingClientFilter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public abstract class AbstractHttpAdapter { + protected static final String SDNC_CONFIG_DIR = "SDNC_CONFIG_DIR"; + private static final String SDNC_CONFIG_DIR_DEFAULT = "/opt/sdnc/data/properties"; + protected static final int DEFAULT_HTTP_CONNECT_TIMEOUT_MS = 60000; // 1 minute + protected static final int DEFAULT_HTTP_READ_TIMEOUT_MS = 1800000; // 30 minutes + protected ClientBuilder clientBuilder; + + private static final Logger logger = LoggerFactory.getLogger(AbstractHttpAdapter.class); + + public AbstractHttpAdapter() { + clientBuilder = ClientBuilder.newBuilder(); + setTimeouts(); + defaultHostNameVerifier(); + } + + private void defaultHostNameVerifier() { + clientBuilder.hostnameVerifier(new HostnameVerifier() { + @Override + public boolean verify(String hostname, SSLSession session) { + return true; + } + }); + } + + protected void enableMetricLogging() { + clientBuilder.register(new MetricLogClientFilter()); + } + + protected void enablePayloadLogging() { + clientBuilder.register(new PayloadLoggingClientFilter()); + } + + private void setTimeouts() { + Integer httpReadTimeout = readOptionalInteger("HTTP_READ_TIMEOUT_MS", DEFAULT_HTTP_READ_TIMEOUT_MS); + Integer httpConnectTimeout = readOptionalInteger("HTTP_CONNECT_TIMEOUT_MS", DEFAULT_HTTP_CONNECT_TIMEOUT_MS); + + // restore once we migrate to once we migrate to javax.ws.rs-api 2.1 + // clientBuilder.connectTimeout(30, TimeUnit.SECONDS); + // clientBuilder.readTimeout(30, TimeUnit.SECONDS); + + // Setting jersey specific properties is ugly, such behavior should be removed + // once we migrate to javax.ws.rs-api 2.1 + clientBuilder.property("jersey.config.client.readTimeout", httpReadTimeout); + clientBuilder.property("jersey.config.client.connectTimeout", httpConnectTimeout); + } + + public Properties getProperties(String propertiesFileName) throws FileNotFoundException, IOException { + // Check System property, then environment variable then default if null + String propDir = System.getProperty(SDNC_CONFIG_DIR); + if (propDir == null || propDir.length() < 1) { + propDir = System.getenv(SDNC_CONFIG_DIR); + } + if (propDir == null || propDir.length() < 1) { + propDir = SDNC_CONFIG_DIR_DEFAULT; + } + Properties properties = new Properties(); + // forward slash is checked to support path src/test/resources on windows machine + if (!propDir.endsWith(File.separator) && !propDir.endsWith("/")) { + propDir = propDir + File.separator; + } + String path = propDir + propertiesFileName; + properties.load(new FileInputStream(path)); + logger.trace("Initialized properties from ({}) properties ({})", path, properties); + return properties; + } + + protected void addBasicAuthCredentials(String username, String password) { + String basicAuthValue = getBasicAuthValue(username,password); + clientBuilder.register(new BasicAuthFilter(basicAuthValue)); + } + + protected String getBasicAuthValue(String userName, String password) { + String token = userName + ":" + password; + try { + return "Basic " + Base64.getEncoder().encodeToString(token.getBytes()); + } catch (Exception e) { + logger.error("getBasicAuthValue threw an exception, credentials will be null", e); + } + return null; + } + + public ClientBuilder getClientBuilder() { + return clientBuilder; + } + + private Integer readOptionalInteger(String propertyName, Integer defaultValue) { + String stringValue = System.getProperty(propertyName); + if (stringValue != null && stringValue.length() > 0) { + try { + return Integer.valueOf(stringValue); + } catch (NumberFormatException e) { + logger.warn("property " + propertyName + " had the value " + stringValue + " that could not be converted to an Integer, default " + defaultValue + " will be used instead", e); + } + } + return defaultValue; + } + +} diff --git a/adaptors/base/http/provider/src/main/java/org/onap/ccsdk/sli/adaptors/base/http/BasicAuthFilter.java b/adaptors/base/http/provider/src/main/java/org/onap/ccsdk/sli/adaptors/base/http/BasicAuthFilter.java new file mode 100644 index 000000000..5d3d463c9 --- /dev/null +++ b/adaptors/base/http/provider/src/main/java/org/onap/ccsdk/sli/adaptors/base/http/BasicAuthFilter.java @@ -0,0 +1,22 @@ +package org.onap.ccsdk.sli.adaptors.base.http; + +import java.io.IOException; + +import javax.ws.rs.client.ClientRequestContext; +import javax.ws.rs.client.ClientRequestFilter; +import javax.ws.rs.core.MultivaluedMap; + +public class BasicAuthFilter implements ClientRequestFilter { + private final String basicAuthValue; + + public BasicAuthFilter(String basicAuthValue) { + this.basicAuthValue = basicAuthValue; + } + + public void filter(ClientRequestContext requestContext) throws IOException { + MultivaluedMap<String, Object> headers = requestContext.getHeaders(); + headers.add("Authorization", basicAuthValue); + } + + +} diff --git a/adaptors/base/http/provider/src/test/java/org/onap/ccsdk/sli/adaptors/base/http/AbstractHttpAdapterTest.java b/adaptors/base/http/provider/src/test/java/org/onap/ccsdk/sli/adaptors/base/http/AbstractHttpAdapterTest.java new file mode 100644 index 000000000..d0973d90e --- /dev/null +++ b/adaptors/base/http/provider/src/test/java/org/onap/ccsdk/sli/adaptors/base/http/AbstractHttpAdapterTest.java @@ -0,0 +1,44 @@ +package org.onap.ccsdk.sli.adaptors.base.http;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.util.Properties;
+import java.util.Set;
+
+import javax.ws.rs.client.Client;
+
+import org.junit.Test;
+
+public class AbstractHttpAdapterTest {
+
+ public class TestAdapter extends AbstractHttpAdapter {
+
+ }
+
+ @Test
+ public void checkTimeouts() throws Exception {
+ TestAdapter adapter = new TestAdapter();
+ Client client = adapter.getClientBuilder().build();
+ assertNotNull(client.getConfiguration().getProperty("jersey.config.client.readTimeout"));
+ assertNotNull(client.getConfiguration().getProperty("jersey.config.client.connectTimeout"));
+ }
+
+ @Test
+ public void propertiesTest() throws Exception {
+ System.setProperty(AbstractHttpAdapter.SDNC_CONFIG_DIR, "src/test/resources/");
+ TestAdapter adapter = new TestAdapter();
+ Properties props = adapter.getProperties("testprops.properties");
+ assertNotNull(props);
+ assertEquals("world", props.get("hello"));
+ }
+
+ @Test
+ public void basicAuthFilter() throws Exception {
+ TestAdapter adapter = new TestAdapter();
+ adapter.addBasicAuthCredentials("hello", "world");
+ Set<Object> objs = adapter.getClientBuilder().getConfiguration().getInstances();
+ assertEquals(BasicAuthFilter.class,objs.iterator().next().getClass());
+ }
+
+}
diff --git a/adaptors/base/http/provider/src/test/java/org/onap/ccsdk/sli/adaptors/base/http/BasicAuthFilterTest.java b/adaptors/base/http/provider/src/test/java/org/onap/ccsdk/sli/adaptors/base/http/BasicAuthFilterTest.java new file mode 100644 index 000000000..d9d552dac --- /dev/null +++ b/adaptors/base/http/provider/src/test/java/org/onap/ccsdk/sli/adaptors/base/http/BasicAuthFilterTest.java @@ -0,0 +1,20 @@ +package org.onap.ccsdk.sli.adaptors.base.http; + +import static org.junit.Assert.assertNotNull; + +import org.junit.Test; + +public class BasicAuthFilterTest { + + @Test + public void notNullParameters() throws Exception { + BasicAuthFilter myFilter = new BasicAuthFilter("hello"); + assertNotNull(myFilter); + } + + @Test + public void nullParameters() throws Exception { + BasicAuthFilter myFilter = new BasicAuthFilter(null); + assertNotNull(myFilter); + } +} diff --git a/adaptors/base/http/provider/src/test/resources/testprops.properties b/adaptors/base/http/provider/src/test/resources/testprops.properties new file mode 100644 index 000000000..3f602680e --- /dev/null +++ b/adaptors/base/http/provider/src/test/resources/testprops.properties @@ -0,0 +1 @@ +hello = world
\ No newline at end of file |