[java-opensaml] 02/14: JSPT-98 Integrate lifecycle checking methods in base classes
Rod Widdowson
rdw at steadingsoftware.com
Mon Jul 11 15:47:32 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=d745168224f8012d8b0707fd699939867c059942
commit d745168224f8012d8b0707fd699939867c059942
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sun Jun 12 15:22:12 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-api
---
.../messaging/decoder/AbstractMessageDecoder.java | 9 +++------
.../AbstractHttpClientResponseMessageDecoder.java | 8 +++-----
.../AbstractHttpServletRequestMessageDecoder.java | 4 +---
.../messaging/encoder/AbstractMessageEncoder.java | 16 ++++++----------
.../AbstractHttpClientRequestMessageEncoder.java | 8 +++-----
.../AbstractHttpServletResponseMessageEncoder.java | 4 +---
.../messaging/handler/AbstractMessageHandler.java | 13 ++++++-------
7 files changed, 23 insertions(+), 39 deletions(-)
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java
index 0bf56221a..34a7c912c 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java
@@ -17,12 +17,11 @@
package org.opensaml.messaging.decoder;
+import org.opensaml.messaging.context.MessageContext;
+
import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.component.UnmodifiableComponent;
-import org.opensaml.messaging.context.MessageContext;
-
/**
* Abstract message decoder.
*/
@@ -50,9 +49,7 @@ public abstract class AbstractMessageDecoder extends AbstractInitializableCompon
/** {@inheritDoc} */
@Override
public void decode() throws MessageDecodingException {
- ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
-
+ throwComponentStateExceptions();
doDecode();
}
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/AbstractHttpClientResponseMessageDecoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/AbstractHttpClientResponseMessageDecoder.java
index 44cd67570..d125733bf 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/AbstractHttpClientResponseMessageDecoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/httpclient/AbstractHttpClientResponseMessageDecoder.java
@@ -19,13 +19,12 @@ package org.opensaml.messaging.decoder.httpclient;
import javax.annotation.Nullable;
-import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-
import org.apache.http.HttpResponse;
import org.opensaml.messaging.decoder.AbstractMessageDecoder;
import org.opensaml.messaging.decoder.MessageDecodingException;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+
/**
* Abstract implementation of {@link HttpClientResponseMessageDecoder}.
*/
@@ -42,8 +41,7 @@ public abstract class AbstractHttpClientResponseMessageDecoder extends AbstractM
/** {@inheritDoc} */
public synchronized void setHttpResponse(@Nullable final HttpResponse clientResponse) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
response = clientResponse;
}
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/servlet/AbstractHttpServletRequestMessageDecoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/servlet/AbstractHttpServletRequestMessageDecoder.java
index 96a87bbc1..4bea6dacd 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/servlet/AbstractHttpServletRequestMessageDecoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/servlet/AbstractHttpServletRequestMessageDecoder.java
@@ -24,7 +24,6 @@ import org.opensaml.messaging.decoder.MessageDecodingException;
import jakarta.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
/**
* Abstract implementation of {@link HttpServletRequestMessageDecoder}.
@@ -42,8 +41,7 @@ public abstract class AbstractHttpServletRequestMessageDecoder extends AbstractM
/** {@inheritDoc} */
public synchronized void setHttpServletRequest(@Nullable final HttpServletRequest servletRequest) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
request = servletRequest;
}
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java
index 523d4f303..dfba3ad7c 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java
@@ -17,15 +17,14 @@
package org.opensaml.messaging.encoder;
-import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
-import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-import net.shibboleth.utilities.java.support.component.UnmodifiableComponent;
-
import javax.annotation.Nullable;
import org.opensaml.messaging.context.MessageContext;
+import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.component.UnmodifiableComponent;
+
/**
* Abstract message encoder.
*/
@@ -38,8 +37,7 @@ public abstract class AbstractMessageEncoder extends AbstractInitializableCompon
/** {@inheritDoc} */
@Override
public synchronized void setMessageContext(@Nullable final MessageContext context) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
messageContext = context;
}
@@ -47,9 +45,7 @@ public abstract class AbstractMessageEncoder extends AbstractInitializableCompon
/** {@inheritDoc} */
@Override
public void encode() throws MessageEncodingException {
- ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
-
+ throwComponentStateExceptions();
doEncode();
}
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/AbstractHttpClientRequestMessageEncoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/AbstractHttpClientRequestMessageEncoder.java
index 44574ede8..89dc2f3c1 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/AbstractHttpClientRequestMessageEncoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/httpclient/AbstractHttpClientRequestMessageEncoder.java
@@ -19,13 +19,12 @@ package org.opensaml.messaging.encoder.httpclient;
import javax.annotation.Nullable;
-import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-
import org.apache.http.HttpRequest;
import org.opensaml.messaging.encoder.AbstractMessageEncoder;
import org.opensaml.messaging.encoder.servlet.HttpServletResponseMessageEncoder;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+
/**
* Abstract implementation of {@link HttpServletResponseMessageEncoder}.
*/
@@ -42,8 +41,7 @@ public abstract class AbstractHttpClientRequestMessageEncoder extends AbstractMe
/** {@inheritDoc} */
public synchronized void setHttpRequest(@Nullable final HttpRequest httpRequest) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
request = httpRequest;
}
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/servlet/AbstractHttpServletResponseMessageEncoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/servlet/AbstractHttpServletResponseMessageEncoder.java
index dd68b0978..1c9015556 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/servlet/AbstractHttpServletResponseMessageEncoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/servlet/AbstractHttpServletResponseMessageEncoder.java
@@ -23,7 +23,6 @@ import org.opensaml.messaging.encoder.AbstractMessageEncoder;
import jakarta.servlet.http.HttpServletResponse;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
/**
* Abstract implementation of {@link HttpServletResponseMessageEncoder}.
@@ -41,8 +40,7 @@ public abstract class AbstractHttpServletResponseMessageEncoder extends Abstract
/** {@inheritDoc} */
public synchronized void setHttpServletResponse(@Nullable final HttpServletResponse servletResponse) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
response = servletResponse;
}
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/handler/AbstractMessageHandler.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/handler/AbstractMessageHandler.java
index 4b112f914..0ed5ae8b8 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/handler/AbstractMessageHandler.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/handler/AbstractMessageHandler.java
@@ -21,18 +21,17 @@ import java.util.function.Predicate;
import javax.annotation.Nonnull;
-import net.shibboleth.utilities.java.support.annotation.Prototype;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-import net.shibboleth.utilities.java.support.logic.Constraint;
-
import org.opensaml.messaging.context.MessageContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Predicates;
+import net.shibboleth.utilities.java.support.annotation.Prototype;
+import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+
/**
* A base abstract implementation of {@link MessageHandler}.
*/
@@ -73,7 +72,7 @@ public abstract class AbstractMessageHandler extends AbstractInitializableCompon
* @param condition predicate to apply
*/
public void setActivationCondition(@Nonnull final Predicate<MessageContext> condition) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
activationCondition = Constraint.isNotNull(condition, "Predicate cannot be null");
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list