[java-shib-shared] 02/02: IDP-1793 Use Suppliers for HttpRequest/Response

Rod Widdowson rdw at steadingsoftware.com
Thu Nov 24 11:00:53 UTC 2022


This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-shared.git;a=commit;h=bbed633f6cce34aec854f444d9cbed842a39fdf1

commit bbed633f6cce34aec854f444d9cbed842a39fdf1
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Nov 24 10:27:30 2022 +0000

    IDP-1793 Use Suppliers for HttpRequest/Response
    
    https://shibboleth.atlassian.net/browse/IDP-1793
    
    NonNullSupplier becomes NonnullSupplier
---
 .../java/net/shibboleth/shared/net/CookieManager.java  | 10 +++++-----
 .../impl/ThreadLocalHttpServletRequestSupplier.java    |  6 +++---
 .../impl/ThreadLocalHttpServletResponseSupplier.java   |  6 +++---
 .../net/shibboleth/shared/net/CookieManagerTest.java   | 18 +++++++++---------
 .../{NonNullSupplier.java => NonnullSupplier.java}     |  2 +-
 .../shibboleth/shared/testing/ConstantSupplier.java    |  6 +++---
 6 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java b/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java
index 8c6a2a2b..65c9963f 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/net/CookieManager.java
@@ -28,7 +28,7 @@ import net.shibboleth.shared.annotation.constraint.NotEmpty;
 import net.shibboleth.shared.component.AbstractInitializableComponent;
 import net.shibboleth.shared.component.ComponentInitializationException;
 import net.shibboleth.shared.logic.Constraint;
-import net.shibboleth.shared.primitive.NonNullSupplier;
+import net.shibboleth.shared.primitive.NonnullSupplier;
 import net.shibboleth.shared.primitive.StringSupport;
 
 /**
@@ -47,10 +47,10 @@ public final class CookieManager extends AbstractInitializableComponent {
     @Nullable private String cookieDomain;
     
     /** Supplier for the servlet request to read from. */
-    @NonnullAfterInit private NonNullSupplier<HttpServletRequest> httpRequestSupplier;
+    @NonnullAfterInit private NonnullSupplier<HttpServletRequest> httpRequestSupplier;
 
     /** Supplier for the servlet response to write to. */
-    @NonnullAfterInit private NonNullSupplier<HttpServletResponse> httpResponseSupplier;
+    @NonnullAfterInit private NonnullSupplier<HttpServletResponse> httpResponseSupplier;
     
     /** Is cookie secure? */
     private boolean secure;
@@ -97,7 +97,7 @@ public final class CookieManager extends AbstractInitializableComponent {
      *
      * @param requestSupplier servlet request supplier
      */
-    public void setHttpServletRequestSupplier(@Nonnull final NonNullSupplier<HttpServletRequest> requestSupplier) {
+    public void setHttpServletRequestSupplier(@Nonnull final NonnullSupplier<HttpServletRequest> requestSupplier) {
         checkSetterPreconditions();
         httpRequestSupplier = Constraint.isNotNull(requestSupplier, "HttpServletRequest cannot be null");
     }
@@ -119,7 +119,7 @@ public final class CookieManager extends AbstractInitializableComponent {
      *
      * @param responseSupplier servlet response
      */
-    public void setHttpServletResponseSupplier(@Nonnull final NonNullSupplier<HttpServletResponse> responseSupplier) {
+    public void setHttpServletResponseSupplier(@Nonnull final NonnullSupplier<HttpServletResponse> responseSupplier) {
         checkSetterPreconditions();
         httpResponseSupplier = Constraint.isNotNull(responseSupplier, "HttpServletResponse cannot be null");
     }
diff --git a/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletRequestSupplier.java b/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletRequestSupplier.java
index edef6f30..c244b083 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletRequestSupplier.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletRequestSupplier.java
@@ -21,13 +21,13 @@ import javax.annotation.Nonnull;
 
 import jakarta.servlet.http.HttpServletRequest;
 import net.shibboleth.shared.logic.Constraint;
-import net.shibboleth.shared.primitive.NonNullSupplier;
+import net.shibboleth.shared.primitive.NonnullSupplier;
 
 /**
- * An implementation of {@link NonNullSupplier} which looks up the current thread-local
+ * An implementation of {@link NonnullSupplier} which looks up the current thread-local
  * servlet request obtained from {@link HttpServletRequestResponseContext}.
  */
-public class ThreadLocalHttpServletRequestSupplier implements NonNullSupplier<HttpServletRequest> {
+public class ThreadLocalHttpServletRequestSupplier implements NonnullSupplier<HttpServletRequest> {
 
     /**
      * {@inheritDoc}
diff --git a/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletResponseSupplier.java b/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletResponseSupplier.java
index 63e07e98..2af2d9da 100644
--- a/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletResponseSupplier.java
+++ b/shib-networking/src/main/java/net/shibboleth/shared/servlet/impl/ThreadLocalHttpServletResponseSupplier.java
@@ -21,13 +21,13 @@ import javax.annotation.Nonnull;
 
 import jakarta.servlet.http.HttpServletResponse;
 import net.shibboleth.shared.logic.Constraint;
-import net.shibboleth.shared.primitive.NonNullSupplier;
+import net.shibboleth.shared.primitive.NonnullSupplier;
 
 /**
- * An implementation of {@link NonNullSupplier} which looks up the current thread-local
+ * An implementation of {@link NonnullSupplier} which looks up the current thread-local
  * servlet response obtained from {@link HttpServletRequestResponseContext}.
  */
-public class ThreadLocalHttpServletResponseSupplier implements NonNullSupplier<HttpServletResponse> {
+public class ThreadLocalHttpServletResponseSupplier implements NonnullSupplier<HttpServletResponse> {
 
     /**
      * {@inheritDoc}
diff --git a/shib-networking/src/test/java/net/shibboleth/shared/net/CookieManagerTest.java b/shib-networking/src/test/java/net/shibboleth/shared/net/CookieManagerTest.java
index 050af270..73e814eb 100644
--- a/shib-networking/src/test/java/net/shibboleth/shared/net/CookieManagerTest.java
+++ b/shib-networking/src/test/java/net/shibboleth/shared/net/CookieManagerTest.java
@@ -28,7 +28,7 @@ import jakarta.servlet.http.Cookie;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import net.shibboleth.shared.component.ComponentInitializationException;
-import net.shibboleth.shared.primitive.NonNullSupplier;
+import net.shibboleth.shared.primitive.NonnullSupplier;
 
 /** {@link CookieManager} unit test. */
 @SuppressWarnings("javadoc")
@@ -49,8 +49,8 @@ public class CookieManagerTest {
         MockHttpServletResponse response = new MockHttpServletResponse();
         
         CookieManager cm = new CookieManager();
-        cm.setHttpServletRequestSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
-        cm.setHttpServletResponseSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
+        cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
+        cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
         cm.initialize();
     }
 
@@ -59,8 +59,8 @@ public class CookieManagerTest {
         MockHttpServletResponse response = new MockHttpServletResponse();
         
         CookieManager cm = new CookieManager();
-        cm.setHttpServletRequestSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
-        cm.setHttpServletResponseSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
+        cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
+        cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
         cm.setCookiePath("/idp");
         cm.initialize();
 
@@ -81,8 +81,8 @@ public class CookieManagerTest {
         MockHttpServletResponse response = new MockHttpServletResponse();
         
         CookieManager cm = new CookieManager();
-        cm.setHttpServletRequestSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
-        cm.setHttpServletResponseSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
+        cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
+        cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
         cm.initialize();
         
         cm.addCookie("foo", "bar");
@@ -103,8 +103,8 @@ public class CookieManagerTest {
         MockHttpServletResponse response = new MockHttpServletResponse();
         
         CookieManager cm = new CookieManager();
-        cm.setHttpServletRequestSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
-        cm.setHttpServletResponseSupplier(new NonNullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
+        cm.setHttpServletRequestSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletRequest get() {return request;}});
+        cm.setHttpServletResponseSupplier(new NonnullSupplier<>() { @Nonnull public HttpServletResponse get() {return response;}});
         cm.initialize();
         
         cm.unsetCookie("foo");
diff --git a/shib-support/src/main/java/net/shibboleth/shared/primitive/NonNullSupplier.java b/shib-support/src/main/java/net/shibboleth/shared/primitive/NonnullSupplier.java
similarity index 95%
rename from shib-support/src/main/java/net/shibboleth/shared/primitive/NonNullSupplier.java
rename to shib-support/src/main/java/net/shibboleth/shared/primitive/NonnullSupplier.java
index 8d140f4b..71e520d9 100644
--- a/shib-support/src/main/java/net/shibboleth/shared/primitive/NonNullSupplier.java
+++ b/shib-support/src/main/java/net/shibboleth/shared/primitive/NonnullSupplier.java
@@ -25,7 +25,7 @@ import javax.annotation.Nonnull;
  * Implementation of {@link Supplier} that carries the nonnull annotation
  * on the {@link #get()} method.
  */
-public interface NonNullSupplier<T> extends Supplier<T> {
+public interface NonnullSupplier<T> extends Supplier<T> {
 
     /** {@inheritDoc} */
     @Override @Nonnull T get();
diff --git a/shib-testing/src/main/java/net/shibboleth/shared/testing/ConstantSupplier.java b/shib-testing/src/main/java/net/shibboleth/shared/testing/ConstantSupplier.java
index 16c270e7..faf392f6 100644
--- a/shib-testing/src/main/java/net/shibboleth/shared/testing/ConstantSupplier.java
+++ b/shib-testing/src/main/java/net/shibboleth/shared/testing/ConstantSupplier.java
@@ -19,13 +19,13 @@ package net.shibboleth.shared.testing;
 
 import javax.annotation.Nonnull;
 
-import net.shibboleth.shared.primitive.NonNullSupplier;
+import net.shibboleth.shared.primitive.NonnullSupplier;
 
 /**
- * Implementaion of {@link NonNullSupplier} which returns an unchanging
+ * Implementaion of {@link NonnullSupplier} which returns an unchanging
  * value/
  */
-public final class ConstantSupplier<T> implements NonNullSupplier<T> {
+public final class ConstantSupplier<T> implements NonnullSupplier<T> {
 
     /** The value we will return */
     @Nonnull private final T theValue;

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


More information about the commits mailing list