[java-opensaml] 02/02: IDP-1793 Use Suppliers for HttpRequest/Response
Rod Widdowson
rdw at steadingsoftware.com
Sun Aug 14 14:05:33 UTC 2022
This is an automated email from the git hooks/post-receive script.
rdw pushed a commit to branch main
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=52c6f3ed23f947404b6d14b6aae484d8b69fc72e
commit 52c6f3ed23f947404b6d14b6aae484d8b69fc72e
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sun Jul 31 14:20:38 2022 +0100
IDP-1793 Use Suppliers for HttpRequest/Response
https://shibboleth.atlassian.net/browse/IDP-1793
org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder
(an API base class)
gains a setter for a Supplier for the HttpServletRequest.
Change tests to use this.
---
.../AbstractHttpServletRequestMessageDecoder.java | 62 +++++++++++++++++-----
.../binding/decoding/impl/HTTPPostDecoderTest.java | 5 +-
.../decoding/impl/HTTPSOAP11DecoderTest.java | 6 ++-
.../binding/decoding/impl/HTTPPostDecoderTest.java | 6 ++-
.../impl/HTTPRedirectDeflateDecoderTest.java | 4 +-
.../decoding/impl/HTTPSOAP11DecoderTest.java | 7 ++-
.../decoder/http/impl/HTTPSOAP11DecoderTest.java | 5 +-
7 files changed, 74 insertions(+), 21 deletions(-)
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 dd9f91885..a7efb2c74 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
@@ -17,10 +17,18 @@
package org.opensaml.messaging.decoder.servlet;
+import java.util.function.Supplier;
+
import javax.annotation.Nullable;
+import net.shibboleth.utilities.java.support.net.ThreadLocalHttpServletRequestProxy;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
+
import org.opensaml.messaging.decoder.AbstractMessageDecoder;
import org.opensaml.messaging.decoder.MessageDecodingException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import jakarta.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
@@ -31,38 +39,66 @@ import net.shibboleth.utilities.java.support.component.ComponentInitializationEx
public abstract class AbstractHttpServletRequestMessageDecoder extends AbstractMessageDecoder
implements HttpServletRequestMessageDecoder {
- /** The HTTP servlet request. */
- @Nullable private HttpServletRequest request;
+ /** Logger. */
+ private final Logger log = LoggerFactory.getLogger(AbstractHttpServletRequestMessageDecoder.class);
+
+ /** Current HTTP request, if available. */
+ @Nullable private Supplier<HttpServletRequest> httpServletRequestSupplier;
/** {@inheritDoc} */
+ @Override
@Nullable public HttpServletRequest getHttpServletRequest() {
- return request;
+ if (httpServletRequestSupplier == null) {
+ return null;
+ }
+ return httpServletRequestSupplier.get();
+ }
+
+ /**
+ * Get the supplier for HTTP request if available.
+ *
+ * @return current HTTP request
+ */
+ @Nullable public Supplier<HttpServletRequest> getHttpServletRequestSupplier() {
+ return httpServletRequestSupplier;
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ @Deprecated(since = "4.3", forRemoval = true)
+ public void setHttpServletRequest(@Nullable final HttpServletRequest request) {
+ checkSetterPreconditions();
+ DeprecationSupport.warnOnce(ObjectType.METHOD, "setHttpServletReqest",
+ getClass().getCanonicalName(), "setHttpServletRequestSupplier");
+ if (request != null && !(request instanceof ThreadLocalHttpServletRequestProxy)) {
+ log.warn("Unsafe HttpServletRequest injected");
+ }
+ httpServletRequestSupplier = new Supplier<>() {
+ public HttpServletRequest get() {
+ return request;
+ };
+ };
}
/** {@inheritDoc} */
- public synchronized void setHttpServletRequest(@Nullable final HttpServletRequest servletRequest) {
+ @Override
+ public void setHttpServletRequestSupplier(@Nullable final Supplier<HttpServletRequest> requestSupplier) {
checkSetterPreconditions();
- request = servletRequest;
+ httpServletRequestSupplier = requestSupplier;
}
-
+
/** {@inheritDoc} */
public void decode() throws MessageDecodingException {
super.decode();
}
- /** {@inheritDoc} */
- protected void doDestroy() {
- request = null;
-
- super.doDestroy();
- }
/** {@inheritDoc} */
protected void doInitialize() throws ComponentInitializationException {
super.doInitialize();
- if (request == null) {
+ if (getHttpServletRequest() == null) {
throw new ComponentInitializationException("HTTP Servlet request cannot be null");
}
}
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPPostDecoderTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPPostDecoderTest.java
index e7bb1d473..1b90e6b78 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPPostDecoderTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPPostDecoderTest.java
@@ -19,6 +19,9 @@ package org.opensaml.saml.saml1.binding.decoding.impl;
import java.net.MalformedURLException;
import java.net.URL;
+import java.util.function.Supplier;
+
+import jakarta.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.codec.Base64Support;
import net.shibboleth.utilities.java.support.codec.DecodingException;
@@ -57,7 +60,7 @@ public class HTTPPostDecoderTest extends XMLObjectBaseTestCase {
decoder = new HTTPPostDecoder();
decoder.setParserPool(parserPool);
- decoder.setHttpServletRequest(httpRequest);
+ decoder.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return httpRequest;}});
decoder.initialize();
}
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11DecoderTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11DecoderTest.java
index 475cfbd24..e0c7aed47 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11DecoderTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11DecoderTest.java
@@ -19,6 +19,10 @@ package org.opensaml.saml.saml1.binding.decoding.impl;
import net.shibboleth.utilities.java.support.xml.SerializeSupport;
+import java.util.function.Supplier;
+
+import jakarta.servlet.http.HttpServletRequest;
+
import org.opensaml.core.testing.XMLObjectBaseTestCase;
import org.opensaml.core.xml.XMLObject;
import org.opensaml.core.xml.io.MarshallingException;
@@ -47,7 +51,7 @@ public class HTTPSOAP11DecoderTest extends XMLObjectBaseTestCase {
decoder = new HTTPSOAP11Decoder();
decoder.setParserPool(parserPool);
- decoder.setHttpServletRequest(httpRequest);
+ decoder.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return httpRequest;}});
decoder.initialize();
}
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPPostDecoderTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPPostDecoderTest.java
index d1f282938..f1bba7c11 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPPostDecoderTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPPostDecoderTest.java
@@ -17,6 +17,10 @@
package org.opensaml.saml.saml2.binding.decoding.impl;
+import java.util.function.Supplier;
+
+import jakarta.servlet.http.HttpServletRequest;
+
import org.opensaml.core.testing.XMLObjectBaseTestCase;
import org.opensaml.messaging.context.MessageContext;
import org.opensaml.messaging.decoder.MessageDecodingException;
@@ -52,7 +56,7 @@ public class HTTPPostDecoderTest extends XMLObjectBaseTestCase {
decoder = new HTTPPostDecoder();
decoder.setParserPool(parserPool);
- decoder.setHttpServletRequest(httpRequest);
+ decoder.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return httpRequest;}});
decoder.initialize();
}
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPRedirectDeflateDecoderTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPRedirectDeflateDecoderTest.java
index 37151b549..97fcc0c77 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPRedirectDeflateDecoderTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPRedirectDeflateDecoderTest.java
@@ -21,6 +21,7 @@ import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
+import java.util.function.Supplier;
import java.util.zip.Deflater;
import java.util.zip.DeflaterOutputStream;
@@ -39,6 +40,7 @@ import org.testng.Assert;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
+import jakarta.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.codec.Base64Support;
import net.shibboleth.utilities.java.support.codec.EncodingException;
import net.shibboleth.utilities.java.support.xml.SerializeSupport;
@@ -65,7 +67,7 @@ public class HTTPRedirectDeflateDecoderTest extends XMLObjectBaseTestCase {
decoder = new HTTPRedirectDeflateDecoder();
decoder.setParserPool(parserPool);
- decoder.setHttpServletRequest(httpRequest);
+ decoder.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return httpRequest;}});
decoder.initialize();
}
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11DecoderTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11DecoderTest.java
index c0ea656a1..e47cfd71d 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11DecoderTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11DecoderTest.java
@@ -17,7 +17,7 @@
package org.opensaml.saml.saml2.binding.decoding.impl;
-import net.shibboleth.utilities.java.support.xml.SerializeSupport;
+import java.util.function.Supplier;
import org.opensaml.core.testing.XMLObjectBaseTestCase;
import org.opensaml.core.xml.XMLObject;
@@ -30,6 +30,9 @@ import org.testng.Assert;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
+import jakarta.servlet.http.HttpServletRequest;
+import net.shibboleth.utilities.java.support.xml.SerializeSupport;
+
/**
* Test case for HTTP SOAP 1.1 decoder.
*/
@@ -47,7 +50,7 @@ public class HTTPSOAP11DecoderTest extends XMLObjectBaseTestCase {
decoder = new HTTPSOAP11Decoder();
decoder.setParserPool(parserPool);
- decoder.setHttpServletRequest(httpRequest);
+ decoder.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return httpRequest;}});
decoder.initialize();
}
diff --git a/opensaml-soap-impl/src/test/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11DecoderTest.java b/opensaml-soap-impl/src/test/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11DecoderTest.java
index 8f627cfdd..ff0047223 100644
--- a/opensaml-soap-impl/src/test/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11DecoderTest.java
+++ b/opensaml-soap-impl/src/test/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11DecoderTest.java
@@ -18,6 +18,7 @@
package org.opensaml.soap.soap11.decoder.http.impl;
import java.io.IOException;
+import java.util.function.Supplier;
import org.opensaml.core.testing.XMLObjectBaseTestCase;
import org.opensaml.core.xml.schema.XSAny;
@@ -25,7 +26,6 @@ import org.opensaml.messaging.context.MessageContext;
import org.opensaml.messaging.decoder.MessageDecodingException;
import org.opensaml.messaging.handler.AbstractMessageHandler;
import org.opensaml.messaging.handler.MessageHandlerException;
-import org.opensaml.security.SecurityException;
import org.opensaml.soap.messaging.context.SOAP11Context;
import org.opensaml.soap.soap11.Envelope;
import org.springframework.mock.web.MockHttpServletRequest;
@@ -35,6 +35,7 @@ import org.testng.annotations.Test;
import com.google.common.io.Resources;
+import jakarta.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
/**
@@ -54,7 +55,7 @@ public class HTTPSOAP11DecoderTest extends XMLObjectBaseTestCase {
decoder = new HTTPSOAP11Decoder();
decoder.setParserPool(parserPool);
- decoder.setHttpServletRequest(httpRequest);
+ decoder.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return httpRequest;}});
// Let actual test method do the initialize(), so can set own body handler.
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list