Move Proxy parsing logic from connectors to a common class

Signed-off-by: jansupol <jan.supol@oracle.com>
eclipse-ee4j · Jul 21, 2022 · aac1cac · aac1cac
1 parent a83d288
commit aac1cac
Show file tree

Hide file tree

Showing 17 changed files with 323 additions and 229 deletions.
diff --git a/...apache-connector/src/main/java/org/glassfish/jersey/apache/connector/ApacheConnector.java b/...apache-connector/src/main/java/org/glassfish/jersey/apache/connector/ApacheConnector.java
@@ -29,6 +29,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Future;
 import java.util.concurrent.atomic.AtomicLong;
@@ -51,6 +52,7 @@
 import org.glassfish.jersey.client.ClientRequest;
 import org.glassfish.jersey.client.ClientResponse;
 import org.glassfish.jersey.client.RequestEntityProcessing;
+import org.glassfish.jersey.client.innate.ClientProxy;
 import org.glassfish.jersey.client.spi.AsyncConnectorCallback;
 import org.glassfish.jersey.client.spi.Connector;
 import org.glassfish.jersey.internal.util.PropertiesHelper;
@@ -279,28 +281,20 @@ class ApacheConnector implements Connector {
  clientBuilder.setRetryHandler((HttpRequestRetryHandler) retryHandler);
  }
 
- final Object proxyUri;
- proxyUri = config.getProperty(ClientProperties.PROXY_URI);
- if (proxyUri != null) {
- final URI u = getProxyUri(proxyUri);
- final HttpHost proxy = new HttpHost(u.getHost(), u.getPort(), u.getScheme());
- final String userName;
- userName = ClientProperties.getValue(config.getProperties(), ClientProperties.PROXY_USERNAME, String.class);
- if (userName != null) {
- final String password;
- password = ClientProperties.getValue(config.getProperties(), ClientProperties.PROXY_PASSWORD, String.class);
-
- if (password != null) {
- final CredentialsProvider credsProvider = new BasicCredentialsProvider();
- credsProvider.setCredentials(
- new AuthScope(u.getHost(), u.getPort()),
- new UsernamePasswordCredentials(userName, password)
- );
- clientBuilder.setDefaultCredentialsProvider(credsProvider);
- }
+ final Optional<ClientProxy> proxy = ClientProxy.proxyFromConfiguration(config);
+ proxy.ifPresent(clientProxy -> {
+ final URI u = clientProxy.uri();
+ final HttpHost proxyHost = new HttpHost(u.getHost(), u.getPort(), u.getScheme());
+ if (clientProxy.userName() != null && clientProxy.password() != null) {
+ final CredentialsProvider credsProvider = new BasicCredentialsProvider();
+ credsProvider.setCredentials(
+ new AuthScope(u.getHost(), u.getPort()),
+ new UsernamePasswordCredentials(clientProxy.userName(), clientProxy.password())
+ );
+ clientBuilder.setDefaultCredentialsProvider(credsProvider);
  }
- clientBuilder.setProxy(proxy);
- }
+ clientBuilder.setProxy(proxyHost);
+ });
 
  final Boolean preemptiveBasicAuthProperty = (Boolean) config.getProperties()
  .get(ApacheClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION);
@@ -452,16 +446,6 @@ public CookieStore getCookieStore() {
  return cookieStore;
  }
 
- private static URI getProxyUri(final Object proxy) {
- if (proxy instanceof URI) {
- return (URI) proxy;
- } else if (proxy instanceof String) {
- return URI.create((String) proxy);
- } else {
- throw new ProcessingException(LocalizationMessages.WRONG_PROXY_URI_TYPE(ClientProperties.PROXY_URI));
- }
- }
-
  @Override
  public ClientResponse apply(final ClientRequest clientRequest) throws ProcessingException {
  final HttpUriRequest request = getUriHttpRequest(clientRequest);

diff --git a/...onnector/src/main/resources/org/glassfish/jersey/apache/connector/localization.properties b/...onnector/src/main/resources/org/glassfish/jersey/apache/connector/localization.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2020 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
 #
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License v. 2.0, which is available at
@@ -19,7 +19,5 @@ error.reading.httpentity.stream=Error reading InputStream from HttpEntity: "{0}"
 failed.to.stop.client=Failed to stop the client.
 # {0} - property name, e.g. jersey.config.client.httpclient.connectionManager; {1}, {2} - full class name
 ignoring.value.of.property=Ignoring value of property "{0}" ("{1}") - not instance of "{2}".
-# {0} - property name - jersey.config.client.httpclient.proxyUri
-wrong.proxy.uri.type=The proxy URI ("{0}") property MUST be an instance of String or URI.
 invalid.configurable.component.type=The supplied component "{0}" is not assignable from JerseyClient or JerseyWebTarget.
 expected.connector.provider.not.used=The supplied component is not configured to use a ApacheConnectorProvider.
diff --git a/...che5-connector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5Connector.java b/...che5-connector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5Connector.java
@@ -30,6 +30,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Future;
 import java.util.logging.Level;
@@ -93,6 +94,7 @@
 import org.glassfish.jersey.client.ClientRequest;
 import org.glassfish.jersey.client.ClientResponse;
 import org.glassfish.jersey.client.RequestEntityProcessing;
+import org.glassfish.jersey.client.innate.ClientProxy;
 import org.glassfish.jersey.client.spi.AsyncConnectorCallback;
 import org.glassfish.jersey.client.spi.Connector;
 import org.glassfish.jersey.internal.util.PropertiesHelper;
@@ -280,28 +282,20 @@ class Apache5Connector implements Connector {
  clientBuilder.setRetryStrategy((HttpRequestRetryStrategy) retryHandler);
  }
 
- final Object proxyUri;
- proxyUri = config.getProperty(ClientProperties.PROXY_URI);
- if (proxyUri != null) {
- final URI u = getProxyUri(proxyUri);
- final HttpHost proxy = new HttpHost(u.getScheme(), u.getHost(), u.getPort());
- final String userName;
- userName = ClientProperties.getValue(config.getProperties(), ClientProperties.PROXY_USERNAME, String.class);
- if (userName != null) {
- final String password;
- password = ClientProperties.getValue(config.getProperties(), ClientProperties.PROXY_PASSWORD, String.class);
-
- if (password != null) {
- final CredentialsStore credsProvider = new BasicCredentialsProvider();
- credsProvider.setCredentials(
- new AuthScope(u.getHost(), u.getPort()),
- new UsernamePasswordCredentials(userName, password.toCharArray())
- );
- clientBuilder.setDefaultCredentialsProvider(credsProvider);
- }
+ final Optional<ClientProxy> proxy = ClientProxy.proxyFromConfiguration(config);
+ proxy.ifPresent(clientProxy -> {
+ final URI u = clientProxy.uri();
+ final HttpHost proxyHost = new HttpHost(u.getScheme(), u.getHost(), u.getPort());
+ if (clientProxy.userName() != null && clientProxy.password() != null) {
+ final CredentialsStore credsProvider = new BasicCredentialsProvider();
+ credsProvider.setCredentials(
+ new AuthScope(u.getHost(), u.getPort()),
+ new UsernamePasswordCredentials(clientProxy.userName(), clientProxy.password().toCharArray())
+ );
+ clientBuilder.setDefaultCredentialsProvider(credsProvider);
  }
- clientBuilder.setProxy(proxy);
- }
+ clientBuilder.setProxy(proxyHost);
+ });
 
  final Boolean preemptiveBasicAuthProperty = (Boolean) config.getProperties()
  .get(Apache5ClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION);
@@ -456,16 +450,6 @@ public CookieStore getCookieStore() {
  return cookieStore;
  }
 
- private static URI getProxyUri(final Object proxy) {
- if (proxy instanceof URI) {
- return (URI) proxy;
- } else if (proxy instanceof String) {
- return URI.create((String) proxy);
- } else {
- throw new ProcessingException(LocalizationMessages.WRONG_PROXY_URI_TYPE(ClientProperties.PROXY_URI));
- }
- }
-
  @Override
  public ClientResponse apply(final ClientRequest clientRequest) throws ProcessingException {
  final HttpUriRequest request = getUriHttpRequest(clientRequest);

diff --git a/...nnector/src/main/resources/org/glassfish/jersey/apache5/connector/localization.properties b/...nnector/src/main/resources/org/glassfish/jersey/apache5/connector/localization.properties
@@ -19,7 +19,5 @@ error.reading.httpentity.stream=Error reading InputStream from HttpEntity: "{0}"
 failed.to.stop.client=Failed to stop the client.
 # {0} - property name, e.g. jersey.config.client.httpclient.connectionManager; {1}, {2} - full class name
 ignoring.value.of.property=Ignoring value of property "{0}" ("{1}") - not instance of "{2}".
-# {0} - property name - jersey.config.client.httpclient.proxyUri
-wrong.proxy.uri.type=The proxy URI ("{0}") property MUST be an instance of String or URI.
 invalid.configurable.component.type=The supplied component "{0}" is not assignable from JerseyClient or JerseyWebTarget.
 expected.connector.provider.not.used=The supplied component is not configured to use a ApacheConnectorProvider.
diff --git a/...zzly-connector/src/main/java/org/glassfish/jersey/grizzly/connector/GrizzlyConnector.java b/...zzly-connector/src/main/java/org/glassfish/jersey/grizzly/connector/GrizzlyConnector.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -22,6 +22,7 @@
 import java.net.URI;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Properties;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
@@ -39,6 +40,7 @@
 import org.glassfish.jersey.client.ClientRequest;
 import org.glassfish.jersey.client.ClientResponse;
 import org.glassfish.jersey.client.RequestEntityProcessing;
+import org.glassfish.jersey.client.innate.ClientProxy;
 import org.glassfish.jersey.client.spi.AsyncConnectorCallback;
 import org.glassfish.jersey.client.spi.Connector;
 import org.glassfish.jersey.internal.Version;
@@ -83,7 +85,7 @@ class GrizzlyConnector implements Connector {
  GrizzlyConnector(final Client client,
  final Configuration config,
  final GrizzlyConnectorProvider.AsyncClientCustomizer asyncClientCustomizer) {
- AsyncHttpClientConfig.Builder builder = new AsyncHttpClientConfig.Builder();
+ final AsyncHttpClientConfig.Builder builder = new AsyncHttpClientConfig.Builder();
 
  ExecutorService executorService;
  if (config != null) {
@@ -95,37 +97,31 @@ class GrizzlyConnector implements Connector {
  executorService = Executors.newCachedThreadPool();
  }
 
- builder = builder.setExecutorService(executorService);
+ builder.setExecutorService(executorService);
 
  builder.setConnectTimeout(ClientProperties.getValue(config.getProperties(),
  ClientProperties.CONNECT_TIMEOUT, 10000));
 
  builder.setRequestTimeout(ClientProperties.getValue(config.getProperties(),
  ClientProperties.READ_TIMEOUT, 10000));
 
- Object proxyUri;
- proxyUri = config.getProperty(ClientProperties.PROXY_URI);
- if (proxyUri != null) {
- final URI u = getProxyUri(proxyUri);
+ final Optional<ClientProxy> proxy = ClientProxy.proxyFromConfiguration(config);
+ proxy.ifPresent(clientProxy -> {
+ final URI u = clientProxy.uri();
  final Properties proxyProperties = new Properties();
  proxyProperties.setProperty(ProxyUtils.PROXY_PROTOCOL, u.getScheme());
  proxyProperties.setProperty(ProxyUtils.PROXY_HOST, u.getHost());
  proxyProperties.setProperty(ProxyUtils.PROXY_PORT, String.valueOf(u.getPort()));
 
- final String userName = ClientProperties.getValue(
- config.getProperties(), ClientProperties.PROXY_USERNAME, String.class);
- if (userName != null) {
- proxyProperties.setProperty(ProxyUtils.PROXY_USER, userName);
-
- final String password = ClientProperties.getValue(
- config.getProperties(), ClientProperties.PROXY_PASSWORD, String.class);
- if (password != null) {
- proxyProperties.setProperty(ProxyUtils.PROXY_PASSWORD, password);
+ if (clientProxy.userName() != null) {
+ proxyProperties.setProperty(ProxyUtils.PROXY_USER, clientProxy.userName());
+ if (clientProxy.password() != null) {
+ proxyProperties.setProperty(ProxyUtils.PROXY_PASSWORD, clientProxy.password());
  }
  }
  ProxyServerSelector proxyServerSelector = ProxyUtils.createProxyServerSelector(proxyProperties);
  builder.setProxyServerSelector(proxyServerSelector);
- }
+ });
  } else {
  executorService = Executors.newCachedThreadPool();
  builder.setExecutorService(executorService);
@@ -140,25 +136,14 @@ class GrizzlyConnector implements Connector {
  }
 
  if (asyncClientCustomizer != null) {
- builder = asyncClientCustomizer.customize(client, config, builder);
+ asyncClientCustomizer.customize(client, config, builder);
  }
 
  AsyncHttpClientConfig asyncClientConfig = builder.build();
 
  this.grizzlyClient = new AsyncHttpClient(new GrizzlyAsyncHttpProvider(asyncClientConfig), asyncClientConfig);
  }
 
- @SuppressWarnings("ChainOfInstanceofChecks")
- private static URI getProxyUri(final Object proxy) {
- if (proxy instanceof URI) {
- return (URI) proxy;
- } else if (proxy instanceof String) {
- return URI.create((String) proxy);
- } else {
- throw new ProcessingException(LocalizationMessages.WRONG_PROXY_URI_TYPE(ClientProperties.PROXY_URI));
- }
- }
-
  /**
  * Get the underlying Grizzly {@link com.ning.http.client.AsyncHttpClient} instance.
  *

diff --git a/...nnector/src/main/resources/org/glassfish/jersey/grizzly/connector/localization.properties b/...nnector/src/main/resources/org/glassfish/jersey/grizzly/connector/localization.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2018 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
 #
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License v. 2.0, which is available at
@@ -16,5 +16,4 @@
 
 error.buffering.entity=Error buffering the entity.
 expected.connector.provider.not.used=The supplied component is not configured to use a GrizzlyConnectorProvider.
-invalid.configurable.component.type=The supplied component "{0}" is not assignable from JerseyClient or JerseyWebTarget.
-wrong.proxy.uri.type=The proxy URI ("{0}") property MUST be an instance of String or URI.
+invalid.configurable.component.type=The supplied component "{0}" is not assignable from JerseyClient or JerseyWebTarget.
diff --git a/...rs/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyConnector.java b/...rs/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyConnector.java
@@ -31,10 +31,8 @@
 import java.util.Optional;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
-import java.util.concurrent.TimeoutException;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Level;
@@ -54,6 +52,7 @@
 import org.glassfish.jersey.client.ClientProperties;
 import org.glassfish.jersey.client.ClientRequest;
 import org.glassfish.jersey.client.ClientResponse;
+import org.glassfish.jersey.client.innate.ClientProxy;
 import org.glassfish.jersey.client.spi.AsyncConnectorCallback;
 import org.glassfish.jersey.client.spi.Connector;
 import org.glassfish.jersey.internal.util.collection.ByteBufferInputStream;
@@ -187,19 +186,17 @@ class JettyConnector implements Connector {
  auth.addAuthentication((BasicAuthentication) basicAuthProvider);
  }
 
- final Object proxyUri = config.getProperties().get(ClientProperties.PROXY_URI);
- if (proxyUri != null) {
- final URI u = getProxyUri(proxyUri);
+ final Optional<ClientProxy> proxy = ClientProxy.proxyFromConfiguration(config);
+ proxy.ifPresent(clientProxy -> {
  final ProxyConfiguration proxyConfig = client.getProxyConfiguration();
+ final URI u = clientProxy.uri();
  proxyConfig.getProxies().add(new HttpProxy(u.getHost(), u.getPort()));
 
- final Object proxyUsername = config.getProperties().get(ClientProperties.PROXY_USERNAME);
- if (proxyUsername != null) {
- final Object proxyPassword = config.getProperties().get(ClientProperties.PROXY_PASSWORD);
+ if (clientProxy.userName() != null) {
  auth.addAuthentication(new BasicAuthentication(u, "<<ANY_REALM>>",
- String.valueOf(proxyUsername), String.valueOf(proxyPassword)));
+ clientProxy.userName(), clientProxy.password()));
  }
- }
+ });
 
  if (disableCookies) {
  client.setCookieStore(new HttpCookieStore.Empty());
@@ -223,17 +220,6 @@ class JettyConnector implements Connector {
  this.cookieStore = client.getCookieStore();
  }
 
- @SuppressWarnings("ChainOfInstanceofChecks")
- private static URI getProxyUri(final Object proxy) {
- if (proxy instanceof URI) {
- return (URI) proxy;
- } else if (proxy instanceof String) {
- return URI.create((String) proxy);
- } else {
- throw new ProcessingException(LocalizationMessages.WRONG_PROXY_URI_TYPE(ClientProperties.PROXY_URI));
- }
- }
-
  /**
  * Get the {@link HttpClient}.
  *

diff --git a/...connector/src/main/resources/org/glassfish/jersey/jetty/connector/localization.properties b/...connector/src/main/resources/org/glassfish/jersey/jetty/connector/localization.properties
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013, 2018 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
 #
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License v. 2.0, which is available at
@@ -16,7 +16,5 @@
 
 # {0} - HTTP method, e.g. GET, DELETE
 method.not.supported=Method {0} not supported.
-# {0} - property name - jersey.config.client.proxyUri
-wrong.proxy.uri.type=The proxy URI ("{0}") property MUST be an instance of String or URI.
 invalid.configurable.component.type=The supplied component "{0}" is not assignable from JerseyClient or JerseyWebTarget.
 expected.connector.provider.not.used=The supplied component is not configured to use a JettyConnectorProvider.