5.4.2 release

Author: gaynor@illinois.edu

.idea/workspace.xml

@@ -8,7 +8,7 @@ several libraries, e.g. This is how the storage library would be referenced
 <dependency>
     <groupId>edu.uiuc.ncsa.security</groupId>
     <artifactId>storage</artifactId>
-    <version>5.3-SNAPSHOT</version>
+    <version>5.4.2</version>
     <scope>compile</scope>
 </dependency>
 ```
@@ -53,7 +53,7 @@ project does not currently use `$NCSA_DEV_OUTPUT`.
                          
 # Rolling a release
 
-The critical part is to replace the SNAPSHOT tag (e.g. 5.3-SNAPSHOT)
+The critical part is to replace the SNAPSHOT tag (e.g. 5.4.2)
 globally with your preferred version. Note that this tag will also be found in
 java files (so the system is aware of the current release version), so this
 change does not merely affect the pom.xml files. You should also be sure before

README.md

@@ -33,6 +33,7 @@ public class Cleanup<K, V> extends MyThread {
      * If this set true, then any failures cause the cleanup to stop.<br/><br/>
      * If false, then this will attempt to remove all elements. Failures are logged in the
      * {@link #getFailures()} list.
+     *
      * @return
      */
     // Fixes https://github.com/ncsa/security-lib/issues/27
@@ -45,6 +46,7 @@ public void setFailOnError(boolean failOnError) {
     }
 
     boolean failOnError = false;
+
     public Cleanup(MyLoggingFacade logger, String name) {
         super(name, logger);
     }
@@ -71,13 +73,15 @@ public void setEnabledLocking(boolean enabledLocking) {
     public void info(List<V> removed) {
         info("removed:" + removed.size() + ", remaining:" + getMap().size());
     }
+
     Store store;
 
     /**
      * List of failures. Each entry is for the form
      * <pre>
      *     id: message
      * </pre>
+     *
      * @return
      */
     public List<String> getFailures() {
@@ -94,11 +98,12 @@ public void setStore(Store store) {
         this.store = store;
         setMap(store);
     }
+
     public List<V> age() {
-        if(!isEnabledLocking() || isTestMode()){
+        if (!isEnabledLocking() || isTestMode()) {
             return oldAge();
         }
-        if(getStore().containsKey(lockID)){
+        if (getStore().containsKey(lockID)) {
             info("Locked store for " + getName() + " at " + new Date());
             return new ArrayList<>();
         }
@@ -107,16 +112,17 @@ public List<V> age() {
         getStore().save(lock);
         try {
             return oldAge();
-        }finally {
+        } finally {
             // finally block executes even after a return.
             info("removing lock for " + getName() + " at " + new Date());
             getStore().remove(lockID);
             info("removed lock for " + getName());
-            if(0 < getFailures().size()) {
+            if (0 < getFailures().size()) {
                 warn("cleanup failed to remove the following items: " + getFailures());
             }
         }
     }
+
     /**
      * Clean out old entries by aging the elements, i.e., apply the retention policies.
      * Returns a list of the entries removed
@@ -133,23 +139,23 @@ protected List<V> oldAge() {
 
         // copy the object's sorted list or we will get a concurrent modification exception
         for (K key : getSortedKeys()) {
-            if(key.equals(lockID)){
+            if (key.equals(lockID)) {
                 continue;
             }
             V co = getMap().get(key);
             for (RetentionPolicy rp : getRetentionPolicies()) {
                 // see if we should bother in the first place...
                 if (rp.applies()) {
                     if (!rp.retain(key, co)) {
-                        if(!isTestMode()){
+                        if (!isTestMode()) {
                             debug("removing " + key);
                             // Fixes https://github.com/ncsa/security-lib/issues/27
                             try {
                                 getMap().remove(key);
                                 linkedList.add(co);
-                            }catch(Throwable t){
+                            } catch (Throwable t) {
                                 failures.add(key + ": " + t.getMessage());
-                                if(failOnError){
+                                if (failOnError) {
                                     throw t;
                                 }
                             }
@@ -216,7 +222,7 @@ public void run() {
             try {
                 Date nextRun = new Date();
                 long nextCleanup = getNextSleepInterval();
-                if(nextCleanup <=0){
+                if (nextCleanup <= 0) {
                     // this disables cleanup.
                     warn("Cleanup disabled for " + getName() + ". Exiting...");
                     setStopThread(true); //just in case
@@ -225,11 +231,15 @@ public void run() {
                 nextRun.setTime(nextRun.getTime() + nextCleanup);
                 info("next cleanup for " + getName() + " scheduled for " + nextRun);
                 sleep(nextCleanup);
-
+                if (logger != null) {
+                    if (logger.getLogger() != null) {
+                        logger.getLogger().getLevel(); // tries to poke logging to keep it awake.
+                    }
+                }
 
                 if (getMap() == null) {
                     info("cleanup for " + getName() + " no entries, skipped at " + (new Date()));
-                }else{
+                } else {
                     info("cleanup for " + getName() + " starting at " + (new Date()));
                     try {
                         List<V> removed = age();

core/src/main/java/edu/uiuc/ncsa/security/core/cache/Cleanup.java

@@ -1,5 +1,5 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/xhtml/alt-index.xhtml at 2023-05-24 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/xhtml/alt-index.xhtml at 2023-12-06 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -23,9 +23,9 @@
     </div>
     <div id="breadcrumbs">
       <div class="xleft">
-        <span id="publishDate">Last Published: 2023-05-24</span>
+        <span id="publishDate">Last Published: 2023-12-06</span>
       </div>
-      <div class="xright">       <span id="projectVersion">Version: 5.3-SNAPSHOT</span>
+      <div class="xright">       <span id="projectVersion">Version: 5.4.2</span>
       </div>
       <div class="clear">
         <hr/>