[java-oidc-common] branch main updated: Add missing since tags
Phil Smart
philip.smart at jisc.ac.uk
Thu Mar 7 11:22:24 UTC 2024
This is an automated email from the git hooks/post-receive script.
philsmart pushed a commit to branch main
in repository java-oidc-common.
View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=94e5316614def80490408c3a9f57ad3b862a62eb
The following commit(s) were added to refs/heads/main by this push:
new 94e5316 Add missing since tags
94e5316 is described below
commit 94e5316614def80490408c3a9f57ad3b862a62eb
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Thu Mar 7 11:22:21 2024 +0000
Add missing since tags
- Review changes since 3.0.1 and add since tags where appropriate
---
.../oidc/security/credential/BasicNimbusSecretCredential.java | 2 +-
.../java/net/shibboleth/oidc/security/jose/SignatureException.java | 2 ++
.../impl/AbstractClientInformationCredentialResolver.java | 2 ++
.../impl/ClientInformationClientSecretCredentialResolver.java | 2 ++
.../main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java | 2 +-
.../main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java | 3 ++-
.../oidc/metadata/cache/impl/DefaultResourceLoadingStrategy.java | 6 +++++-
.../metadata/cache/impl/MetadataPolicyLookupStrategyFactory.java | 2 ++
.../oidc/metadata/policy/impl/BeanMetadataPolicyOperator.java | 2 ++
.../oidc/metadata/policy/impl/CustomMetadataPolicyOperator.java | 2 ++
.../shibboleth/oidc/profile/config/JSONSecurityConfiguration.java | 4 ++++
.../main/java/net/shibboleth/oidc/profile/core/OidcEventIds.java | 6 ++++++
12 files changed, 31 insertions(+), 4 deletions(-)
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java
index ca5bdbe..8eb041d 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java
@@ -31,7 +31,7 @@ import net.shibboleth.shared.primitive.DeprecationSupport.ObjectType;
*
* @deprecated use {@link ClientSecretCredential}
*/
-// TODO If we can not remove usage of this class easily, make immutable (remove default constructor and setter).
+// TODO If we cannot remove usage of this class easily, make immutable (remove default constructor and setter).
@Deprecated(since = "2.2.0", forRemoval=true)
public class BasicNimbusSecretCredential extends AbstractCredential implements NimbusSecretCredential {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureException.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureException.java
index 0ddaa6c..2a17c72 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureException.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureException.java
@@ -21,6 +21,8 @@ import javax.annotation.Nullable;
/**
* Exception thrown when an error occurs during JWS signature operations.
+ *
+ * @since 3.1.0
*/
public class SignatureException extends Exception {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/AbstractClientInformationCredentialResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/AbstractClientInformationCredentialResolver.java
index 2b484ff..2fa1138 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/AbstractClientInformationCredentialResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/AbstractClientInformationCredentialResolver.java
@@ -37,6 +37,8 @@ import net.shibboleth.shared.resolver.ResolverException;
/**
* Base class for resolving credentials from {@link OIDCClientInformation}.
+ *
+ * @since 3.1.0
*/
public abstract class AbstractClientInformationCredentialResolver extends BasicJOSEObjectCredentialResolver
implements InitializableComponent {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientInformationClientSecretCredentialResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientInformationClientSecretCredentialResolver.java
index 0b993b7..7cb7472 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientInformationClientSecretCredentialResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientInformationClientSecretCredentialResolver.java
@@ -31,6 +31,8 @@ import net.shibboleth.shared.resolver.ResolverException;
* A {@link JOSEObjectCredentialResolver} that resolves client secret from of a ClientInformation. If the information
* contains client secret, it's converted into a {@link ClientSecretCredential}. Further filtering of credentials is
* provided by the {@link AbstractCriteriaFilteringCredentialResolver} parent class.
+ *
+ * @since 3.1.0
*/
public class ClientInformationClientSecretCredentialResolver extends AbstractClientInformationCredentialResolver {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java
index b217fec..cc25c42 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java
@@ -59,7 +59,7 @@ public class SignJWTHandler extends AbstractMessageHandler {
/** Strategy used to locate the payload to encrypt.*/
@NonnullAfterInit private Function<MessageContext, JWTClaimsSet> claimsToSignLookupStrategy;
- /** The stasehd claims to sign.*/
+ /** The stashed claims to sign.*/
@NonnullBeforeExec private JWTClaimsSet jwtClaimSetToSign;
/** Optional "typ" header to insert while signing. */
diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java
index a35f504..b732a61 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java
@@ -24,7 +24,8 @@ import net.shibboleth.shared.annotation.constraint.NonnullElements;
import net.shibboleth.shared.annotation.constraint.NotLive;
import net.shibboleth.shared.annotation.constraint.Unmodifiable;
-/** A dynamic version of a {@link BackingStore}.
+/**
+ * A dynamic version of a {@link BackingStore}.
*
* @param <I> the identifier type
* @param <T> the type of object stored, referenced by the key.
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultResourceLoadingStrategy.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultResourceLoadingStrategy.java
index 231cfde..589f50c 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultResourceLoadingStrategy.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultResourceLoadingStrategy.java
@@ -30,7 +30,11 @@ import net.shibboleth.oidc.metadata.cache.LoadingStrategy;
import net.shibboleth.shared.annotation.constraint.NotEmpty;
import net.shibboleth.shared.primitive.LoggerFactory;
-/** Default strategy for loading information from a resource.*/
+/**
+ * Default strategy for loading information from a resource.
+ *
+ * @since 3.1.0
+ */
@ThreadSafe
public class DefaultResourceLoadingStrategy implements LoadingStrategy {
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/MetadataPolicyLookupStrategyFactory.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/MetadataPolicyLookupStrategyFactory.java
index 667caed..a7f6b98 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/MetadataPolicyLookupStrategyFactory.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/MetadataPolicyLookupStrategyFactory.java
@@ -94,6 +94,8 @@ public class MetadataPolicyLookupStrategyFactory {
*
* @throws ComponentInitializationException on error.
* @throws IOException on error.
+ *
+ * @since 3.1.0
*/
@Nonnull
public Function<ProfileRequestContext,Map<String,MetadataPolicy>> buildResourceLoadingMetadataPolicyResolver(
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/BeanMetadataPolicyOperator.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/BeanMetadataPolicyOperator.java
index 1d50205..539ce7e 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/BeanMetadataPolicyOperator.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/BeanMetadataPolicyOperator.java
@@ -28,6 +28,8 @@ import net.shibboleth.shared.logic.ConstraintViolationException;
/**
* A custom metadata policy operator that fetches a bean from {@link ApplicationContext} and uses it for as
* {@link CustomMetadataPolicyOperator}.
+ *
+ * @since 3.1.0
*/
public class BeanMetadataPolicyOperator implements CustomMetadataPolicyOperator, ApplicationContextAware {
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/CustomMetadataPolicyOperator.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/CustomMetadataPolicyOperator.java
index 40a873e..d2c78cb 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/CustomMetadataPolicyOperator.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/policy/impl/CustomMetadataPolicyOperator.java
@@ -22,6 +22,8 @@ import net.shibboleth.shared.logic.ConstraintViolationException;
/**
* Interface describing a custom policy operator to be used with {@link MetadataPolicy} objects.
+ *
+ * @since 3.1.0
*/
public interface CustomMetadataPolicyOperator {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java
index ec95e21..b409f43 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java
@@ -50,6 +50,8 @@ public class JSONSecurityConfiguration extends BasicSecurityConfiguration {
/**
* Constructor.
+ *
+ * @since 3.1.0
*/
public JSONSecurityConfiguration() {
super();
@@ -60,6 +62,8 @@ public class JSONSecurityConfiguration extends BasicSecurityConfiguration {
*
* @param skew the clock skew, must be greater than 0
* @param generator the identifier generator, must not be null
+ *
+ * @since 3.1.0
*/
public JSONSecurityConfiguration(@Nonnull final Duration skew,
@Nonnull final IdentifierGenerationStrategy generator) {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OidcEventIds.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OidcEventIds.java
index d5ddba8..6f51093 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OidcEventIds.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OidcEventIds.java
@@ -81,6 +81,8 @@ public final class OidcEventIds {
/**
* The id_token hint is missing in request, even though it's mandatory.
+ *
+ * @since 3.1.0
*/
@Nonnull @NotEmpty public static final String MISSING_MANDATORY_ID_TOKEN_HINT = "MissingMandatoryIdTokenHint";
@@ -101,6 +103,8 @@ public final class OidcEventIds {
/**
* The id_token_hint is invalid.
+ *
+ * @since 3.1.0
*/
@Nonnull @NotEmpty public static final String INVALID_ID_TOKEN_HINT = "InvalidIdTokenHint";
@@ -138,6 +142,8 @@ public final class OidcEventIds {
/**
* ID of event returned upon an inability to locate any matching session for a LogoutRequest.
+ *
+ * @since 3.1.0
*/
@Nonnull @NotEmpty public static final String SESSION_NOT_FOUND = "SessionNotFound";
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list