[java-support] branch maint-8 updated: IDP-1793 Use Suppliers for HttpRequest/Response
Rod Widdowson
rdw at steadingsoftware.com
Thu Nov 24 10:19:00 UTC 2022
This is an automated email from the git hooks/post-receive script.
rdw pushed a commit to branch maint-8
in repository java-support.
View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=024aeeba2dc42e10a036f1bc21652faf563ebb69
The following commit(s) were added to refs/heads/maint-8 by this push:
new 024aeeb IDP-1793 Use Suppliers for HttpRequest/Response
024aeeb is described below
commit 024aeeba2dc42e10a036f1bc21652faf563ebb69
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Mon Nov 21 13:48:38 2022 +0000
IDP-1793 Use Suppliers for HttpRequest/Response
https://shibboleth.atlassian.net/browse/IDP-1793
Introduce a new NonnullSupplier interface and use to supply
the HttpServletXyz objects.
---
.../utilities/java/support/net/CookieManager.java | 17 ++++++++-------
.../net/ThreadLocalHttpServletRequestSupplier.java | 9 ++++----
.../ThreadLocalHttpServletResponseSupplier.java | 9 ++++----
.../NonnullSupplier.java} | 24 +++++++---------------
.../java/support/net/CookieManagerTest.java | 23 ++++++++++-----------
5 files changed, 36 insertions(+), 46 deletions(-)
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/CookieManager.java b/src/main/java/net/shibboleth/utilities/java/support/net/CookieManager.java
index 93cb33f..6a0b45c 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/CookieManager.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/CookieManager.java
@@ -17,8 +17,6 @@
package net.shibboleth.utilities.java.support.net;
-import java.util.function.Supplier;
-
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.servlet.http.Cookie;
@@ -35,8 +33,9 @@ import net.shibboleth.utilities.java.support.component.ComponentInitializationEx
import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
-import net.shibboleth.utilities.java.support.primitive.StringSupport;
import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
+import net.shibboleth.utilities.java.support.primitive.NonnullSupplier;
+import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* A helper class for managing one or more cookies on behalf of a component.
@@ -57,10 +56,10 @@ public final class CookieManager extends AbstractInitializableComponent {
@Nullable private String cookieDomain;
/** Supplier for the servlet request to read from. */
- @NonnullAfterInit private Supplier<HttpServletRequest> httpRequestSupplier;
+ @NonnullAfterInit private NonnullSupplier<HttpServletRequest> httpRequestSupplier;
/** Supplier for the servlet response to write to. */
- @NonnullAfterInit private Supplier<HttpServletResponse> httpResponseSupplier;
+ @NonnullAfterInit private NonnullSupplier<HttpServletResponse> httpResponseSupplier;
/** Is cookie secure? */
private boolean secure;
@@ -109,7 +108,7 @@ public final class CookieManager extends AbstractInitializableComponent {
*
* @param requestSupplier servlet request supplier
*/
- public void setHttpServletRequestSupplier(@Nonnull final Supplier<HttpServletRequest> requestSupplier) {
+ public void setHttpServletRequestSupplier(@Nonnull final NonnullSupplier<HttpServletRequest> requestSupplier) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
@@ -129,7 +128,7 @@ public final class CookieManager extends AbstractInitializableComponent {
if (request != null && !(request instanceof ThreadLocalHttpServletRequestProxy)) {
log.warn("Unsafe HttpServletRequest injected");
}
- httpRequestSupplier = new Supplier<>() {
+ httpRequestSupplier = new NonnullSupplier<>() {
public HttpServletRequest get() {
return request;
};
@@ -153,7 +152,7 @@ public final class CookieManager extends AbstractInitializableComponent {
*
* @param responseSupplier servlet response
*/
- public void setHttpServletResponseSupplier(@Nonnull final Supplier<HttpServletResponse> responseSupplier) {
+ public void setHttpServletResponseSupplier(@Nonnull final NonnullSupplier<HttpServletResponse> responseSupplier) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
@@ -174,7 +173,7 @@ public final class CookieManager extends AbstractInitializableComponent {
if (response != null && !(response instanceof ThreadLocalHttpServletResponseProxy)) {
log.warn("Unsafe HttpServletRequest injected");
}
- httpResponseSupplier = new Supplier<>() {
+ httpResponseSupplier = new NonnullSupplier<>() {
public HttpServletResponse get() {
return response;
};
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java b/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java
index 06aca0d..c0e4105 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java
@@ -17,17 +17,17 @@
package net.shibboleth.utilities.java.support.net;
-import java.util.function.Supplier;
-
+import javax.annotation.Nonnull;
import javax.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.NonnullSupplier;
/**
- * An implementation of {@link Supplier} of {@link HttpServletRequest}s which looks up the current thread-local
+ * An implementation of {@link NonnullSupplier} of {@link HttpServletRequest}s which looks up the current thread-local
* servlet request obtained from {@link HttpServletRequestResponseContext}.
*/
-public class ThreadLocalHttpServletRequestSupplier implements Supplier<HttpServletRequest> {
+public class ThreadLocalHttpServletRequestSupplier implements NonnullSupplier<HttpServletRequest> {
/**
* {@inheritDoc}
@@ -35,6 +35,7 @@ public class ThreadLocalHttpServletRequestSupplier implements Supplier<HttpServl
*
* @return the current request
*/
+ @Nonnull
public HttpServletRequest get() {
return Constraint.isNotNull(HttpServletRequestResponseContext.getRequest(),
"Current HttpServletRequest has not been loaded via HttpServletRequestResponseContext");
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletResponseSupplier.java b/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletResponseSupplier.java
index 49b464b..f6d9fe5 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletResponseSupplier.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletResponseSupplier.java
@@ -17,17 +17,17 @@
package net.shibboleth.utilities.java.support.net;
-import java.util.function.Supplier;
-
+import javax.annotation.Nonnull;
import javax.servlet.http.HttpServletResponse;
import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.NonnullSupplier;
/**
- * An implementation of {@link Supplier} of {@link HttpServletResponse}s which looks up the current thread-local
+ * An implementation of {@link NonnullSupplier} of {@link HttpServletResponse}s which looks up the current thread-local
* servlet response obtained from {@link HttpServletRequestResponseContext}.
*/
-public class ThreadLocalHttpServletResponseSupplier implements Supplier<HttpServletResponse> {
+public class ThreadLocalHttpServletResponseSupplier implements NonnullSupplier<HttpServletResponse> {
/**
* {@inheritDoc}
@@ -35,6 +35,7 @@ public class ThreadLocalHttpServletResponseSupplier implements Supplier<HttpServ
*
* @return the current response
*/
+ @Nonnull
public HttpServletResponse get() {
return Constraint.isNotNull(HttpServletRequestResponseContext.getResponse(),
"Current HttpServletResponse has not been loaded via HttpServletRequestResponseContext");
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java b/src/main/java/net/shibboleth/utilities/java/support/primitive/NonnullSupplier.java
similarity index 52%
copy from src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java
copy to src/main/java/net/shibboleth/utilities/java/support/primitive/NonnullSupplier.java
index 06aca0d..488187c 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/ThreadLocalHttpServletRequestSupplier.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/primitive/NonnullSupplier.java
@@ -15,28 +15,18 @@
* limitations under the License.
*/
-package net.shibboleth.utilities.java.support.net;
+package net.shibboleth.utilities.java.support.primitive;
import java.util.function.Supplier;
-import javax.servlet.http.HttpServletRequest;
-
-import net.shibboleth.utilities.java.support.logic.Constraint;
+import javax.annotation.Nonnull;
/**
- * An implementation of {@link Supplier} of {@link HttpServletRequest}s which looks up the current thread-local
- * servlet request obtained from {@link HttpServletRequestResponseContext}.
+ * Implementation of {@link Supplier} that carries the nonnull annotation
+ * on the {@link #get()} method.
*/
-public class ThreadLocalHttpServletRequestSupplier implements Supplier<HttpServletRequest> {
+public interface NonnullSupplier<T> extends Supplier<T> {
- /**
- * {@inheritDoc}
- * Get the current HttpServletRequest from ThreadLocal storage.
- *
- * @return the current request
- */
- public HttpServletRequest get() {
- return Constraint.isNotNull(HttpServletRequestResponseContext.getRequest(),
- "Current HttpServletRequest has not been loaded via HttpServletRequestResponseContext");
- }
+ /** {@inheritDoc} */
+ @Override @Nonnull T get();
}
diff --git a/src/test/java/net/shibboleth/utilities/java/support/net/CookieManagerTest.java b/src/test/java/net/shibboleth/utilities/java/support/net/CookieManagerTest.java
index 86578de..dc6249d 100644
--- a/src/test/java/net/shibboleth/utilities/java/support/net/CookieManagerTest.java
+++ b/src/test/java/net/shibboleth/utilities/java/support/net/CookieManagerTest.java
@@ -17,19 +17,18 @@
package net.shibboleth.utilities.java.support.net;
-import java.util.function.Supplier;
-
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.testng.Assert;
import org.testng.annotations.Test;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.primitive.NonnullSupplier;
+
/** {@link CookieManager} unit test. */
public class CookieManagerTest {
@@ -48,8 +47,8 @@ public class CookieManagerTest {
MockHttpServletResponse response = new MockHttpServletResponse();
CookieManager cm = new CookieManager();
- cm.setHttpServletRequestSupplier(new Supplier<>() { public HttpServletRequest get() {return request;}});
- cm.setHttpServletResponseSupplier(new Supplier<>() { public HttpServletResponse get() {return response;}});
+ cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { public HttpServletRequest get() {return request;}});
+ cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { public HttpServletResponse get() {return response;}});
cm.initialize();
}
@@ -58,8 +57,8 @@ public class CookieManagerTest {
MockHttpServletResponse response = new MockHttpServletResponse();
CookieManager cm = new CookieManager();
- cm.setHttpServletRequestSupplier(new Supplier<>() { public HttpServletRequest get() {return request;}});
- cm.setHttpServletResponseSupplier(new Supplier<>() { public HttpServletResponse get() {return response;}});
+ cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { public HttpServletRequest get() {return request;}});
+ cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { public HttpServletResponse get() {return response;}});
cm.setCookiePath("/idp");
cm.initialize();
@@ -102,8 +101,8 @@ public class CookieManagerTest {
MockHttpServletResponse response = new MockHttpServletResponse();
CookieManager cm = new CookieManager();
- cm.setHttpServletRequestSupplier(new Supplier<>() { public HttpServletRequest get() {return request;}});
- cm.setHttpServletResponseSupplier(new Supplier<>() { public HttpServletResponse get() {return response;}});
+ cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { public HttpServletRequest get() {return request;}});
+ cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { public HttpServletResponse get() {return response;}});
cm.initialize();
cm.addCookie("foo", "bar");
@@ -124,8 +123,8 @@ public class CookieManagerTest {
MockHttpServletResponse response = new MockHttpServletResponse();
CookieManager cm = new CookieManager();
- cm.setHttpServletRequestSupplier(new Supplier<>() { public HttpServletRequest get() {return request;}});
- cm.setHttpServletResponseSupplier(new Supplier<>() { public HttpServletResponse get() {return response;}});
+ cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { public HttpServletRequest get() {return request;}});
+ cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { public HttpServletResponse get() {return response;}});
cm.initialize();
cm.unsetCookie("foo");
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list