[java-opensaml] 07/09: JSPT-98 Integrate lifecycle checking methods in base classes

Rod Widdowson rdw at steadingsoftware.com
Tue Jun 14 10:18:21 UTC 2022


This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch dev/JSPT-98
in repository java-opensaml.

View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=8cf6bea0b44fb317a9dedcc6322794873aefadea

commit 8cf6bea0b44fb317a9dedcc6322794873aefadea
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Mon Jun 13 20:29:44 2022 +0100

    JSPT-98 Integrate lifecycle checking methods in base classes
    
    https://shibboleth.atlassian.net/browse/JSPT-98
    
    Stop using ComponentSupport and use the appropriate methods instead: storage-api
---
 .../java/org/opensaml/storage/AbstractStorageService.java | 15 +++++++--------
 .../src/main/java/org/opensaml/storage/ReplayCache.java   | 11 +++++------
 .../main/java/org/opensaml/storage/RevocationCache.java   | 15 +++++++--------
 3 files changed, 19 insertions(+), 22 deletions(-)

diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractStorageService.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractStorageService.java
index 28b43c89f..3edd2eee3 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractStorageService.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractStorageService.java
@@ -25,16 +25,15 @@ import java.util.TimerTask;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
+import org.opensaml.storage.annotation.AnnotationSupport;
+
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
 import net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 import net.shibboleth.utilities.java.support.primitive.TimerSupport;
 
-import org.opensaml.storage.annotation.AnnotationSupport;
-
 /**
  * Abstract base class for {@link StorageService} implementations.
  * 
@@ -90,7 +89,7 @@ public abstract class AbstractStorageService extends AbstractIdentifiableInitial
      * @param interval time between one cleanup and another
      */
     public void setCleanupInterval(@Nonnull final Duration interval) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         
         Constraint.isNotNull(interval, "Interval cannot be null");
         Constraint.isFalse(interval.isNegative(), "Interval cannot be negative");
@@ -115,7 +114,7 @@ public abstract class AbstractStorageService extends AbstractIdentifiableInitial
      * @param timer timer used to schedule configuration reload tasks
      */
     public void setCleanupTaskTimer(@Nullable final Timer timer) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         cleanupTaskTimer = timer;
     }
@@ -139,7 +138,7 @@ public abstract class AbstractStorageService extends AbstractIdentifiableInitial
      * @param size limit on context size in characters
      */
     public void setContextSize(@Positive final int size) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         contextSize = Constraint.isGreaterThan(0, size, "Size must be greater than zero");
     }
@@ -150,7 +149,7 @@ public abstract class AbstractStorageService extends AbstractIdentifiableInitial
      * @param size size limit on key size in characters
      */
     public void setKeySize(@Positive final int size) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         keySize = Constraint.isGreaterThan(0, size, "Size must be greater than zero");
     }
@@ -161,7 +160,7 @@ public abstract class AbstractStorageService extends AbstractIdentifiableInitial
      * @param size size limit on value size in characters
      */
     public void setValueSize(@Positive final int size) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         valueSize = Constraint.isGreaterThan(0, size, "Size must be greater than zero");
     }
diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/ReplayCache.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/ReplayCache.java
index 2a2531162..5740636ec 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/ReplayCache.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/ReplayCache.java
@@ -23,6 +23,9 @@ import java.time.Instant;
 
 import javax.annotation.Nonnull;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.annotation.constraint.ThreadSafeAfterInit;
@@ -30,12 +33,8 @@ import net.shibboleth.utilities.java.support.codec.StringDigester;
 import net.shibboleth.utilities.java.support.codec.StringDigester.OutputFormat;
 import net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * Tracks non-replayable values in order to detect replays of the values, commonly used to track message identifiers.
  * 
@@ -72,7 +71,7 @@ public class ReplayCache extends AbstractIdentifiableInitializableComponent {
      * @param storageService backing store to use
      */
     public void setStorage(@Nonnull final StorageService storageService) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         
         storage = Constraint.isNotNull(storageService, "StorageService cannot be null");
         final StorageCapabilities caps = storage.getCapabilities();
@@ -96,7 +95,7 @@ public class ReplayCache extends AbstractIdentifiableInitializableComponent {
      * @param flag true iff we should treat storage failures as a replay
      */
     public void setStrict(final boolean flag) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         
         strict = flag;
     }
diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/RevocationCache.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/RevocationCache.java
index 9da28035c..3352cc077 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/RevocationCache.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/RevocationCache.java
@@ -23,19 +23,18 @@ import java.time.Instant;
 
 import javax.annotation.Nonnull;
 
+import org.apache.commons.codec.digest.DigestUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
 import net.shibboleth.utilities.java.support.annotation.constraint.ThreadSafeAfterInit;
 import net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
-import org.apache.commons.codec.digest.DigestUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * Stores and checks for revocation entries.
  * 
@@ -74,7 +73,7 @@ public class RevocationCache extends AbstractIdentifiableInitializableComponent
      * @param entryExpiration lifetime of an revocation entry in milliseconds
      */
     public void setEntryExpiration(@Positive final Duration entryExpiration) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         
         Constraint.isTrue(entryExpiration != null && !entryExpiration.isNegative() && !entryExpiration.isZero(),
                 "Revocation cache default entry expiration must be greater than 0");
@@ -96,7 +95,7 @@ public class RevocationCache extends AbstractIdentifiableInitializableComponent
      * @param storageService backing store to use
      */
     public void setStorage(@Nonnull final StorageService storageService) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         storage = Constraint.isNotNull(storageService, "StorageService cannot be null");
         final StorageCapabilities caps = storage.getCapabilities();
@@ -120,7 +119,7 @@ public class RevocationCache extends AbstractIdentifiableInitializableComponent
      * @param flag true iff we should treat storage failures as a replay
      */
     public void setStrict(final boolean flag) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         strict = flag;
     }

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


More information about the commits mailing list