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

Rod Widdowson rdw at steadingsoftware.com
Fri Jul 1 11:02:08 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=c8dc5707497b4d5af14036e937f559ba217e66c4

commit c8dc5707497b4d5af14036e937f559ba217e66c4
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sun Jun 12 15:24:57 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: messaging-impl
---
 .../handler/impl/AbstractMessageChannelSecurity.java        |  3 +--
 .../messaging/handler/impl/CheckExpectedIssuer.java         | 13 ++++++-------
 .../handler/impl/CheckMandatoryAuthentication.java          | 11 +++++------
 .../messaging/handler/impl/CheckMandatoryIssuer.java        | 11 +++++------
 .../messaging/handler/impl/FunctionMessageHandler.java      |  4 +---
 .../handler/impl/HTTPRequestValidationHandler.java          |  9 ++++-----
 .../handler/impl/URLEvaluatingMessageChannelSecurity.java   |  3 +--
 7 files changed, 23 insertions(+), 31 deletions(-)

diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/AbstractMessageChannelSecurity.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/AbstractMessageChannelSecurity.java
index 5bfbbe600..b16b79819 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/AbstractMessageChannelSecurity.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/AbstractMessageChannelSecurity.java
@@ -27,7 +27,6 @@ import org.opensaml.messaging.context.MessageContext;
 import org.opensaml.messaging.handler.AbstractMessageHandler;
 import org.opensaml.messaging.handler.MessageHandlerException;
 
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
 /**
@@ -64,7 +63,7 @@ public abstract class AbstractMessageChannelSecurity extends AbstractMessageHand
      *          the {@link org.opensaml.messaging.context.MessageChannelSecurityContext}
      */
     public void setParentContextLookupStrategy(@Nonnull final Function<MessageContext, BaseContext> strategy) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         parentContextLookupStrategy = Constraint.isNotNull(strategy, "Parent context lookup strategy cannot be null");
     }
diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckExpectedIssuer.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckExpectedIssuer.java
index 471839052..8c1031765 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckExpectedIssuer.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckExpectedIssuer.java
@@ -22,17 +22,16 @@ import java.util.function.Function;
 
 import javax.annotation.Nonnull;
 
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
-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.opensaml.messaging.context.MessageContext;
 import org.opensaml.messaging.handler.AbstractMessageHandler;
 import org.opensaml.messaging.handler.MessageHandlerException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+
 /**
  * Message handler that checks that a message context has an issuer.
  */
@@ -53,7 +52,7 @@ public final class CheckExpectedIssuer extends AbstractMessageHandler {
      * @param strategy lookup strategy
      */
     public void setIssuerLookupStrategy(@Nonnull final Function<MessageContext,String> strategy) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         issuerLookupStrategy = Constraint.isNotNull(strategy, "Message context issuer lookup strategy cannot be null");
     }
@@ -64,7 +63,7 @@ public final class CheckExpectedIssuer extends AbstractMessageHandler {
      * @param strategy lookup strategy
      */
     public void setExpectedIssuerLookupStrategy(@Nonnull final Function<MessageContext,String> strategy) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         expectedIssuerLookupStrategy = Constraint.isNotNull(strategy, 
                 "Message context expected issuer lookup strategy cannot be null");
diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryAuthentication.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryAuthentication.java
index 64ee1638e..8d82f8e51 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryAuthentication.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryAuthentication.java
@@ -21,15 +21,14 @@ import java.util.function.Function;
 
 import javax.annotation.Nonnull;
 
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
-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.opensaml.messaging.context.MessageContext;
 import org.opensaml.messaging.handler.AbstractMessageHandler;
 import org.opensaml.messaging.handler.MessageHandlerException;
 
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+
 /**
  * Message handler that checks that a message context is authenticated.
  */
@@ -44,7 +43,7 @@ public final class CheckMandatoryAuthentication extends AbstractMessageHandler {
      * @param strategy lookup strategy
      */
     public void setAuthenticationLookupStrategy(@Nonnull final Function<MessageContext,Boolean> strategy) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         authenticationLookupStrategy = Constraint.isNotNull(strategy,
                 "Message context authentication lookup strategy cannot be null");
diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryIssuer.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryIssuer.java
index e8017a556..b4746b8ff 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryIssuer.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/CheckMandatoryIssuer.java
@@ -21,15 +21,14 @@ import java.util.function.Function;
 
 import javax.annotation.Nonnull;
 
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
-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.opensaml.messaging.context.MessageContext;
 import org.opensaml.messaging.handler.AbstractMessageHandler;
 import org.opensaml.messaging.handler.MessageHandlerException;
 
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+
 /**
  * Message handler that checks that a message context has an issuer.
  */
@@ -44,7 +43,7 @@ public final class CheckMandatoryIssuer extends AbstractMessageHandler {
      * @param strategy lookup strategy
      */
     public void setIssuerLookupStrategy(@Nonnull final Function<MessageContext,String> strategy) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         issuerLookupStrategy = Constraint.isNotNull(strategy, "Message context issuer lookup strategy cannot be null");
     }
diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/FunctionMessageHandler.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/FunctionMessageHandler.java
index 8b8fdbaed..0821985ba 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/FunctionMessageHandler.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/FunctionMessageHandler.java
@@ -22,8 +22,6 @@ import java.util.function.Function;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-
 import org.opensaml.messaging.context.MessageContext;
 import org.opensaml.messaging.handler.AbstractMessageHandler;
 import org.opensaml.messaging.handler.MessageHandlerException;
@@ -46,7 +44,7 @@ public final class FunctionMessageHandler extends AbstractMessageHandler {
      * @param function the function to use
      */
     public void setFunction(@Nullable final Function<MessageContext,Exception> function) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
 
         messageContextConsumer = function;
     }
diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandler.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandler.java
index 91bb541a5..398357514 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandler.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandler.java
@@ -29,7 +29,6 @@ import org.slf4j.LoggerFactory;
 import jakarta.servlet.http.HttpServletRequest;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 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.StringSupport;
 
@@ -68,7 +67,7 @@ public class HTTPRequestValidationHandler extends AbstractMessageHandler {
      * @param contentType the content type
      */
     public void setRequiredContentType(final String contentType) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         requiredContentType = contentType;
     }
 
@@ -87,7 +86,7 @@ public class HTTPRequestValidationHandler extends AbstractMessageHandler {
      * @param requestMethod the required request method
      */
     public void setRequiredRequestMethod(final String requestMethod) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         requiredRequestMethod = StringSupport.trimOrNull(requestMethod);
     }
 
@@ -106,7 +105,7 @@ public class HTTPRequestValidationHandler extends AbstractMessageHandler {
      * @param secured true if required to be secure, false otherwise
      */
     public void setRequireSecured(final boolean secured) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         requireSecured = secured;
     }
 
@@ -125,7 +124,7 @@ public class HTTPRequestValidationHandler extends AbstractMessageHandler {
      * @param request the request instance
      */
     public void setHttpServletRequest(final HttpServletRequest request) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         httpServletRequest = Constraint.isNotNull(request, "HttpServletRequest may not be null");
     }
 
diff --git a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/URLEvaluatingMessageChannelSecurity.java b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/URLEvaluatingMessageChannelSecurity.java
index b45d0a3a1..7f14ce98d 100644
--- a/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/URLEvaluatingMessageChannelSecurity.java
+++ b/opensaml-messaging-impl/src/main/java/org/opensaml/messaging/handler/impl/URLEvaluatingMessageChannelSecurity.java
@@ -31,7 +31,6 @@ import org.slf4j.LoggerFactory;
 
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.net.URLBuilder;
 
 /**
@@ -73,7 +72,7 @@ public class URLEvaluatingMessageChannelSecurity extends AbstractMessageChannelS
      * @param flag flag to set
      */
     public void setDefaultPortInsecure(final boolean flag) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         
         defaultPortInsecure = flag;
     }

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


More information about the commits mailing list