[java-oidc-common] branch main updated: Javadoc fixes

[Phil Smart]

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=a747403fc22fbacde425c41dbf57184503a591d7

The following commit(s) were added to refs/heads/main by this push:
       new  a747403   Javadoc fixes
a747403 is described below

commit a747403fc22fbacde425c41dbf57184503a591d7
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Tue Feb 2 12:24:01 2021 +0000

    Javadoc fixes
---
 .../shibboleth/oidc/jwt/claims/JWTClaimsValidation.java  | 16 +++++++++++++++-
 .../oidc/jwt/claims/JWTValidationException.java          |  1 +
 2 files changed, 16 insertions(+), 1 deletion(-)

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 eed0540..a83079a 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
@@ -25,9 +25,23 @@ import org.opensaml.profile.context.ProfileRequestContext;
 
 import com.nimbusds.jwt.JWTClaimsSet;
 
+/**
+ * Validation engine for verifying claims in the JWT claims set. 
+ * 
+ *  <p>Does not have to be directly responsible for validating claims, can delegate to
+ *  one or more {@link ClaimsValidator} implementations.</p>
+ */
 public interface JWTClaimsValidation {
     
-    
+    /**
+     * Validate the claims in the claims set. Can use supporting/runtime information contained
+     * in the context tree.
+     * 
+     * @param claims the JWT claims to validate.
+     * @param context the supporting context.
+     * 
+     * @throws JWTValidationException when validation is unsuccessful due to a failed attempt
+     */
     void validate(@Nullable final JWTClaimsSet claims, @Nonnull final ProfileRequestContext context)
         throws JWTValidationException;
 
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTValidationException.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTValidationException.java
index d3a0b5c..294532f 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTValidationException.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwt/claims/JWTValidationException.java
@@ -2,6 +2,7 @@ package net.shibboleth.oidc.jwt.claims;
 
 import javax.annotation.Nullable;
 
+/** JWT validation exception, to throw when validation fails.*/
 public class JWTValidationException extends Exception{
 
     /** Serial version UID. */

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