[java-oidc-common] branch main updated: Add missing since tags
Phil Smart
philip.smart at jisc.ac.uk
Wed Jan 11 16:24:41 UTC 2023
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=84d9d1ee20659c7857dac09af33f4fa2ac89d37a
The following commit(s) were added to refs/heads/main by this push:
new 84d9d1e Add missing since tags
84d9d1e is described below
commit 84d9d1ee20659c7857dac09af33f4fa2ac89d37a
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Wed Jan 11 16:24:39 2023 +0000
Add missing since tags
---
.../oidc/security/credential/BasicExpiringJWKCredential.java | 7 ++++++-
.../oidc/security/credential/ExpiringJWKCredential.java | 2 ++
.../oidc/security/credential/JOSEObjectCredentialResolver.java | 2 ++
.../oidc/security/criterion/ClientInformationCriterion.java | 2 ++
.../shibboleth/oidc/security/criterion/JOSEObjectCriterion.java | 9 +++++++--
.../net/shibboleth/oidc/security/criterion/JWKSetCriterion.java | 2 ++
.../security/criterion/JWTDecryptionConfigurationCriterion.java | 2 ++
.../security/criterion/JWTEncryptionConfigurationCriterion.java | 2 ++
.../criterion/JWTSignatureSigningConfigurationCriterion.java | 2 ++
.../criterion/JWTSignatureValidationConfigurationCriterion.java | 2 ++
.../net/shibboleth/oidc/security/criterion/KeyIdCriterion.java | 2 ++
.../oidc/security/criterion/ProviderMetadataCriterion.java | 4 +++-
.../oidc/security/criterion/StaticCredentialCriterion.java | 6 +++++-
.../oidc/security/jose/context/SecurityParametersContext.java | 2 ++
14 files changed, 41 insertions(+), 5 deletions(-)
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicExpiringJWKCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicExpiringJWKCredential.java
index f48ff54..37365b9 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicExpiringJWKCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicExpiringJWKCredential.java
@@ -24,7 +24,12 @@ import javax.annotation.Nullable;
import net.shibboleth.utilities.java.support.logic.Constraint;
-/** Basic implementation of an ExpiringJWKCredential.*/
+/**
+ * Basic implementation of an ExpiringJWKCredential.
+ *
+ * @since 2.2.0
+ *
+ */
public class BasicExpiringJWKCredential extends BasicJWKCredential implements ExpiringJWKCredential {
/**
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ExpiringJWKCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ExpiringJWKCredential.java
index 0fb75ea..df7a2ab 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ExpiringJWKCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ExpiringJWKCredential.java
@@ -24,6 +24,8 @@ import javax.annotation.Nullable;
/**
* A {@link JWKCredential credential} that expires at some duration in seconds after 1970-01-01T0:0:0Z.
* A value of 0 seconds represents a credential that does not expire.
+ *
+ * @since 2.2.0
*/
public interface ExpiringJWKCredential extends JWKCredential {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/JOSEObjectCredentialResolver.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/JOSEObjectCredentialResolver.java
index 2147d15..576cd19 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/JOSEObjectCredentialResolver.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/JOSEObjectCredentialResolver.java
@@ -29,6 +29,8 @@ import net.shibboleth.oidc.security.criterion.JOSEObjectCriterion;
*
* Implementations will typically require an instance of {@link JOSEObjectCriterion} within the
* criteria set which is supplied as input to the resolve methods.
+ *
+ * @since 2.2.0
*/
public interface JOSEObjectCredentialResolver extends CredentialResolver {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ClientInformationCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ClientInformationCriterion.java
index 197ad3b..602a6a8 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ClientInformationCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ClientInformationCriterion.java
@@ -26,6 +26,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* Client information criterion to make decisions based on client information.
+ *
+ * @since 2.2.0
*/
public class ClientInformationCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JOSEObjectCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JOSEObjectCriterion.java
index 75eb799..aca214c 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JOSEObjectCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JOSEObjectCriterion.java
@@ -19,13 +19,15 @@ package net.shibboleth.oidc.security.criterion;
import javax.annotation.Nullable;
-import net.shibboleth.utilities.java.support.resolver.Criterion;
-
import com.nimbusds.jose.JOSEObject;
+import net.shibboleth.utilities.java.support.resolver.Criterion;
+
/**
* An implementation of {@link Criterion} which specifies criteria based
* on the contents of a {@link JOSEObject} element.
+ *
+ * @since 2.2.0
*/
public final class JOSEObjectCriterion implements Criterion {
@@ -63,6 +65,7 @@ public final class JOSEObjectCriterion implements Criterion {
}
/** {@inheritDoc} */
+ @Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append("JOSEObjectCriterion [JOSEObject=");
@@ -72,6 +75,7 @@ public final class JOSEObjectCriterion implements Criterion {
}
/** {@inheritDoc} */
+ @Override
public int hashCode() {
if (joseObject != null) {
return joseObject.hashCode();
@@ -80,6 +84,7 @@ public final class JOSEObjectCriterion implements Criterion {
}
/** {@inheritDoc} */
+ @Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWKSetCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWKSetCriterion.java
index ba25c2f..1667a64 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWKSetCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWKSetCriterion.java
@@ -26,6 +26,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* An implementation of {@link Criterion} which specifies criteria based
* on the contents of a {@link JWKSet} element.
+ *
+ * @since 2.2.0
*/
public final class JWKSetCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTDecryptionConfigurationCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTDecryptionConfigurationCriterion.java
index b9a3254..2b17d04 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTDecryptionConfigurationCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTDecryptionConfigurationCriterion.java
@@ -31,6 +31,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* Criterion which holds one or more instances of {@link DecryptionConfiguration}.
+ *
+ * @since 2.2.0
*/
public class JWTDecryptionConfigurationCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTEncryptionConfigurationCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTEncryptionConfigurationCriterion.java
index bd907b3..9f3db6d 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTEncryptionConfigurationCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTEncryptionConfigurationCriterion.java
@@ -31,6 +31,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* Criterion which holds one or more instances of {@link JWTEncryptionConfigurationCriterion}.
+ *
+ * @since 2.2.0
*/
public class JWTEncryptionConfigurationCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureSigningConfigurationCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureSigningConfigurationCriterion.java
index 20a12d7..bdb2f61 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureSigningConfigurationCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureSigningConfigurationCriterion.java
@@ -31,6 +31,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* Criterion which holds one or more instances of {@link JWTSignatureSigningConfigurationCriterion}.
+ *
+ * @since 2.2.0
*/
public class JWTSignatureSigningConfigurationCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureValidationConfigurationCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureValidationConfigurationCriterion.java
index 7f78ccd..dce529f 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureValidationConfigurationCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/JWTSignatureValidationConfigurationCriterion.java
@@ -34,6 +34,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* Criterion which holds one or more instances of {@link SignatureValidationConfiguration}
* for {@link SignedJWT signed JWTs}.
+ *
+ * @since 2.2.0
*/
public class JWTSignatureValidationConfigurationCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/KeyIdCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/KeyIdCriterion.java
index 0550f6e..3e2aff5 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/KeyIdCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/KeyIdCriterion.java
@@ -26,6 +26,8 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
* An implementation of {@link Criterion} which specifies key ID criteria.
+ *
+ * @since 2.2.0
*/
public class KeyIdCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ProviderMetadataCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ProviderMetadataCriterion.java
index 7adee02..38d3987 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ProviderMetadataCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/ProviderMetadataCriterion.java
@@ -25,7 +25,9 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
- * Proviuder metadata criterion to make decisions based on OpenID Provider information.
+ * Provider metadata criterion to make decisions based on OpenID Provider information.
+ *
+ * @since 2.2.0
*/
public class ProviderMetadataCriterion implements Criterion {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/StaticCredentialCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/StaticCredentialCriterion.java
index 56b6e20..9633f33 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/StaticCredentialCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/criterion/StaticCredentialCriterion.java
@@ -24,7 +24,11 @@ import org.opensaml.security.credential.Credential;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.resolver.Criterion;
-/** A {@link Criterion} that holds a single, fixed, credential.*/
+/**
+ * A {@link Criterion} that holds a single, fixed, credential.
+ *
+ * @since 2.2.0
+ */
public class StaticCredentialCriterion implements Criterion {
/** The credential to hold.*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java
index 2f0c6df..fe19f4d 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java
@@ -30,6 +30,8 @@ import net.shibboleth.oidc.security.jose.SignatureValidationParameters;
/**
* A context implementation for storing parameter instances for JWT signature signing and validation, and JWT
* encryption and decryption.
+ *
+ * @since 2.2.0
*/
public final class SecurityParametersContext extends BaseContext {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list