[java-opensaml] branch main updated: Javadoc fixes.
Brent Putman
putmanb at georgetown.edu
Wed Feb 22 04:40:51 UTC 2023
This is an automated email from the git hooks/post-receive script.
putmanb pushed a commit to branch main
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=abdca92b49e76ad1bd87b82d426660dfba83608b
The following commit(s) were added to refs/heads/main by this push:
new abdca92b4 Javadoc fixes.
abdca92b4 is described below
commit abdca92b49e76ad1bd87b82d426660dfba83608b
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Tue Feb 21 23:22:53 2023 -0500
Javadoc fixes.
---
.../httpclient/BaseHttpClientResponseXMLMessageDecoder.java | 3 ++-
.../decoder/httpclient/HttpClientResponseMessageDecoder.java | 3 ++-
.../encoder/httpclient/HttpClientRequestMessageEncoder.java | 2 +-
.../saml/common/binding/impl/SAMLMetadataLookupHandler.java | 2 +-
.../impl/CheckAndRecordServerTLSEntityAuthenticationtHandler.java | 4 ++--
.../resolver/impl/AbstractDynamicHTTPMetadataResolver.java | 4 ++--
.../saml/saml2/assertion/impl/AssertionValidationSupport.java | 1 +
.../httpclient/impl/SecurityEnhancedHttpClientSupport.java | 3 ++-
.../httpclient/impl/SecurityEnhancedTLSSocketFactory.java | 2 +-
.../security/x509/tls/impl/ThreadLocalX509TrustEngineContext.java | 8 ++++++++
.../soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java | 2 +-
.../soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java | 4 ++--
.../java/org/opensaml/spring/tls/TLSSocketFactoryFactoryBean.java | 3 ++-
13 files changed, 27 insertions(+), 14 deletions(-)
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/BaseHttpClientResponseXMLMessageDecoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/BaseHttpClientResponseXMLMessageDecoder.java
index 36b2978b7..7bf6f7b3a 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/BaseHttpClientResponseXMLMessageDecoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/BaseHttpClientResponseXMLMessageDecoder.java
@@ -38,7 +38,8 @@ import org.slf4j.LoggerFactory;
import org.w3c.dom.Element;
/**
- * Base class for message decoders which decode XML messages from an {@link HttpResponse}.
+ * Base class for message decoders which decode XML messages from a
+ * {@link org.apache.hc.core5.http.ClassicHttpResponse}.
*/
public abstract class BaseHttpClientResponseXMLMessageDecoder extends AbstractHttpClientResponseMessageDecoder {
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/HttpClientResponseMessageDecoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/HttpClientResponseMessageDecoder.java
index 8f9455188..7f7291190 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/HttpClientResponseMessageDecoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/HttpClientResponseMessageDecoder.java
@@ -24,7 +24,8 @@ import org.opensaml.messaging.decoder.MessageDecoder;
/**
- * A specialization of {@link MessageDecoder} that operates on a source message data type of {@link HttpResponse}.
+ * A specialization of {@link MessageDecoder} that operates on a source message data type of
+ * {@link ClassicHttpResponse}.
*/
public interface HttpClientResponseMessageDecoder extends MessageDecoder {
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/HttpClientRequestMessageEncoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/HttpClientRequestMessageEncoder.java
index ba64ff655..35498920e 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/HttpClientRequestMessageEncoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/HttpClientRequestMessageEncoder.java
@@ -23,7 +23,7 @@ import org.apache.hc.core5.http.ClassicHttpRequest;
import org.opensaml.messaging.encoder.MessageEncoder;
/**
- * A specialization of {@link MessageEncoder} that operates on a sink message data type of {@link HttpRequest}.
+ * A specialization of {@link MessageEncoder} that operates on a sink message data type of {@link ClassicHttpRequest}.
*/
public interface HttpClientRequestMessageEncoder extends MessageEncoder {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/SAMLMetadataLookupHandler.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/SAMLMetadataLookupHandler.java
index f6e20a806..82b75c543 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/SAMLMetadataLookupHandler.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/SAMLMetadataLookupHandler.java
@@ -135,7 +135,7 @@ public class SAMLMetadataLookupHandler extends AbstractMessageHandler {
* <p>Defaults to parent lookup. If set and found, a {@link ProfileRequestContextCriterion} will be included
* in the attempt.</p>
*
- * @param strategy
+ * @param strategy the lookup strategy
*
* @since 5.0.0
*/
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/CheckAndRecordServerTLSEntityAuthenticationtHandler.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/CheckAndRecordServerTLSEntityAuthenticationtHandler.java
index 7d4868163..5600e50ce 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/CheckAndRecordServerTLSEntityAuthenticationtHandler.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/CheckAndRecordServerTLSEntityAuthenticationtHandler.java
@@ -37,8 +37,8 @@ import org.slf4j.LoggerFactory;
import net.shibboleth.shared.logic.Constraint;
/**
- * Handler implementation that checks and records the result of {@link HttpClient} server TLS authentication
- * as stored in the @link {@link HttpClientContext} resolved via strategy function.
+ * Handler implementation that checks and records the result of {@link org.apache.hc.client5.http.classic.HttpClient}
+ * server TLS authentication as stored in the @link {@link HttpClientContext} resolved via strategy function.
*
* <p>
* If server TLS was performed and successful,
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
index 1423c7a97..fe186abd2 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
@@ -71,7 +71,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
new String[] {"application/samlmetadata+xml", "application/xml", "text/xml"};
/** MDC attribute representing the current request URI. Will be available during the execution of the
- * configured {@link ResponseHandler}. */
+ * configured {@link HttpClientResponseHandler}. */
public static final String MDC_ATTRIB_CURRENT_REQUEST_URI =
AbstractDynamicHTTPMetadataResolver.class.getName() + ".currentRequestURI";
@@ -275,7 +275,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
}
/**
- * Build an appropriate instance of {@link HttpUriRequest} based on the input criteria set.
+ * Build an appropriate instance of {@link ClassicHttpRequest} based on the input criteria set.
*
* @param criteria the input criteria set
* @return the newly constructed request, or null if it can not be built from the supplied criteria
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AssertionValidationSupport.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AssertionValidationSupport.java
index dcdce3afb..8098310ea 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AssertionValidationSupport.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AssertionValidationSupport.java
@@ -39,6 +39,7 @@ public final class AssertionValidationSupport {
/** Logger. */
private static final Logger LOG = LoggerFactory.getLogger(AssertionValidationSupport.class);
+ /** Constructor. */
private AssertionValidationSupport() { }
/**
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java
index d44fe19fc..bc3a07260 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java
@@ -35,7 +35,8 @@ import net.shibboleth.shared.httpclient.TLSSocketFactoryBuilder;
import net.shibboleth.shared.resolver.CriteriaSet;
/**
- * Support class for working with security-enhanced components related to use of {@link HttpClient}.
+ * Support class for working with security-enhanced components related to use of
+ * {@link org.apache.hc.client5.http.classic.HttpClient}.
*/
public final class SecurityEnhancedHttpClientSupport {
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java
index 9e3fa3fbb..79a371696 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java
@@ -182,7 +182,7 @@ public class SecurityEnhancedTLSSocketFactory implements LayeredConnectionSocket
* </p>
*
* @param socket the current socket being evaluated
- * @throws IOException
+ * @throws IOException if the certificate chain was not trusted by the supplied TrustEngine
*/
protected void checkAndEvaluateServerTLS(@Nonnull final Socket socket) throws IOException {
if (!SSLSocket.class.isInstance(socket)) {
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/ThreadLocalX509TrustEngineContext.java b/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/ThreadLocalX509TrustEngineContext.java
index f94c67a09..708dd9c01 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/ThreadLocalX509TrustEngineContext.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/ThreadLocalX509TrustEngineContext.java
@@ -34,6 +34,7 @@ import net.shibboleth.shared.resolver.CriteriaSet;
*/
public final class ThreadLocalX509TrustEngineContext {
+ /** Unified class representing the data that will be managed by the thread local storage. */
private static final class Data {
/** Trust engine. */
@@ -48,6 +49,13 @@ public final class ThreadLocalX509TrustEngineContext {
/** Whether trust engine evaluation failure should be treated as fatal. Defaults to true. */
private Boolean failureFatal;
+ /**
+ * Constructor.
+ *
+ * @param engine the trust engine
+ * @param criteria the trust criteria
+ * @param fatal whether trust engine failure should be treated as fatal
+ */
private Data(@Nonnull final TrustEngine<? super X509Credential> engine, @Nonnull final CriteriaSet criteria,
@Nullable final Boolean fatal) {
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java
index 8d2988913..eb1a2bdcf 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java
@@ -41,7 +41,7 @@ import org.slf4j.LoggerFactory;
import net.shibboleth.shared.component.ComponentInitializationException;
/**
- * Basic SOAP 1.1 decoder for HTTP transport via an HttpClient's {@link HttpResponse}.
+ * Basic SOAP 1.1 decoder for HTTP transport via an HttpClient's {@link ClassicHttpResponse}.
*
* <p>
* This decoder takes a mandatory {@link MessageHandler} instance which is used to
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
index a41891900..85ae4d0fa 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
@@ -49,7 +49,7 @@ import org.slf4j.LoggerFactory;
import net.shibboleth.shared.xml.SerializeSupport;
/**
- * Basic SOAP 1.1 encoder for HTTP transport via an HttpClient's {@link HttpRequest}.
+ * Basic SOAP 1.1 encoder for HTTP transport via an HttpClient's {@link ClassicHttpRequest}.
*/
public class HttpClientRequestSOAP11Encoder extends BaseHttpClientRequestXMLMessageEncoder {
@@ -182,7 +182,7 @@ public class HttpClientRequestSOAP11Encoder extends BaseHttpClientRequestXMLMess
/**
* <p>
- * This implementation performs the following actions on the context's {@link HttpRequest}:
+ * This implementation performs the following actions on the context's {@link ClassicHttpRequest}:
* </p>
* <ol>
* <li>Sets the SOAPAction HTTP header the value returned by {@link #getSOAPAction()}, if
diff --git a/opensaml-spring/src/main/java/org/opensaml/spring/tls/TLSSocketFactoryFactoryBean.java b/opensaml-spring/src/main/java/org/opensaml/spring/tls/TLSSocketFactoryFactoryBean.java
index 611a02feb..dd63a9462 100644
--- a/opensaml-spring/src/main/java/org/opensaml/spring/tls/TLSSocketFactoryFactoryBean.java
+++ b/opensaml-spring/src/main/java/org/opensaml/spring/tls/TLSSocketFactoryFactoryBean.java
@@ -29,7 +29,8 @@ import org.springframework.beans.factory.config.AbstractFactoryBean;
import net.shibboleth.shared.httpclient.HttpClientSupport;
/**
- * A factory bean for producing instances of {@link LayeredConnectionSocketFactory} for use in {@link HttpClient}.
+ * A factory bean for producing instances of {@link LayeredConnectionSocketFactory} for use in
+ * {@link org.apache.hc.client5.http.classic.HttpClient}.
*/
public class TLSSocketFactoryFactoryBean extends AbstractFactoryBean<LayeredConnectionSocketFactory> {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list