[java-opensaml] 09/14: JSPT-98 Integrate lifecycle checking methods in base classes
Rod Widdowson
rdw at steadingsoftware.com
Mon Jul 11 15:47:39 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=17c62c83c21edd0194bb8fb9c855cab6a44ed60d
commit 17c62c83c21edd0194bb8fb9c855cab6a44ed60d
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Mon Jun 13 20:13:29 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: soap-api
---
.../http/AbstractPipelineHttpSOAPClient.java | 26 +++++++++------------
.../opensaml/soap/client/http/HttpSOAPClient.java | 27 +++++++++++-----------
.../client/http/PipelineFactoryHttpSOAPClient.java | 7 ++----
.../AbstractHeaderGeneratingMessageHandler.java | 17 +++++---------
4 files changed, 32 insertions(+), 45 deletions(-)
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/AbstractPipelineHttpSOAPClient.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/AbstractPipelineHttpSOAPClient.java
index 5327f13cc..003bffaa0 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/AbstractPipelineHttpSOAPClient.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/AbstractPipelineHttpSOAPClient.java
@@ -18,8 +18,8 @@
package org.opensaml.soap.client.http;
import static org.opensaml.security.httpclient.HttpClientSecurityConstants.CONTEXT_KEY_CRITERIA_SET;
-import static org.opensaml.security.httpclient.HttpClientSecurityConstants.CONTEXT_KEY_TRUST_ENGINE;
import static org.opensaml.security.httpclient.HttpClientSecurityConstants.CONTEXT_KEY_SERVER_TLS_FAILURE_IS_FATAL;
+import static org.opensaml.security.httpclient.HttpClientSecurityConstants.CONTEXT_KEY_TRUST_ENGINE;
import java.io.IOException;
import java.util.function.Function;
@@ -29,14 +29,6 @@ import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
import javax.net.ssl.SSLException;
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-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.logic.Constraint;
-import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
-
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpClient;
@@ -65,6 +57,13 @@ import org.opensaml.soap.common.SOAPException;
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.component.AbstractInitializableComponent;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
+
/**
* SOAP client that is based on {@link HttpClientMessagePipeline}.
*/
@@ -126,8 +125,7 @@ public abstract class AbstractPipelineHttpSOAPClient
* @param client client object
*/
public void setHttpClient(@Nonnull final HttpClient client) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
httpClient = Constraint.isNotNull(client, "HttpClient cannot be null");
}
@@ -147,8 +145,7 @@ public abstract class AbstractPipelineHttpSOAPClient
* @param params the new client security parameters
*/
public void setHttpClientSecurityParameters(@Nullable final HttpClientSecurityParameters params) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
httpClientSecurityParameters = params;
}
@@ -172,8 +169,7 @@ public abstract class AbstractPipelineHttpSOAPClient
* @param function the strategy function, or null
*/
public void setTLSCriteriaSetStrategy(@Nullable final Function<InOutOperationContext,CriteriaSet> function) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
tlsCriteriaSetStrategy = function;
}
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java
index 95e06fb65..a3ef64e91 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java
@@ -28,16 +28,6 @@ import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-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.logic.Constraint;
-import net.shibboleth.utilities.java.support.xml.ParserPool;
-import net.shibboleth.utilities.java.support.xml.SerializeSupport;
-import net.shibboleth.utilities.java.support.xml.XMLParserException;
-
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
@@ -68,6 +58,15 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Element;
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
+import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.xml.ParserPool;
+import net.shibboleth.utilities.java.support.xml.SerializeSupport;
+import net.shibboleth.utilities.java.support.xml.XMLParserException;
+
/**
* SOAP client that uses HTTP as the underlying transport and POST as the binding.
*/
@@ -121,7 +120,7 @@ public class HttpSOAPClient extends AbstractInitializableComponent implements SO
* @param client client object
*/
public void setHttpClient(@Nonnull final HttpClient client) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
httpClient = Constraint.isNotNull(client, "HttpClient cannot be null");
}
@@ -132,7 +131,7 @@ public class HttpSOAPClient extends AbstractInitializableComponent implements SO
* @param parser parser pool
*/
public void setParserPool(@Nonnull final ParserPool parser) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
parserPool = Constraint.isNotNull(parser, "ParserPool cannot be null");
}
@@ -159,7 +158,7 @@ public class HttpSOAPClient extends AbstractInitializableComponent implements SO
* message context
*/
public void setSOAPClientContextLookupStrategy(@Nonnull final Function<MessageContext,SOAPClientContext> strategy) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
soapClientContextLookupStrategy =
Constraint.isNotNull(strategy, "SOAP client context lookup strategy cannot be null");
@@ -184,7 +183,7 @@ public class HttpSOAPClient extends AbstractInitializableComponent implements SO
* message context
*/
public void setSOAP11ContextLookupStrategy(@Nonnull final Function<MessageContext,SOAP11Context> strategy) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
soap11ContextLookupStrategy =
Constraint.isNotNull(strategy, "SOAP 1.1 context lookup strategy cannot be null");
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java
index e751553b5..5a336c6a3 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java
@@ -32,7 +32,6 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
/**
@@ -58,8 +57,7 @@ public class PipelineFactoryHttpSOAPClient extends AbstractPipelineHttpSOAPClien
*/
public void setPipelineFactory(
@Nonnull final HttpClientMessagePipelineFactory factory) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
pipelineFactory = Constraint.isNotNull(factory, "HttpClientPipelineFactory cannot be null");
}
@@ -70,8 +68,7 @@ public class PipelineFactoryHttpSOAPClient extends AbstractPipelineHttpSOAPClien
* @param function the strategy function, or null
*/
public void setPipelineNameStrategy(@Nullable final Function<InOutOperationContext,String> function) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
pipelineNameStrategy = function;
}
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/AbstractHeaderGeneratingMessageHandler.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/AbstractHeaderGeneratingMessageHandler.java
index ef0e9cb96..f2f0041a5 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/AbstractHeaderGeneratingMessageHandler.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/AbstractHeaderGeneratingMessageHandler.java
@@ -23,14 +23,13 @@ import java.util.function.Predicate;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-import net.shibboleth.utilities.java.support.primitive.StringSupport;
-
import org.opensaml.core.xml.XMLObject;
import org.opensaml.messaging.context.MessageContext;
import org.opensaml.messaging.handler.AbstractMessageHandler;
import org.opensaml.messaging.handler.MessageHandlerException;
+import net.shibboleth.utilities.java.support.primitive.StringSupport;
+
/**
* Abstract base class for message handlers that generate SOAP headers.
*/
@@ -60,8 +59,7 @@ public abstract class AbstractHeaderGeneratingMessageHandler extends AbstractMes
* @param flag true if header must be understood, false if not
*/
public void setMustUnderstand(final boolean flag) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
mustUnderstand = flag;
}
@@ -71,8 +69,7 @@ public abstract class AbstractHeaderGeneratingMessageHandler extends AbstractMes
* @param strategy the predicate strategy
*/
public void setMustUnderstandStrategy(@Nullable final Predicate<MessageContext> strategy) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
mustUnderstandStrategy = strategy;
}
@@ -91,8 +88,7 @@ public abstract class AbstractHeaderGeneratingMessageHandler extends AbstractMes
* @param node the target node, may be null
*/
public void setTargetNode(@Nullable final String node) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
targetNode = StringSupport.trimOrNull(node);
}
@@ -102,8 +98,7 @@ public abstract class AbstractHeaderGeneratingMessageHandler extends AbstractMes
* @param strategy the predicate strategy
*/
public void setTargetNodeStrategy(@Nullable final Function<MessageContext,String> strategy) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
- ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ throwSetterPreconditionExceptions();
targetNodeStrategy = strategy;
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list