[java-opensaml COMMIT] in /trunk: opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionVa...

[noreply at shibboleth.net]

Author: putmanb
Date: Fri Jun  5 16:14:51 2015
New Revision: 4288

URL: http://svn.shibboleth.net/view/java-opensaml?rev=4288&view=rev
Log:
Move all Assertion validation context parameter keys into an API constants class.
Restructure and standardize Javadocs for parameters on the classes which use them.

Added:
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java   (with props)
Modified:
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AbstractSubjectConfirmationValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AudienceRestrictionConditionValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/BearerSubjectConfirmationValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/DelegationRestrictionConditionValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/HolderOfKeySubjectConfirmationValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/OneTimeUseConditionValidator.java
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/SenderVouchersSubjectConfirmationValidator.java
    trunk/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/assertion/BaseAssertionValidationTest.java
    trunk/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidatorTest.java
    trunk/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/assertion/impl/AbstractSubjectConfirmationValidatorTest.java
    trunk/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/assertion/impl/AudienceRestrictionConditionValidatorTest.java
    trunk/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/assertion/impl/HolderOfKeySubjectConfirmationValidatorTest.java
    trunk/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/assertion/impl/OneTimeUseConditionValidatorTest.java

Modified: trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java?rev=4288&r1=4287&r2=4288&view=diff
==============================================================================
--- trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java	(original)
+++ trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java	Fri Jun  5 16:14:51 2015
@@ -55,41 +55,48 @@
 import org.slf4j.LoggerFactory;
 import org.w3c.dom.Element;
 
-/** A validator used to evaluate version 2.0 {@link Assertion}s. */
+/** 
+ * A component capable of performing core validation of SAML version 2.0 {@link Assertion} instances.
+ * 
+ * <p>
+ * Supports the following {@link ValidationContext} static parameters:
+ * <ul>
+ * <li>
+ * {@link SAML2AssertionValidationParameters#SIGNATURE_REQUIRED}:
+ * Optional.
+ * If not supplied, defaults to 'true'. If an Assertion is signed, the signature is always evaluated 
+ * and the result factored into the overall validation result, regardless of the value of this setting.
+ * </li>
+ * <li>
+ * {@link SAML2AssertionValidationParameters#SIGNATURE_VALIDATION_CRITERIA_SET}:
+ * Optional.
+ * If not supplied, a minimal criteria set will be constructed which contains an {@link EntityIDCriteria} 
+ * containing the Assertion Issuer entityID, and a {@link UsageCriteria} of {@link UsageType#SIGNING}.
+ * If it is supplied, but either of those criteria are absent from the criteria set, they will be added 
+ * with the above values.
+ * </li>
+ * <li>
+ * {@link SAML2AssertionValidationParameters#CLOCK_SKEW}:
+ * Optional.
+ * If not present the default clock skew of {@value SAML20AssertionValidator#DEFAULT_CLOCK_SKEW} milliseconds 
+ * will be used.
+ * </li>
+ * </ul>
+ * </p>
+ * 
+ * <p>
+ * Supports the following {@link ValidationContext} dynamic parameters:
+ * <ul>
+ * <li>
+ * {@link SAML2AssertionValidationParameters#CONFIRMED_SUBJECT_CONFIRMATION}:
+ * Optional.
+ * Will be present after validation iff subject confirmation was successfully performed.
+ * </li>
+ * </ul>
+ * </p>
+ * 
+ * */
 public class SAML20AssertionValidator {
-
-    /**
-     * The name of the {@link ValidationContext#getStaticParameters()} carrying the clock skew, in milliseconds as a
-     * {@link Long}. If not present the default clock skew of {@value #DEFAULT_CLOCK_SKEW} milliseconds will be used.
-     */
-    public static final String CLOCK_SKEW_PARAM = SAML20AssertionValidator.class.getName() + ".ClockSkew";
-
-    /**
-     * The name of the {@link ValidationContext#getDynamicParameters()} carrying the {@link SubjectConfirmation} that
-     * confirmed the subject.
-     */

[... 1126 lines stripped ...]