[java-opensaml COMMIT] /trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/common/SAML2Helper.java

[noreply at shibboleth.net]

Author: putmanb
Date: Fri Aug 23 18:18:30 2013
New Revision: 3430

URL: http://svn.shibboleth.net/view/java-opensaml?rev=3430&view=rev
Log:
Checkstyle fixes, cyclomatic complexity refactoring.

Modified:
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/common/SAML2Helper.java

Modified: trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/common/SAML2Helper.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/common/SAML2Helper.java?rev=3430&r1=3429&r2=3430&view=diff
==============================================================================
--- trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/common/SAML2Helper.java (original)
+++ trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/common/SAML2Helper.java Fri Aug 23 18:18:30 2013
@@ -19,10 +19,19 @@
 
 import java.util.List;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 import org.joda.time.DateTime;
 import org.opensaml.core.xml.XMLObject;
 
-public class SAML2Helper {
+/**
+ * Utility class for common SAML 2 operations.
+ */
+public final class SAML2Helper {
+    
+    /** Private constructor to disallow instantiation. */
+    private SAML2Helper() { }
 
     /**
      * Checks to see if the given XMLObject is still valid. An XMLObject is valid if, and only if, itself and every
@@ -32,7 +41,7 @@
      * 
      * @return true of the tree is valid, false if not
      */
-    public static boolean isValid(XMLObject xmlObject) {
+    public static boolean isValid(final XMLObject xmlObject) {
         if (xmlObject instanceof TimeBoundSAMLObject) {
             TimeBoundSAMLObject timeBoundObject = (TimeBoundSAMLObject) xmlObject;
             if (!timeBoundObject.isValid()) {
@@ -56,11 +65,11 @@
      * <li>the shortest duration on a {@link CacheableSAMLObject} added to the current time</li>
      * </ul>
      * 
-     * @param xmlObject the XML object tree to get the earliest expiration time from
+     * @param xmlObject the XML object tree from which to get the earliest expiration time
      * 
      * @return the earliest expiration time
      */
-    public static DateTime getEarliestExpiration(XMLObject xmlObject) {
+    @Nullable public static DateTime getEarliestExpiration(@Nonnull final XMLObject xmlObject) {
         DateTime now = new DateTime();
         return getEarliestExpiration(xmlObject, null, now);
     }
@@ -68,44 +77,27 @@
     /**
      * Gets the earliest expiration instant within a metadata tree.
      * 
-     * @param xmlObject the metadata
-     * @param earliestExpiration the earliest expiration instant
+     * @param xmlObject the target XMLObject to evaluate
+     * @param candidateTime the candidate earliest expiration instant
      * @param now when this method was called
      * 
-     * @return the earliest expiration instant within a metadata tree
+     * @return the earliest expiration instant within a metadata tree. May be null if the input candiateTime 
+     *          was null, otherwise will always be non-null.
      */
-    public static DateTime getEarliestExpiration(XMLObject xmlObject, DateTime earliestExpiration, DateTime now) {
-
-        // expiration time for a specific element
-        DateTime elementExpirationTime;
+    @Nullable public static DateTime getEarliestExpiration(@Nonnull final XMLObject xmlObject, 
+            @Nullable DateTime candidateTime, @Nonnull DateTime now) {
+        
+        DateTime earliestExpiration = candidateTime;
 
         // Test duration based times
         if (xmlObject instanceof CacheableSAMLObject) {
-            CacheableSAMLObject cacheInfo = (CacheableSAMLObject) xmlObject;
-
-            if (cacheInfo.getCacheDuration() != null && cacheInfo.getCacheDuration().longValue() > 0) {
-                elementExpirationTime = now.plus(cacheInfo.getCacheDuration().longValue());
-                if (earliestExpiration == null) {
-                    earliestExpiration = elementExpirationTime;
-                } else {
-                    if (elementExpirationTime != null && elementExpirationTime.isBefore(earliestExpiration)) {
-                        earliestExpiration = elementExpirationTime;
-                    }
-                }
-            }
+            earliestExpiration = getEarliestExpirationFromCacheable((CacheableSAMLObject)xmlObject, earliestExpiration, 
+                    now);
         }
 
         // Test instant based times
         if (xmlObject instanceof TimeBoundSAMLObject) {
-            TimeBoundSAMLObject timeBoundObject = (TimeBoundSAMLObject) xmlObject;
-            elementExpirationTime = timeBoundObject.getValidUntil();
-            if (earliestExpiration == null) {
-                earliestExpiration = elementExpirationTime;
-            } else {
-                if (elementExpirationTime != null && elementExpirationTime.isBefore(earliestExpiration)) {
-                    earliestExpiration = elementExpirationTime;
-                }
-            }

[... 68 lines stripped ...]