[java-plugin-shibd-oidc] branch main updated: Fix javadoc
Codeberg
noreply at shibboleth.net
Thu Feb 19 20:03:01 UTC 2026
This is an automated email from the git hooks/post-receive script.
codeberg pushed a commit to branch main
in repository java-plugin-shibd-oidc.
View the commit online:
https://codeberg.org/Shibboleth/java-plugin-shibd-oidc/commit/a092144a4d33be1b2b6797a404facc0c156317a5
The following commit(s) were added to refs/heads/main by this push:
new a092144 Fix javadoc
a092144 is described below
commit a092144a4d33be1b2b6797a404facc0c156317a5
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Thu Feb 19 20:02:48 2026 +0000
Fix javadoc
---
.../sp/oidc/context/AuthnRequestStateDataContext.java | 2 +-
.../sp/oidc/profile/AuthenticationRequestStateData.java | 10 +++++-----
.../AbstractAgentAndRelyingPartyContextLookupFunction.java | 5 +++++
.../profile/impl/AbstractProviderMetadataLookupFunction.java | 2 ++
.../net/shibboleth/sp/oidc/profile/impl/ExtractOIDCClaims.java | 1 +
.../shibboleth/sp/oidc/profile/impl/ProcessEndUserClaims.java | 4 ++--
.../sp/oidc/profile/impl/ResponseModeLookupStrategy.java | 1 -
.../sp/oidc/profile/impl/ResponseTypeLookupStrategy.java | 1 -
.../shibboleth/sp/oidc/profile/impl/StateLookupStrategy.java | 6 +++---
9 files changed, 19 insertions(+), 13 deletions(-)
diff --git a/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/context/AuthnRequestStateDataContext.java b/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/context/AuthnRequestStateDataContext.java
index 9ed6356..65f7f48 100644
--- a/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/context/AuthnRequestStateDataContext.java
+++ b/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/context/AuthnRequestStateDataContext.java
@@ -31,7 +31,7 @@ public class AuthnRequestStateDataContext extends BaseContext {
/**
* Sets the authentication state recovered from the authentication request.
*
- * @param authnState The authnState to set.
+ * @param state The authnState to set.
*/
@Nonnull public AuthnRequestStateDataContext setAuthnState(@Nullable final AuthenticationRequestStateData state) {
authnState = state;
diff --git a/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/profile/AuthenticationRequestStateData.java b/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/profile/AuthenticationRequestStateData.java
index fea1898..5e11959 100644
--- a/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/profile/AuthenticationRequestStateData.java
+++ b/sp-oidc-api/src/main/java/net/shibboleth/sp/oidc/profile/AuthenticationRequestStateData.java
@@ -143,7 +143,7 @@ public class AuthenticationRequestStateData {
/**
* Set the expected issuer of the authentication response.
*
- * @param issuer the authentication authority to set
+ * @param authority the authentication authority to set
*
* @return the updated object
*/
@@ -165,12 +165,12 @@ public class AuthenticationRequestStateData {
/**
* Set the PKCE code verifier used to generate the code challenge in the authentication request.
*
- * @param pkceCodeVerifier the PKCE code verifier
+ * @param code the PKCE code verifier
*
* @return the updated object
*/
- @Nonnull public AuthenticationRequestStateData setPkceCodeVerifier(@Nullable final String pkceCodeVerifierIn) {
- pkceCodeVerifier = pkceCodeVerifierIn;
+ @Nonnull public AuthenticationRequestStateData setPkceCodeVerifier(@Nullable final String code) {
+ pkceCodeVerifier = code;
return this;
}
@@ -245,7 +245,7 @@ public class AuthenticationRequestStateData {
/**
* Set the acrs requested in the authentication request.
*
- * @param acrs The acrs to set.
+ * @param acrsIn The acrs to set.
*
* @return the updated object
*/
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractAgentAndRelyingPartyContextLookupFunction.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractAgentAndRelyingPartyContextLookupFunction.java
index 48177ab..a28f1f5 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractAgentAndRelyingPartyContextLookupFunction.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractAgentAndRelyingPartyContextLookupFunction.java
@@ -63,6 +63,7 @@ public abstract class AbstractAgentAndRelyingPartyContextLookupFunction<ResultTy
OUTPUT
}
+ /** Constructor.*/
protected AbstractAgentAndRelyingPartyContextLookupFunction() {
// By default msgCtx (up)-> ProfileRequestContext (down)-> AgentRequestContext
agentRequestContextLookupStrategy = new ChildContextLookup<>(AgentRequestContext.class)
@@ -107,6 +108,8 @@ public abstract class AbstractAgentAndRelyingPartyContextLookupFunction<ResultTy
/**
* Gets the {@link Application} for this request.
*
+ * @param input the message context
+ *
* @return the agent
*/
@Nullable protected Application getApplication(@Nullable final MessageContext input) {
@@ -120,6 +123,8 @@ public abstract class AbstractAgentAndRelyingPartyContextLookupFunction<ResultTy
/**
* Gets the {@link DDF} for this request, either the input from the agent or the output for the agent.
*
+ * @param direction either an input DDF, or output
+ *
* @return the input or output DDF
*/
@Nullable protected DDF getDDF(@Nullable final MessageContext input, @Nonnull final DDFDirection direction) {
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractProviderMetadataLookupFunction.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractProviderMetadataLookupFunction.java
index 44e0997..a65b734 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractProviderMetadataLookupFunction.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/AbstractProviderMetadataLookupFunction.java
@@ -59,6 +59,8 @@ public abstract class AbstractProviderMetadataLookupFunction<F extends BaseConte
/**
* Gets the {@link OIDCProviderMetadata} for this request.
*
+ * @param input the message context
+ *
* @return the provider's metadata
*/
@Nullable public OIDCProviderMetadata getProviderMetadata(@Nullable final MessageContext input) {
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ExtractOIDCClaims.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ExtractOIDCClaims.java
index 3303346..3383b9c 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ExtractOIDCClaims.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ExtractOIDCClaims.java
@@ -110,6 +110,7 @@ public class ExtractOIDCClaims extends AbstractApplicationAction {
/** Whether to accept decoded attributes that no filter rules applied to. */
private boolean acceptUnfilteredAttributes;
+ /** Constructor.*/
public ExtractOIDCClaims() {
relyingPartyContextLookupStrategy = new ChildContextLookup<>(RelyingPartyContext.class);
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ProcessEndUserClaims.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ProcessEndUserClaims.java
index b616588..6d84329 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ProcessEndUserClaims.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ProcessEndUserClaims.java
@@ -151,8 +151,8 @@ public class ProcessEndUserClaims extends AbstractProfileAction {
/**
* Set whether to enable claim sanitization. If true, whatever claimSanatizationStrategy
* is set is used. If false, a no-op strategy is created which just returns a new claims set
- * based on the same claims that exist in the input claims set. By default, claims sanitization
- * uses the {@link DefaultClaimSanitizationStrategy}.
+ * based on the same claims that exist in the input claims set. By default, the input set of claims are added
+ * to the result set.
*
* @param enable enable or disable claims sanitization
*/
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseModeLookupStrategy.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseModeLookupStrategy.java
index 44e67e4..2cb37a7 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseModeLookupStrategy.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseModeLookupStrategy.java
@@ -28,7 +28,6 @@ import net.shibboleth.oidc.profile.config.OIDCAuthenticationRelyingPartyProfileC
* is configured in the relying party profile, it is parsed into a known
* {@link ResponseMode} value. If no configuration is available or the configured
* value does not map to a supported response mode, the lookup returns {@code null}.
- * </p>
*/
public class ResponseModeLookupStrategy extends AbstractAgentAndRelyingPartyContextLookupFunction<ResponseMode> {
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseTypeLookupStrategy.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseTypeLookupStrategy.java
index 553a071..96a54a6 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseTypeLookupStrategy.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/ResponseTypeLookupStrategy.java
@@ -31,7 +31,6 @@ import net.shibboleth.oidc.profile.config.OIDCAuthenticationRelyingPartyProfileC
* is configured in the relying party profile, it is parsed into a known
* {@link ResponseType} value. If no configuration is available or the configured
* value does not map to a supported response type, the lookup returns {@code null}.
- * </p>
*/
public class ResponseTypeLookupStrategy extends AbstractAgentAndRelyingPartyContextLookupFunction<ResponseType>{
diff --git a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/StateLookupStrategy.java b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/StateLookupStrategy.java
index f4b42e2..34f2697 100644
--- a/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/StateLookupStrategy.java
+++ b/sp-oidc-impl/src/main/java/net/shibboleth/sp/oidc/profile/impl/StateLookupStrategy.java
@@ -35,13 +35,13 @@ import net.shibboleth.sp.profile.SPConstants;
* A strategy function that constructs a Base64URL encoded JSON object containing a state value from the input
* {@link DDF} and a cryptographically secure nonce for CSRF protection.
*
- * <p>The JSON Object includes the following:
+ * <p>The JSON Object includes the following:</p>
* <ul>
* <li><b>state</b>: The value of {@code SPConstants.STATE} from the input DDF.</li>
* <li><b>nonce</b>: A securely generated random string (32 characters).</li>
* </ul>
- *
- * <p>
+ *
+ *
*/
public class StateLookupStrategy extends AbstractAgentAndRelyingPartyContextLookupFunction<StateToken> {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list