[java-oidfed-common] branch main updated: Javadoc fixes
Codeberg
noreply at shibboleth.net
Thu Sep 3 05:07:04 UTC 2026
This is an automated email from the git hooks/post-receive script.
codeberg pushed a commit to branch main
in repository java-oidfed-common.
View the commit online:
https://codeberg.org/Shibboleth/java-oidfed-common/commit/3bf6dadca926e1f834eaf7457f2a53c903d1466e
The following commit(s) were added to refs/heads/main by this push:
new 3bf6dad Javadoc fixes
3bf6dad is described below
commit 3bf6dadca926e1f834eaf7457f2a53c903d1466e
Author: Henri Mikkonen <henri.mikkonen at iki.fi>
AuthorDate: Thu Sep 3 08:06:50 2026 +0300
Javadoc fixes
---
...DefaultEntityStatementContentValidationCondition.java | 1 +
...DefaultPrivateKeyJwtClientAuthenticationFunction.java | 16 +++++++++++++---
.../BiConsumerEntityConfigurationMetadataDecorator.java | 4 ++--
.../oidfed/profile/impl/CallResolveEntityApi.java | 5 +++++
...entInformationFederationEntityCredentialResolver.java | 1 +
.../DefaultSubordinateStatementCredentialResolver.java | 7 +++++++
.../security/jwt/claims/impl/CritClaimsValidator.java | 3 +++
7 files changed, 32 insertions(+), 5 deletions(-)
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultEntityStatementContentValidationCondition.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultEntityStatementContentValidationCondition.java
index cb54724..e02d188 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultEntityStatementContentValidationCondition.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultEntityStatementContentValidationCondition.java
@@ -66,6 +66,7 @@ public class DefaultEntityStatementContentValidationCondition
/** Supplier for the Current HTTP request, if available. */
@NonnullAfterInit private NonnullSupplier<HttpServletRequest> httpServletRequestSupplier;
+ /** The validation strategy for the container identifier. */
@NonnullAfterInit
private BiPredicate<BaseExpirableStatementContainer<?>, BaseJWTWrapper<? extends BasePayload>>
containerIdValidationStrategy;
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultPrivateKeyJwtClientAuthenticationFunction.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultPrivateKeyJwtClientAuthenticationFunction.java
index 095846a..8f3e70c 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultPrivateKeyJwtClientAuthenticationFunction.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/metadata/cache/DefaultPrivateKeyJwtClientAuthenticationFunction.java
@@ -67,7 +67,7 @@ public class DefaultPrivateKeyJwtClientAuthenticationFunction extends AbstractId
@Nonnull private Logger protocolMessageLog =
LoggerFactory.getLogger(AbstractMessageEncoder.BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".OAUTH2");
- /** Strategy used to lookup the security configuration used for signing the JWT used in authentication */
+ /** Strategy used to lookup the security configuration used for signing the JWT used in authentication. */
@NonnullAfterInit private Function<CriteriaSet,JSONSecurityConfiguration> securityConfigurationLookupStrategy;
/** Strategy used to lookup the type header value for the JWT. */
@@ -76,7 +76,7 @@ public class DefaultPrivateKeyJwtClientAuthenticationFunction extends AbstractId
/** Strategy to find the audience value from the criteria set.*/
@NonnullAfterInit private Function<CriteriaSet,String> audienceLookupStrategy;
- /** Strategy to find the issuer/subject value from the criteria set.*/
+ /** Strategy to find the issuer/subject value from the criteria set. */
@NonnullAfterInit private Function<CriteriaSet,String> issuerLookupStrategy;
/** Strategy used to locate the {@link IdentifierGenerationStrategy} to use. */
@@ -85,12 +85,15 @@ public class DefaultPrivateKeyJwtClientAuthenticationFunction extends AbstractId
/** Resolver for signing parameters. */
@NonnullAfterInit private SignatureSigningParametersResolver resolver;
- /** The offset to add to the 'exp' claim time for JWT client authentication methods. Default is 30 seconds.*/
+ /** The offset to add to the 'exp' claim time for JWT client authentication methods. Default is 30 seconds. */
@Nonnull private Duration jwtBearerExpiryOffset;
/** Object mapper used for pretty-printing JWT contents. */
@NonnullAfterInit private ObjectMapper objectMapper;
+ /**
+ * Constructor.
+ */
public DefaultPrivateKeyJwtClientAuthenticationFunction() {
idGeneratorLookupStrategy = FunctionSupport.constant(new SecureRandomIdentifierGenerationStrategy());
final Duration thirtySecs = Duration.ofSeconds(30);
@@ -98,6 +101,11 @@ public class DefaultPrivateKeyJwtClientAuthenticationFunction extends AbstractId
jwtBearerExpiryOffset = thirtySecs;
}
+ /**
+ * Set the strategy used to lookup the security configuration used for signing the JWT used in authentication.
+ *
+ * @param strategy What to set
+ */
public void setSecurityConfigurationLookupStrategy(
@Nonnull final Function<CriteriaSet,JSONSecurityConfiguration> strategy) {
checkSetterPreconditions();
@@ -277,6 +285,8 @@ public class DefaultPrivateKeyJwtClientAuthenticationFunction extends AbstractId
/**
* Construct a {@link SignedJWT} with the given input claims and signing parameters.
+ *
+ * @param jti The JWT identifier
* @param issuer The issuer for the JWT
* @param audience The audience for the JWT
* @param signingParameters The signing parameters
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/BiConsumerEntityConfigurationMetadataDecorator.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/BiConsumerEntityConfigurationMetadataDecorator.java
index fa94e3e..1b8498a 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/BiConsumerEntityConfigurationMetadataDecorator.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/BiConsumerEntityConfigurationMetadataDecorator.java
@@ -31,10 +31,10 @@ import net.shibboleth.shared.logic.Constraint;
/**
* A {@link EntityConfigurationMetadataDecorator} which calls out to a supplied bi-consumer.
*/
-public class BiConsumerEntityConfigurationMetadataDecorator
- extends AbstractIdentifiableInitializableComponent
+public class BiConsumerEntityConfigurationMetadataDecorator extends AbstractIdentifiableInitializableComponent
implements EntityConfigurationMetadataDecorator {
+ /** The bi-consumer used as the metadata decorator. */
@NonnullAfterInit private BiConsumer<Map<String,Map<String,Object>>, ProfileRequestContext> biConsumer;
/**
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/CallResolveEntityApi.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/CallResolveEntityApi.java
index a710cb2..86d3663 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/CallResolveEntityApi.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/profile/impl/CallResolveEntityApi.java
@@ -174,6 +174,11 @@ public class CallResolveEntityApi extends AbstractProfileAction {
entityConfigurationCache = Constraint.isNotNull(cache, "Entity Configuration cache cannot be null");
}
+ /**
+ * Set the cache containing responses from resolve entity APIs.
+ *
+ * @param cache cache containing responses from resolve entity APIs
+ */
public void setResolveEntityTrustChainMetadataCache(
@Nonnull final MetadataCache<ResolveEntityResponseContainer> cache) {
checkSetterPreconditions();
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/ClientInformationFederationEntityCredentialResolver.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/ClientInformationFederationEntityCredentialResolver.java
index 0c1fcdc..d205eb4 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/ClientInformationFederationEntityCredentialResolver.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/ClientInformationFederationEntityCredentialResolver.java
@@ -96,6 +96,7 @@ public class ClientInformationFederationEntityCredentialResolver extends BasicJO
* @param information the RP/Client information
*
* @return a collection of credentials from the entity configuration key set (if any).
+ * @throws ResolverException if resolution fails
*/
@Nonnull protected Iterable<Credential> resolveFromMetadata(@Nonnull final CriteriaSet criteriaSet,
@Nonnull final OIDCClientInformation information) throws ResolverException {
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/DefaultSubordinateStatementCredentialResolver.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/DefaultSubordinateStatementCredentialResolver.java
index bb1ee2c..dc6cc22 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/DefaultSubordinateStatementCredentialResolver.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/credential/DefaultSubordinateStatementCredentialResolver.java
@@ -104,6 +104,13 @@ public class DefaultSubordinateStatementCredentialResolver extends BasicJOSEObje
return jwks;
}
+ /**
+ * Resolves subject statement payload primarily from {@link SubjectEntityStatementCriterion}, using
+ * {@link SubjectStatementCriterion} as backup if it was not included in the given criteria set.
+ *
+ * @param criteriaSet criteria set
+ * @return the subject statement payload
+ */
private BaseExpirableSubjectPayload getSubjectStatementPayload(
@Nonnull final CriteriaSet criteriaSet) {
final SubjectEntityStatementCriterion entityStatementCriterion =
diff --git a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/jwt/claims/impl/CritClaimsValidator.java b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/jwt/claims/impl/CritClaimsValidator.java
index a7b84e7..b93a067 100644
--- a/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/jwt/claims/impl/CritClaimsValidator.java
+++ b/oidfed-common-impl/src/main/java/net/shibboleth/oidfed/security/jwt/claims/impl/CritClaimsValidator.java
@@ -49,6 +49,9 @@ public class CritClaimsValidator extends AbstractClaimsValidator {
/** The collection of recognized claims. */
@Nonnull private Collection<String> recognizedClaims;
+ /**
+ * Constructor.
+ */
public CritClaimsValidator() {
recognizedClaims = CollectionSupport.emptyList();
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list