[java-plugin-shibd] branch main updated: Javadoc cleanup.

[Codeberg]

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

codeberg pushed a commit to branch main
in repository java-plugin-shibd.

View the commit online:
https://codeberg.org/Shibboleth/java-plugin-shibd/commit/2a5c8741e21d6d4977c3e3a59d414bda2355988f

The following commit(s) were added to refs/heads/main by this push:
     new 2a5c874  Javadoc cleanup.
2a5c874 is described below

commit 2a5c8741e21d6d4977c3e3a59d414bda2355988f
Author: Scott Cantor <scott at restingparrotsoftware.com>
AuthorDate: Mon Aug 3 08:54:28 2026 -0400

    Javadoc cleanup.
---
 sp-server-api/src/main/java/net/shibboleth/sp/Application.java     | 2 ++
 .../sp/credential/AbstractOrderedCredentialResolver.java           | 4 ++--
 sp-server-api/src/main/java/net/shibboleth/sp/state/StateData.java | 7 +++++++
 .../src/main/java/net/shibboleth/sp/impl/BasicApplication.java     | 4 ++--
 .../net/shibboleth/sp/profile/impl/PrepareAgentErrorResponse.java  | 1 +
 5 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/sp-server-api/src/main/java/net/shibboleth/sp/Application.java b/sp-server-api/src/main/java/net/shibboleth/sp/Application.java
index d5c05a3..7fd0233 100644
--- a/sp-server-api/src/main/java/net/shibboleth/sp/Application.java
+++ b/sp-server-api/src/main/java/net/shibboleth/sp/Application.java
@@ -146,6 +146,8 @@ public interface Application extends RelyingPartyConfiguration, RelyingPartyConf
     /**
      * Gets the {@link ProtocolSupportService} subtype for a particular protocol.
      * 
+     * @param <T> the type of service
+     * 
      * @param protocol protocol to fetch
      * @param claz type to fetch
      * 
diff --git a/sp-server-api/src/main/java/net/shibboleth/sp/credential/AbstractOrderedCredentialResolver.java b/sp-server-api/src/main/java/net/shibboleth/sp/credential/AbstractOrderedCredentialResolver.java
index 249daad..0f6ba08 100644
--- a/sp-server-api/src/main/java/net/shibboleth/sp/credential/AbstractOrderedCredentialResolver.java
+++ b/sp-server-api/src/main/java/net/shibboleth/sp/credential/AbstractOrderedCredentialResolver.java
@@ -89,7 +89,7 @@ public abstract class AbstractOrderedCredentialResolver extends AbstractIdentifi
      * 
      * <p>Defaults to true.</p>
      * 
-     * @param flag
+     * @param flag flag to set
      */
     public void setFilterByUsage(final boolean flag) {
         checkSetterPreconditions();
@@ -101,7 +101,7 @@ public abstract class AbstractOrderedCredentialResolver extends AbstractIdentifi
      * 
      * <p>If set, any {@link ProtocolCriterion} will be enforced apriori before returning any credentials.</p>
      * 
-     * @param protocols
+     * @param protocols the protocols supported
      */
     public void setProtocols(@Nullable final Collection<String> protocols) {
         checkSetterPreconditions();
diff --git a/sp-server-api/src/main/java/net/shibboleth/sp/state/StateData.java b/sp-server-api/src/main/java/net/shibboleth/sp/state/StateData.java
index 320f5f8..ae37c3a 100644
--- a/sp-server-api/src/main/java/net/shibboleth/sp/state/StateData.java
+++ b/sp-server-api/src/main/java/net/shibboleth/sp/state/StateData.java
@@ -377,6 +377,13 @@ public class StateData {
         return sb.toString();
     }
     
+    /**
+     * Decode URL-encoded data using ISO-8859-1 to guarantee a single byte encoding.
+     * 
+     * @param s input string
+     * 
+     * @return ISO-8859-1 byte string
+     */
     @SuppressWarnings("null")
     @Nonnull protected static byte[] decode(@Nonnull final String s) {
         // Values are processed as ISO-8859-1.
diff --git a/sp-server-impl/src/main/java/net/shibboleth/sp/impl/BasicApplication.java b/sp-server-impl/src/main/java/net/shibboleth/sp/impl/BasicApplication.java
index 8ffa7d2..7bb58dd 100644
--- a/sp-server-impl/src/main/java/net/shibboleth/sp/impl/BasicApplication.java
+++ b/sp-server-impl/src/main/java/net/shibboleth/sp/impl/BasicApplication.java
@@ -608,10 +608,10 @@ public class BasicApplication extends BasicRelyingPartyConfiguration implements
      * Sets a {@link CredentialResolver} to use for resolving keys and certificates "indirectly"
      * in support of the deprecated older methods.
      * 
-     * <o>This method should not be relied on "publically", and is solely used internally for
+     * <p>This method should not be relied on "publically", and is solely used internally for
      * backward compatibility.</p>
      * 
-     * @param resolver
+     * @param resolver credential resolver
      * 
      * @deprecated
      */
diff --git a/sp-server-impl/src/main/java/net/shibboleth/sp/profile/impl/PrepareAgentErrorResponse.java b/sp-server-impl/src/main/java/net/shibboleth/sp/profile/impl/PrepareAgentErrorResponse.java
index c98d58a..19d1fac 100644
--- a/sp-server-impl/src/main/java/net/shibboleth/sp/profile/impl/PrepareAgentErrorResponse.java
+++ b/sp-server-impl/src/main/java/net/shibboleth/sp/profile/impl/PrepareAgentErrorResponse.java
@@ -59,6 +59,7 @@ public class PrepareAgentErrorResponse extends AbstractAgentRequestAction {
     /** Strategy used to create the {@link StateDataContext} to populate. */
     @Nonnull private Function<ProfileRequestContext,StateDataContext> stateDataContextLookupStrategy;
     
+    /** Cached output object. */
     @NonnullBeforeExec private DDF output;
     
     /** Constructor. */

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