You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by "jungm (via GitHub)" <gi...@apache.org> on 2026/02/19 07:50:11 UTC

[PR] TOMEE-4584 - OpenIdAuthenticationMechanism store parameterMap (tomee)

jungm opened a new pull request, #2472:
URL: https://github.com/apache/tomee/pull/2472

   Fixes [TOMEE-4584](https://issues.apache.org/jira/browse/TOMEE-4584)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tomee.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] TOMEE-4584 - OpenIdAuthenticationMechanism store parameterMap (tomee)

Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2472:
URL: https://github.com/apache/tomee/pull/2472#discussion_r2828759723


##########
tomee/tomee-security/src/main/java/org/apache/tomee/security/http/SavedRequest.java:
##########
@@ -132,6 +130,27 @@ public StringBuffer getRequestURL() {
             public String getQueryString() {
                 return queryString;
             }
+
+            @Override
+            public Enumeration<String> getParameterNames() {
+                return Collections.enumeration(parameterMap.keySet());
+            }
+
+            @Override
+            public String[] getParameterValues(String name) {
+                return parameterMap.get(name);
+            }
+
+            @Override
+            public String getParameter(String name) {
+                String[] values = parameterMap.get(name);
+                return values == null || values.length == 0 ? null : values[0];
+            }
+
+            @Override
+            public Map<String, String[]> getParameterMap() {
+                return parameterMap;

Review Comment:
   The parameterMap field can be null when deserializing old JSON, but is returned directly without any defensive handling. Consider returning Collections.emptyMap() when parameterMap is null to prevent NullPointerExceptions in calling code, consistent with the defensive approach used for headers.
   ```suggestion
                   final Map<String, String[]> params = parameterMap != null ? parameterMap : Collections.emptyMap();
                   return Collections.enumeration(params.keySet());
               }
   
               @Override
               public String[] getParameterValues(String name) {
                   final Map<String, String[]> params = parameterMap != null ? parameterMap : Collections.emptyMap();
                   return params.get(name);
               }
   
               @Override
               public String getParameter(String name) {
                   final Map<String, String[]> params = parameterMap != null ? parameterMap : Collections.emptyMap();
                   String[] values = params.get(name);
                   return values == null || values.length == 0 ? null : values[0];
               }
   
               @Override
               public Map<String, String[]> getParameterMap() {
                   return parameterMap != null ? parameterMap : Collections.emptyMap();
   ```



##########
tomee/tomee-security/src/test/java/org/apache/tomee/security/http/SavedRequestTest.java:
##########
@@ -71,6 +73,10 @@ public void deserialization() throws Exception {
         assertEquals("PATCH", request.getMethod());
         assertEquals("foo=bar", request.getQueryString());
         assertEquals("http://example.com/foo", request.getUrl());
+        assertNotNull(request.getParameterMap());
+        assertNotNull(request.getParameterMap().get("foo"));
+        assertEquals(1, request.getParameterMap().get("foo").length);
+        assertEquals("bar", request.getParameterMap().get("foo")[0]);
     }
 
     @Test

Review Comment:
   Add a test case for backward compatibility to verify that deserializing JSON without the parameterMap field (from older versions) doesn't throw exceptions. This is important since SavedRequest instances are stored in sessions and may persist across deployments. The test should verify that old JSON strings lacking parameterMap can still be deserialized and that the parameter-related methods return appropriate defaults (e.g., empty collections) instead of throwing NullPointerExceptions.
   ```suggestion
       @Test
       public void deserializationWithoutParameterMap() throws Exception {
           // JSON produced by older versions that did not include the parameterMap field
           String json = "{\"cookies\":[{\"name\":\"first\",\"value\":\"val1\",\"attributes\":{}},{\"name\":\"second\",\"value\":\"val2\",\"attributes\":{}}],\"headers\":{\"header1\":[\"h1val1\",\"h1val2\"],\"header2\":[\"h2val1\"]},\"method\":\"PATCH\",\"queryString\":\"foo=bar\",\"url\":\"http://example.com/foo\"}";
           SavedRequest request = SavedRequest.fromJson(json);
   
           assertNotNull(request);
           assertEquals(2, request.getCookies().length);
           assertEquals("first", request.getCookies()[0].getName());
           assertEquals("val1", request.getCookies()[0].getValue());
           assertEquals("second", request.getCookies()[1].getName());
           assertEquals("val2", request.getCookies()[1].getValue());
           assertEquals(2, request.getHeaders().size());
           assertEquals(List.of("h1val1", "h1val2"), request.getHeaders().get("header1"));
           assertEquals(List.of("h2val1"), request.getHeaders().get("header2"));
           assertEquals("PATCH", request.getMethod());
           assertEquals("foo=bar", request.getQueryString());
           assertEquals("http://example.com/foo", request.getUrl());
           // parameterMap should be initialized to a safe default (e.g., empty map) rather than null
           assertNotNull(request.getParameterMap());
           assertTrue(request.getParameterMap().isEmpty());
       }
   
       @Test
   ```



##########
tomee/tomee-security/src/main/java/org/apache/tomee/security/http/SavedRequest.java:
##########
@@ -132,6 +130,27 @@ public StringBuffer getRequestURL() {
             public String getQueryString() {
                 return queryString;
             }
+
+            @Override
+            public Enumeration<String> getParameterNames() {
+                return Collections.enumeration(parameterMap.keySet());
+            }
+
+            @Override
+            public String[] getParameterValues(String name) {
+                return parameterMap.get(name);
+            }
+
+            @Override
+            public String getParameter(String name) {

Review Comment:
   The parameterMap field is accessed without null checking. This will cause a NullPointerException when deserializing JSON from older versions that don't include the parameterMap field. The headers field follows a null-safe pattern (see lines 98, 103, 112) that should be applied here as well. Consider returning Collections.emptyEnumeration() when parameterMap is null.
   ```suggestion
                   return parameterMap != null
                           ? Collections.enumeration(parameterMap.keySet())
                           : Collections.emptyEnumeration();
               }
   
               @Override
               public String[] getParameterValues(String name) {
                   return parameterMap != null ? parameterMap.get(name) : null;
               }
   
               @Override
               public String getParameter(String name) {
                   if (parameterMap == null) {
                       return null;
                   }
   ```



##########
tomee/tomee-security/src/main/java/org/apache/tomee/security/http/SavedRequest.java:
##########
@@ -132,6 +130,27 @@ public StringBuffer getRequestURL() {
             public String getQueryString() {
                 return queryString;
             }
+
+            @Override
+            public Enumeration<String> getParameterNames() {
+                return Collections.enumeration(parameterMap.keySet());
+            }
+
+            @Override
+            public String[] getParameterValues(String name) {
+                return parameterMap.get(name);
+            }
+
+            @Override
+            public String getParameter(String name) {

Review Comment:
   The parameterMap field is accessed without null checking. When parameterMap is null (e.g., when deserializing old JSON), calling parameterMap.get(name) will throw a NullPointerException. Add a null check: if parameterMap is null, return null directly.
   ```suggestion
               public Enumeration<String> getParameterNames() {
                   if (parameterMap == null) {
                       return Collections.emptyEnumeration();
                   }
                   return Collections.enumeration(parameterMap.keySet());
               }
   
               @Override
               public String[] getParameterValues(String name) {
                   if (parameterMap == null) {
                       return null;
                   }
                   return parameterMap.get(name);
               }
   
               @Override
               public String getParameter(String name) {
                   if (parameterMap == null) {
                       return null;
                   }
   ```



##########
tomee/tomee-security/src/main/java/org/apache/tomee/security/http/SavedRequest.java:
##########
@@ -132,6 +130,27 @@ public StringBuffer getRequestURL() {
             public String getQueryString() {
                 return queryString;
             }
+
+            @Override
+            public Enumeration<String> getParameterNames() {
+                return Collections.enumeration(parameterMap.keySet());
+            }
+
+            @Override
+            public String[] getParameterValues(String name) {
+                return parameterMap.get(name);
+            }
+
+            @Override
+            public String getParameter(String name) {
+                String[] values = parameterMap.get(name);
+                return values == null || values.length == 0 ? null : values[0];
+            }
+
+            @Override
+            public Map<String, String[]> getParameterMap() {
+                return parameterMap;

Review Comment:
   The parameterMap field is accessed without null checking. When parameterMap is null (e.g., when deserializing old JSON), this will return null directly. Consider adding a null check similar to the pattern used for headers (lines 103, 112) to return null when parameterMap is null or an empty array when the parameter doesn't exist.
   ```suggestion
                   return parameterMap != null
                           ? Collections.enumeration(parameterMap.keySet())
                           : Collections.emptyEnumeration();
               }
   
               @Override
               public String[] getParameterValues(String name) {
                   if (parameterMap == null) {
                       return null;
                   }
                   String[] values = parameterMap.get(name);
                   return values != null ? values : new String[0];
               }
   
               @Override
               public String getParameter(String name) {
                   if (parameterMap == null) {
                       return null;
                   }
                   String[] values = parameterMap.get(name);
                   return values == null || values.length == 0 ? null : values[0];
               }
   
               @Override
               public Map<String, String[]> getParameterMap() {
                   return parameterMap != null ? parameterMap : Collections.emptyMap();
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tomee.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] TOMEE-4584 - OpenIdAuthenticationMechanism store parameterMap (tomee)

Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2472:
URL: https://github.com/apache/tomee/pull/2472#discussion_r2894115555


##########
tomee/tomee-security/src/main/java/org/apache/tomee/security/http/SavedRequest.java:
##########
@@ -184,6 +203,14 @@ public void setQueryString(String queryString) {
         this.queryString = queryString;
     }
 
+    public Map<String, String[]> getParameterMap() {
+        return parameterMap;
+    }
+
+    public void setParameterMap(Map<String, String[]> parameterMap) {
+        this.parameterMap = parameterMap;

Review Comment:
   `SavedRequest.getParameterMap()` can return null (e.g., when deserializing JSON produced by older versions without the `parameterMap` field), but the updated tests and the `mask()` wrapper logic assume a safe default. Consider returning an empty map when `parameterMap` is null and/or initializing `parameterMap` to `Collections.emptyMap()` during `fromJson()`/deserialization to avoid NPEs and ensure backward compatibility.
   ```suggestion
           return parameterMap != null ? parameterMap : Collections.emptyMap();
       }
   
       public void setParameterMap(Map<String, String[]> parameterMap) {
           this.parameterMap = parameterMap != null ? parameterMap : Collections.emptyMap();
   ```



##########
tomee/tomee-security/src/main/java/org/apache/tomee/security/http/SavedRequest.java:
##########
@@ -56,25 +56,23 @@ public class SavedRequest implements Serializable {
     private String method;
     private String url;
     private String queryString;
+    private Map<String, String[]> parameterMap;
 
     public static SavedRequest fromRequest(HttpServletRequest request) {
-        Cookie[] cookies = request.getCookies();
         Map<String, List<String>> headers = new HashMap<>();
         Enumeration<String> headerNames = request.getHeaderNames();
         while (headerNames.hasMoreElements()) {
             String name = headerNames.nextElement();
             headers.put(name, Collections.list(request.getHeaders(name)));
         }
 
-        String method = request.getMethod();
-        String queryString = request.getQueryString();
-
         SavedRequest result = new SavedRequest();
-        result.setCookies(cookies);
+        result.setCookies(request.getCookies());
         result.setHeaders(headers);
-        result.setMethod(method);
+        result.setMethod(request.getMethod());
         result.setUrl(request.getRequestURL().toString());
-        result.setQueryString(queryString);
+        result.setQueryString(request.getQueryString());
+        result.setParameterMap(request.getParameterMap());
 

Review Comment:
   `fromRequest()` stores `request.getParameterMap()` directly into the session-serializable `SavedRequest`. The Servlet API doesn’t guarantee the returned `Map` implementation is `Serializable` (and it can be a live, container-specific view), which can cause session passivation/replication failures or unexpected mutation. Prefer making a defensive, `Serializable` copy (and ideally cloning the `String[]` values) before storing it.
   ```suggestion
   
           // Make a defensive, serializable copy of the parameter map
           Map<String, String[]> originalParameterMap = request.getParameterMap();
           Map<String, String[]> copiedParameterMap = new HashMap<>(originalParameterMap.size());
           for (Map.Entry<String, String[]> entry : originalParameterMap.entrySet()) {
               String key = entry.getKey();
               String[] value = entry.getValue();
               copiedParameterMap.put(key, value != null ? value.clone() : null);
           }
           result.setParameterMap(copiedParameterMap);
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tomee.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] TOMEE-4584 - OpenIdAuthenticationMechanism store parameterMap (tomee)

Posted by "jungm (via GitHub)" <gi...@apache.org>.
jungm merged PR #2472:
URL: https://github.com/apache/tomee/pull/2472


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tomee.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org