[java-shib-shared] branch main updated: Javadoc (including one spurious change)

[Rod Widdowson]

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

rdw 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=6461ab87c0a87df4cdf2c14f7c551f7ed70f1b23

The following commit(s) were added to refs/heads/main by this push:
     new 6461ab87 Javadoc (including one spurious change)
6461ab87 is described below

commit 6461ab87c0a87df4cdf2c14f7c551f7ed70f1b23
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sat Nov 26 13:44:29 2022 +0000

    Javadoc (including one spurious change)
---
 .../shared/spring/servlet/impl/DelegatingServletProxy.java   | 12 +++++++++++-
 .../shibboleth/shared/security/DataSealerKeyStrategy.java    |  5 ++++-
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/servlet/impl/DelegatingServletProxy.java b/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/servlet/impl/DelegatingServletProxy.java
index ef8c664c..825f6d60 100644
--- a/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/servlet/impl/DelegatingServletProxy.java
+++ b/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/servlet/impl/DelegatingServletProxy.java
@@ -48,21 +48,31 @@ import org.springframework.web.filter.DelegatingFilterProxy;
  */
 public class DelegatingServletProxy extends GenericServlet {
 
+	/** For serialization. */
 	private static final long serialVersionUID = 5470308159110258401L;
 
+    /** The name of the ServletContext attribute which should be used to retrieve the
+     * {@link WebApplicationContext} from which to load the delegate {@link Servlet} bean.
+     */
     @Nullable @NotEmpty private String contextAttribute;
 
+	/** The application context from which the target filter will be retrieved. */
 	@Nullable private WebApplicationContext webApplicationContext;
 
+	/** The name of the target bean in the Spring application context. */
 	@Nullable @NotEmpty private String targetBeanName;
 
+	/** Whether to invoke the Servlet lifecycle methods on the target bean. */
 	private boolean targetFilterLifecycle;
 
+	/** The {@code HttpServlet} instance that this proxy will delegate to and
+     * manage the lifecycle for.
+     */
 	@Nullable private volatile Servlet delegate;
 
+	/** Object used to syncrhonize access where needed. */
 	@Nonnull private Object delegateMonitor;
 
-
 	/**
 	 * Constructor for traditional use in {@code web.xml}.
 	 */
diff --git a/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java b/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java
index 245d845d..137a443c 100644
--- a/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java
+++ b/shib-security/src/main/java/net/shibboleth/shared/security/DataSealerKeyStrategy.java
@@ -80,7 +80,10 @@ public interface DataSealerKeyStrategy {
      */
     record NamedKey(@Nonnull @NotEmpty String name, @Nonnull SecretKey key) {
 
-        /** Constructor. */
+        /** Constructor.
+         * @param name key name 
+         * @param key key value
+         */
         public NamedKey {
             Constraint.isTrue(name != null && name.length() > 0, "Name cannot be empty or null");
             Constraint.isNotNull(key, "Key cannot be null");

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