[java-opensaml COMMIT] /trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/Signat...

[noreply at shibboleth.net]

Author: putmanb
Date: Fri Nov  6 18:44:55 2015
New Revision: 4400

URL: http://svn.shibboleth.net/view/java-opensaml?rev=4400&view=rev
Log:
OSJ-120: On SignatureValidationFilter change 'requireSignature' to something more descriptive

Modified:
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/SignatureValidationFilter.java

Modified: trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/SignatureValidationFilter.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/SignatureValidationFilter.java?rev=4400&r1=4399&r2=4400&view=diff
==============================================================================
--- trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/SignatureValidationFilter.java	(original)
+++ trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/SignatureValidationFilter.java	Fri Nov  6 18:44:55 2015
@@ -61,8 +61,8 @@
     /** Trust engine used to validate a signature. */
     @Nonnull private SignatureTrustEngine signatureTrustEngine;
 
-    /** Indicates whether signed metadata is required. */
-    private boolean requireSignature;
+    /** Indicates whether the metadata root element is required to be signed. */
+    private boolean requireSignedRoot;
     
     /** Set of externally specified default criteria for input to the trust engine. */
     @Nullable private CriteriaSet defaultCriteria;
@@ -89,7 +89,7 @@
     public SignatureValidationFilter(@Nonnull final SignatureTrustEngine engine) {
         Constraint.isNotNull(engine, "SignatureTrustEngine cannot be null");
         
-        requireSignature = true;
+        requireSignedRoot = true;
 
         signatureTrustEngine = engine;
         signaturePrevalidator = new SAMLSignatureProfileValidator();
@@ -156,8 +156,33 @@
      * 
      * @return whether incoming metadata is required to be signed
      */
+    public boolean getRequireSignedRoot() {
+        return requireSignedRoot;
+    }
+
+    /**
+     * Set whether incoming metadata's root element is required to be signed.
+     * 
+     * <p>Defaults to <code>true</code>.</p>
+     * 
+     * @param require whether incoming metadata is required to be signed
+     */
+    public void setRequireSignedRoot(final boolean require) {
+        requireSignedRoot = require;
+    }
+    
+    /**
+     * Get whether incoming metadata's root element is required to be signed.
+     * 
+     * <p>Defaults to <code>true</code>.</p>
+     * 
+     * @return whether incoming metadata is required to be signed
+     * 
+     * @deprecated use instead {@link #getRequireSignedRoot()}
+     */
+    @Deprecated
     public boolean getRequireSignature() {
-        return requireSignature;
+        return getRequireSignedRoot();
     }
 
     /**
@@ -166,9 +191,12 @@
      * <p>Defaults to <code>true</code>.</p>
      * 
      * @param require whether incoming metadata is required to be signed
-     */
+     * 
+     * @deprecated use instead {@link #setRequireSignedRoot(boolean)}
+     */
+    @Deprecated
     public void setRequireSignature(final boolean require) {
-        requireSignature = require;
+        setRequireSignedRoot(require);
     }
  
     /**
@@ -203,7 +231,7 @@
         final SignableXMLObject signableMetadata = (SignableXMLObject) metadata;
 
         if (!signableMetadata.isSigned()){
-            if (getRequireSignature()) {
+            if (getRequireSignedRoot()) {
                 log.warn("Metadata root element was unsigned and signatures are required, " 
                         + "metadata will be filtered out.");
                 return null;