Merge pull request #462 from marklogic-community/feature/170-okhttp-refactor

rjrudin · web-flow · commit 30b87b44e9d6 · 2023-01-23T08:11:08.000-08:00
DEVEXP-170 Using OkHttp to connect to Manage API
diff --git a/build.gradle b/build.gradle
@@ -30,13 +30,15 @@ configurations.all {
 }
 
 dependencies {
-	api ('com.marklogic:ml-javaclient-util:4.5-SNAPSHOT') {
+	api('com.marklogic:ml-javaclient-util:4.5-SNAPSHOT') {
 		changing = true
 	}
-  api 'org.springframework:spring-web:5.3.24'
+	api 'org.springframework:spring-web:5.3.24'
 	api 'com.fasterxml.jackson.core:jackson-databind:2.14.1'
 
 	implementation 'jaxen:jaxen:1.2.0'
+	implementation 'com.squareup.okhttp3:okhttp:4.10.0'
+	implementation 'io.github.rburgst:okhttp-digest:2.7'
 	implementation 'org.apache.httpcomponents:httpclient:4.5.13'
 	implementation 'org.jdom:jdom2:2.0.6.1'
 
diff --git a/src/main/java/com/marklogic/rest/util/HttpClientBuilderConfigurer.java b/src/main/java/com/marklogic/rest/util/HttpClientBuilderConfigurer.java
@@ -2,6 +2,10 @@
 
 import org.apache.http.impl.client.HttpClientBuilder;
 
+/**
+ * @deprecated since 4.5.0; OkHttp is now the preferred client
+ */
+@Deprecated
 public interface HttpClientBuilderConfigurer {
 
 	HttpClientBuilder configureHttpClientBuilder(RestConfig restConfig, HttpClientBuilder httpClientBuilder);
diff --git a/src/main/java/com/marklogic/rest/util/RestConfig.java b/src/main/java/com/marklogic/rest/util/RestConfig.java
@@ -1,6 +1,12 @@
 package com.marklogic.rest.util;
 
+import com.marklogic.client.DatabaseClientBuilder;
+import com.marklogic.client.DatabaseClientFactory;
+import com.marklogic.client.ext.modulesloader.ssl.SimpleX509TrustManager;
+import com.marklogic.client.ext.ssl.SslConfig;
+import com.marklogic.client.ext.ssl.SslUtil;
 import org.apache.http.conn.ssl.X509HostnameVerifier;
+import org.springframework.util.StringUtils;
 
 import javax.net.ssl.SSLContext;
 import java.net.URI;
@@ -18,8 +24,9 @@ public class RestConfig {
 	private boolean useDefaultKeystore;
 	private String sslProtocol;
 	private String trustManagementAlgorithm;
-
+	private DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier;
 	private SSLContext sslContext;
+	@Deprecated
 	private X509HostnameVerifier hostnameVerifier;
 
 	public RestConfig() {
@@ -37,12 +44,50 @@ public RestConfig(RestConfig other) {
 		if (other.scheme != null) {
 			this.scheme = other.scheme;
 		}
+
 		this.configureSimpleSsl = other.configureSimpleSsl;
 		this.useDefaultKeystore = other.useDefaultKeystore;
 		this.sslProtocol = other.sslProtocol;
 		this.trustManagementAlgorithm = other.trustManagementAlgorithm;
 		this.sslContext = other.sslContext;
 		this.hostnameVerifier = other.hostnameVerifier;
+		this.sslHostnameVerifier = other.sslHostnameVerifier;
+	}
+
+	public DatabaseClientBuilder newDatabaseClientBuilder() {
+		DatabaseClientBuilder builder = new DatabaseClientBuilder()
+			.withHost(getHost())
+			.withPort(getPort())
+			// TODO Will support all types before the 4.5.0 release
+			.withSecurityContextType("digest")
+			.withUsername(getUsername())
+			.withPassword(getPassword());
+
+		if (getSslContext() != null) {
+			builder.withSSLContext(getSslContext());
+		} else {
+			String sslProtocol = getSslProtocol();
+			// The MarkLogic Java Client will default to using the JVM's default trust manager if none is specified.
+			// This block though honors the existing "use default keystore" option, which allows for the user to also
+			// specify a trust management algorithm.
+			if (isUseDefaultKeystore()) {
+				sslProtocol = StringUtils.hasText(sslProtocol) ? sslProtocol : SslUtil.DEFAULT_SSL_PROTOCOL;
+				SslConfig sslConfig = SslUtil.configureUsingTrustManagerFactory(sslProtocol, getTrustManagementAlgorithm());
+				builder
+					.withSSLContext(sslConfig.getSslContext())
+					.withTrustManager(sslConfig.getTrustManager());
+			} else if (isConfigureSimpleSsl()) {
+				builder
+					.withSSLContext(StringUtils.hasText(sslProtocol) ?
+						SimpleX509TrustManager.newSSLContext(sslProtocol) :
+						SimpleX509TrustManager.newSSLContext())
+					.withTrustManager(new SimpleX509TrustManager());
+			} else {
+				builder.withSSLProtocol(sslProtocol);
+			}
+		}
+
+		return builder;
 	}
 
 	@Override
@@ -127,10 +172,12 @@ public void setSslContext(SSLContext sslContext) {
 		this.sslContext = sslContext;
 	}
 
+	@Deprecated
 	public X509HostnameVerifier getHostnameVerifier() {
 		return hostnameVerifier;
 	}
 
+	@Deprecated
 	public void setHostnameVerifier(X509HostnameVerifier hostnameVerifier) {
 		this.hostnameVerifier = hostnameVerifier;
 	}
@@ -158,4 +205,12 @@ public boolean isUseDefaultKeystore() {
 	public void setUseDefaultKeystore(boolean useDefaultKeystore) {
 		this.useDefaultKeystore = useDefaultKeystore;
 	}
+
+	public DatabaseClientFactory.SSLHostnameVerifier getSslHostnameVerifier() {
+		return sslHostnameVerifier;
+	}
+
+	public void setSslHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier) {
+		this.sslHostnameVerifier = sslHostnameVerifier;
+	}
 }
diff --git a/src/main/java/com/marklogic/rest/util/RestTemplateUtil.java b/src/main/java/com/marklogic/rest/util/RestTemplateUtil.java
@@ -1,14 +1,18 @@
 package com.marklogic.rest.util;
 
+import com.marklogic.client.DatabaseClientFactory;
+import com.marklogic.client.extra.okhttpclient.OkHttpClientBuilderFactory;
 import com.marklogic.rest.util.configurer.BasicAuthConfigurer;
 import com.marklogic.rest.util.configurer.NoConnectionReuseConfigurer;
 import com.marklogic.rest.util.configurer.SslConfigurer;
 import com.marklogic.rest.util.configurer.UseSystemPropertiesConfigurer;
+import okhttp3.OkHttpClient;
 import org.apache.http.client.HttpClient;
 import org.apache.http.impl.client.HttpClientBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
+import org.springframework.http.client.OkHttp3ClientHttpRequestFactory;
 import org.springframework.web.client.RestTemplate;
 
 import java.util.ArrayList;
@@ -31,6 +35,10 @@ public class RestTemplateUtil {
 
 	private final static Logger logger = LoggerFactory.getLogger(RestTemplateUtil.class);
 
+	/**
+	 * @deprecated since 4.5.0; OkHttp is now the preferred client
+	 */
+	@Deprecated
 	public static List<HttpClientBuilderConfigurer> DEFAULT_CONFIGURERS = new ArrayList<>();
 
 	static {
@@ -40,22 +48,52 @@ public class RestTemplateUtil {
 		DEFAULT_CONFIGURERS.add(new UseSystemPropertiesConfigurer());
 	}
 
+	/**
+	 * @deprecated since 4.5.0; OkHttp is now the preferred client
+	 */
+	@Deprecated
 	public static RestTemplate newRestTemplate(String host, int port, String username, String password) {
 		return newRestTemplate(new RestConfig(host, port, username, password));
 	}
 
-	public static RestTemplate newRestTemplate(String host, int port, String username, String password, HttpClientBuilderConfigurer... configurers) {
-		return newRestTemplate(new RestConfig(host, port, username, password), configurers);
+	/**
+	 * As of 4.5.0, use this method for constructing a {@code RestTemplate} that supports all authentication types
+	 * supported by MarkLogic. ml-app-deployer is expected to use this for all calls as well starting in 4.5.0.
+	 *
+	 * @param config
+	 * @return
+	 */
+	public static RestTemplate newRestTemplate(RestConfig config) {
+		DatabaseClientFactory.Bean bean = config.newDatabaseClientBuilder().buildBean();
+		OkHttpClient client = OkHttpClientBuilderFactory
+			.newOkHttpClientBuilder(bean.getHost(), bean.getPort(), bean.getSecurityContext())
+			.build();
+
+		RestTemplate rt = new RestTemplate(new OkHttp3ClientHttpRequestFactory(client));
+		rt.setErrorHandler(new MgmtResponseErrorHandler());
+		return rt;
 	}
 
-	public static RestTemplate newRestTemplate(RestConfig config) {
-		return newRestTemplate(config, DEFAULT_CONFIGURERS);
+	/**
+	 * @deprecated since 4.5.0; OkHttp is now the preferred client
+	 */
+	@Deprecated
+	public static RestTemplate newRestTemplate(String host, int port, String username, String password, HttpClientBuilderConfigurer... configurers) {
+		return newRestTemplate(new RestConfig(host, port, username, password), configurers);
 	}
 
+	/**
+	 * @deprecated since 4.5.0; OkHttp is now the preferred client
+	 */
+	@Deprecated
 	public static RestTemplate newRestTemplate(RestConfig config, List<HttpClientBuilderConfigurer> configurers) {
 		return newRestTemplate(config, configurers.toArray(new HttpClientBuilderConfigurer[]{}));
 	}
 
+	/**
+	 * @deprecated since 4.5.0; OkHttp is now the preferred client
+	 */
+	@Deprecated
 	public static RestTemplate newRestTemplate(RestConfig config, HttpClientBuilderConfigurer... configurers) {
 		HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
 
diff --git a/src/main/java/com/marklogic/rest/util/configurer/BasicAuthConfigurer.java b/src/main/java/com/marklogic/rest/util/configurer/BasicAuthConfigurer.java
@@ -7,6 +7,10 @@
 import org.apache.http.impl.client.BasicCredentialsProvider;
 import org.apache.http.impl.client.HttpClientBuilder;
 
+/**
+ * @deprecated since 4.5.0; OkHttp is now the preferred client
+ */
+@Deprecated
 public class BasicAuthConfigurer implements HttpClientBuilderConfigurer {
 
 	@Override
diff --git a/src/main/java/com/marklogic/rest/util/configurer/NoConnectionReuseConfigurer.java b/src/main/java/com/marklogic/rest/util/configurer/NoConnectionReuseConfigurer.java
@@ -5,6 +5,10 @@
 import org.apache.http.impl.NoConnectionReuseStrategy;
 import org.apache.http.impl.client.HttpClientBuilder;
 
+/**
+ * @deprecated since 4.5.0; OkHttp is now the preferred client
+ */
+@Deprecated
 public class NoConnectionReuseConfigurer implements HttpClientBuilderConfigurer {
 
 	@Override
diff --git a/src/main/java/com/marklogic/rest/util/configurer/SslConfigurer.java b/src/main/java/com/marklogic/rest/util/configurer/SslConfigurer.java
@@ -11,6 +11,10 @@
 
 import javax.net.ssl.SSLContext;
 
+/**
+ * @deprecated since 4.5.0; OkHttp is now the preferred client
+ */
+@Deprecated
 public class SslConfigurer extends LoggingObject implements HttpClientBuilderConfigurer {
 
 	/**
diff --git a/src/main/java/com/marklogic/rest/util/configurer/UseSystemPropertiesConfigurer.java b/src/main/java/com/marklogic/rest/util/configurer/UseSystemPropertiesConfigurer.java
@@ -4,6 +4,10 @@
 import com.marklogic.rest.util.RestConfig;
 import org.apache.http.impl.client.HttpClientBuilder;
 
+/**
+ * @deprecated since 4.5.0; OkHttp is now the preferred client
+ */
+@Deprecated
 public class UseSystemPropertiesConfigurer implements HttpClientBuilderConfigurer {
 
 	@Override
diff --git a/src/test/java/com/marklogic/appdeployer/command/viewschemas/ManageViewSchemasTest.java b/src/test/java/com/marklogic/appdeployer/command/viewschemas/ManageViewSchemasTest.java
@@ -8,6 +8,7 @@
 import com.marklogic.mgmt.resource.ResourceManager;
 import com.marklogic.mgmt.resource.clusters.ClusterManager;
 import com.marklogic.mgmt.resource.viewschemas.ViewSchemaManager;
+import com.marklogic.rest.util.RestConfig;
 import com.marklogic.rest.util.RestTemplateUtil;
 import org.jdom2.Namespace;
 import org.springframework.http.ResponseEntity;
@@ -56,8 +57,9 @@ protected void verifyResourcesWereDeleted(ResourceManager mgr) {
 	 */
 	@Override
 	protected void afterResourcesCreated() {
-		RestTemplate clientTemplate = RestTemplateUtil.newRestTemplate(appConfig.getHost(), appConfig.getRestPort(),
+		RestConfig restConfig = new RestConfig(appConfig.getHost(), appConfig.getRestPort(),
 			appConfig.getRestAdminUsername(), appConfig.getRestAdminPassword());
+		RestTemplate clientTemplate = RestTemplateUtil.newRestTemplate(restConfig);
 
 		String baseUrl = format("http://%s:%d", appConfig.getHost(), appConfig.getRestPort());
 
diff --git a/src/test/java/com/marklogic/mgmt/ManageClientTest.java b/src/test/java/com/marklogic/mgmt/ManageClientTest.java
@@ -9,6 +9,7 @@ public class ManageClientTest  {
 	public void determineUsernameForSecurityUserRequest() {
 		ManageConfig config = new ManageConfig();
 		config.setSecurityUsername("admin");
+		config.setSecurityPassword("admin");
 		config.setUsername("someone");
 
 		ManageClient client = new ManageClient(config);
diff --git a/src/test/java/com/marklogic/rest/util/RestTemplateUtilTest.java b/src/test/java/com/marklogic/rest/util/RestTemplateUtilTest.java
@@ -9,7 +9,10 @@
 
 import javax.net.ssl.SSLContext;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
 
 /**
  * Many of these tests are just smoke tests that can be used to inspect logging as well. Ideally, they can soon depend
@@ -23,18 +26,24 @@ public class RestTemplateUtilTest extends BaseTestHelper {
 	private ManageConfig manageConfig = new ManageConfig();
 
 	@Test
+	@Deprecated
 	public void configurerList() {
 		assertEquals(4, RestTemplateUtil.DEFAULT_CONFIGURERS.size());
 
 		assertFalse(configurerInvoked);
-		RestTemplateUtil.DEFAULT_CONFIGURERS.add((restConfig, builder) -> {
+		HttpClientBuilderConfigurer configurer = (restConfig, builder) -> {
 			logger.info("Just a test of adding a configurer");
 			configurerInvoked = true;
 			return builder;
-		});
+		};
 
 		new ManageClient(manageConfig);
-		assertTrue(configurerInvoked);
+		assertFalse(configurerInvoked, "The configurer should not be invoked now that ManageClient uses OkHttp " +
+			"instead of Apache HTTP");
+
+		RestTemplateUtil.newRestTemplate(manageConfig, configurer);
+		assertTrue(configurerInvoked, "The configurer should have been invoked since a deprecated newRestTemplate " +
+			"method was used that still honors HttpClientBuilderConfigurer instances");
 	}
 
 	@Test
