[java-oidc-common] branch main updated: Deprecate duplicate interface and rebase chaining claims validator.

Scott Cantor cantor.2 at osu.edu
Thu Dec 30 21:24:06 UTC 2021


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

scantor 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=f81cbbd343cd18d743bf880adf13880931455d00

The following commit(s) were added to refs/heads/main by this push:
     new f81cbbd  Deprecate duplicate interface and rebase chaining claims validator.
f81cbbd is described below

commit f81cbbd343cd18d743bf880adf13880931455d00
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Thu Dec 30 16:24:03 2021 -0500

    Deprecate duplicate interface and rebase chaining claims validator.
---
 .../shibboleth/oidc/jwt/claims/JWTClaimsValidation.java   |  4 +++-
 ...imsValidation.java => ChainingJWTClaimsValidator.java} |  9 ++++-----
 ...ationTest.java => ChainingJWTClaimsValidatorTest.java} | 15 +++++++++------
 3 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTClaimsValidation.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTClaimsValidation.java
index 5d6204c..d13b5df 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTClaimsValidation.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTClaimsValidation.java
@@ -30,8 +30,10 @@ import com.nimbusds.jwt.JWTClaimsSet;
  * 
  *  <p>Does not have to be directly responsible for validating claims, can delegate to
  *  one or more {@link ClaimsValidator} implementations.</p>
+ *  
+ *  @deprecated
  */
-//TODO is simply a function?
+ at Deprecated(since="1.2.0", forRemoval=true)
 public interface JWTClaimsValidation {
     
     /**
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidation.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidator.java
similarity index 91%
rename from oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidation.java
rename to oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidator.java
index 3cea9fe..5346221 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidation.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidator.java
@@ -31,27 +31,26 @@ import org.slf4j.LoggerFactory;
 import com.nimbusds.jwt.JWTClaimsSet;
 
 import net.shibboleth.oidc.jwt.claims.ClaimsValidator;
-import net.shibboleth.oidc.jwt.claims.JWTClaimsValidation;
 import net.shibboleth.oidc.jwt.claims.JWTValidationException;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
 import net.shibboleth.utilities.java.support.annotation.constraint.ThreadSafeAfterInit;
-import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
+import net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
 import net.shibboleth.utilities.java.support.component.ComponentSupport;
 
 /**
- * A {@link JWTClaimsValidation JWT claims validation} implementation that validates a JWT claims set from a chain 
+ * A {@link ClaimsValidator} implementation that validates a JWT claims set from a chain 
  * of configured validators. Validation terminates when one of the validators throws a {@link JWTValidationException}. 
  * If no {@link JWTValidationException} is thrown, the claims set is 'valid'.
  * 
  * <p>Note, does not represent a chain of responsibility pattern despite the name.</p>
  */
 @ThreadSafeAfterInit
-public class ChainingJWTClaimsValidation extends AbstractInitializableComponent implements JWTClaimsValidation {
+public class ChainingJWTClaimsValidator extends AbstractIdentifiableInitializableComponent implements ClaimsValidator {
     
     /** Class logger. */
-    @Nonnull private final Logger log = LoggerFactory.getLogger(ChainingJWTClaimsValidation.class);
+    @Nonnull private final Logger log = LoggerFactory.getLogger(ChainingJWTClaimsValidator.class);
     
     /** List of claim validators. Ordering is not important.*/
     @NonnullAfterInit @NonnullElements private List<ClaimsValidator> claimValidators;
diff --git a/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidationTest.java b/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidatorTest.java
similarity index 95%
rename from oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidationTest.java
rename to oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidatorTest.java
index c5403c3..b23e4df 100644
--- a/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidationTest.java
+++ b/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/ChainingJWTClaimsValidatorTest.java
@@ -35,11 +35,11 @@ import net.shibboleth.oidc.jwt.claims.ClaimsValidator;
 import net.shibboleth.oidc.jwt.claims.JWTValidationException;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
 
-/** Test for the {@link ChainingJWTClaimsValidation} class.*/
-public class ChainingJWTClaimsValidationTest extends AbstractClaimsValidatorTest{
+/** Test for the {@link ChainingJWTClaimsValidator} class.*/
+public class ChainingJWTClaimsValidatorTest extends AbstractClaimsValidatorTest{
     
     /** Validation to check.*/
-    @Nonnull private ChainingJWTClaimsValidation validation;
+    @Nonnull private ChainingJWTClaimsValidator validation;
     
     /** Default set of claims.*/
     @Nonnull private List<ClaimsValidator> validators;
@@ -47,7 +47,8 @@ public class ChainingJWTClaimsValidationTest extends AbstractClaimsValidatorTest
     @BeforeMethod
     public void setup() throws ComponentInitializationException {
         super.setup();
-        validation = new ChainingJWTClaimsValidation();
+        validation = new ChainingJWTClaimsValidator();
+        validation.setId("test");
         
         validators = new ArrayList<>(3);
         
@@ -115,13 +116,15 @@ public class ChainingJWTClaimsValidationTest extends AbstractClaimsValidatorTest
     
     @Test(expectedExceptions = ComponentInitializationException.class)
     public void testNoValidators() throws ComponentInitializationException {
-        final ChainingJWTClaimsValidation validationNew = new ChainingJWTClaimsValidation();
+        final ChainingJWTClaimsValidator validationNew = new ChainingJWTClaimsValidator();
+        validationNew.setId("test");
         validationNew.initialize();
     }
     
     @Test
     public void testNullValidators() throws ComponentInitializationException {
-        final ChainingJWTClaimsValidation validationNew = new ChainingJWTClaimsValidation();
+        final ChainingJWTClaimsValidator validationNew = new ChainingJWTClaimsValidator();
+        validationNew.setId("test");
         validationNew.setClaimValidators(null);
         validationNew.initialize();
     }

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


More information about the commits mailing list