[java-shib-shared] branch main updated: Javadoc fixes.

[Brent Putman]

This is an automated email from the git hooks/post-receive script.

putmanb pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-shared.git;a=commit;h=7dc58af94b4ae21320c16d45ef86cebdc06c46a0

The following commit(s) were added to refs/heads/main by this push:
     new 7dc58af9 Javadoc fixes.
7dc58af9 is described below

commit 7dc58af94b4ae21320c16d45ef86cebdc06c46a0
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Tue Feb 21 22:54:33 2023 -0500

    Javadoc fixes.
---
 .../shared/spring/httpclient/resource/HTTPResource.java           | 2 +-
 .../java/net/shibboleth/shared/httpclient/HttpClientBuilder.java  | 8 +++++---
 .../java/net/shibboleth/shared/httpclient/TLSSocketFactory.java   | 2 +-
 .../utilities/java/support/httpclient/HttpClientSupport.java      | 2 +-
 4 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java b/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java
index 7f99c1a5..4599b471 100644
--- a/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java
+++ b/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java
@@ -106,7 +106,7 @@ public class HTTPResource extends AbstractIdentifiedInitializableComponent imple
     }
     
     /**
-     * Set a handler to manipulate the {@link HttpClientContext}.
+     * Set a handler to manipulate the {@link org.apache.hc.client5.http.protocol.HttpClientContext}.
      * 
      * @param handler the handler to install
      * 
diff --git a/shib-networking/src/main/java/net/shibboleth/shared/httpclient/HttpClientBuilder.java b/shib-networking/src/main/java/net/shibboleth/shared/httpclient/HttpClientBuilder.java
index 255a6c61..bc5d827d 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/httpclient/HttpClientBuilder.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/httpclient/HttpClientBuilder.java
@@ -67,6 +67,7 @@ import net.shibboleth.shared.primitive.StringSupport;
  * <p>
  * When using the single-arg constructor variant to wrap an existing instance of
  * {@link org.apache.hc.client5.http.impl.classic.HttpClientBuilder}, there are several caveats of which to be aware:
+ * </p>
  * 
  * <p>
  * Instances of the following will be unconditionally overwritten by this builder when
@@ -74,12 +75,13 @@ import net.shibboleth.shared.primitive.StringSupport;
  * </p>
  * 
  * <ul>
- * <li>{@link HttpClientConnectionManager} which includes the following sub-components:</li>
+ * <li>{@link HttpClientConnectionManager} which includes the following sub-components:
  *   <ul>
  *     <li>Default {@link ConnectionConfig}</li>
  *     <li>{@link HttpConnectionFactory}</li>
  *     <li>{@link LayeredConnectionSocketFactory} used as the <code>SSLSocketFactory</code></li>
  *   </ul>
+ * </li>
  * <li>{@link HttpRoutePlanner}</li>
  * <li>Default {@link RequestConfig}</li>
  * <li>Default {@link CredentialsProvider}</li>
@@ -380,7 +382,7 @@ public class HttpClientBuilder {
     /**
      * Gets the timeout until arrival of a response from the opposite endpoint.
      * 
-     * @return timeout
+     * @return the response timeout
      */
     @Nonnull public Duration getResponseTimeout() {
         return responseTimeout;
@@ -389,7 +391,7 @@ public class HttpClientBuilder {
     /**
      * Gets the timeout until arrival of a response from the opposite endpoint.
      * 
-     * @param timeout 
+     * @param timeout the response timeout
      */
     public void setResponseTimeout(@Nonnull final Duration timeout) {
         Constraint.isNotNull(timeout, "Timeout cannot be null");
diff --git a/shib-networking/src/main/java/net/shibboleth/shared/httpclient/TLSSocketFactory.java b/shib-networking/src/main/java/net/shibboleth/shared/httpclient/TLSSocketFactory.java
index 396d9deb..f1f3871e 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/httpclient/TLSSocketFactory.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/httpclient/TLSSocketFactory.java
@@ -60,7 +60,7 @@ import org.slf4j.Logger;
  *
  * <ul>
  *   <li>Factory hostname verifier defaults to {@link DefaultHostnameVerifier} without a
- *   configured {@link PublicSuffixMatcher}.</li>
+ *   configured {@link org.apache.hc.client5.http.psl.PublicSuffixMatcher}.</li>
  *   <li>Per-request specification of enabled TLS protocols and cipher suites via {@link HttpContext} attributes.</li>
  *   <li>Per-request specification of hostname verifier via {@link HttpContext} attribute.</li>
  * </ul>
diff --git a/shib-networking/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java b/shib-networking/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java
index d656123d..13082047 100644
--- a/shib-networking/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java
+++ b/shib-networking/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientSupport.java
@@ -37,7 +37,7 @@ import net.shibboleth.shared.primitive.DeprecationSupport;
 import net.shibboleth.shared.primitive.DeprecationSupport.ObjectType;
 
 /**
- * Old support class for using {@link HttpClient} and related components.
+ * Old support class for using {@link org.apache.hc.client5.http.classic.HttpClient} and related components.
  * 
  * <p>Replaced by {@link net.shibboleth.shared.httpclient.HttpClientSupport}.</p>
  * 

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.