Skip to content

Commit

Permalink
Makes HttpParameters case-insensitive
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszlenart committed Dec 4, 2023
1 parent 649db4d commit 162e29f
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 8 deletions.
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -25,20 +25,22 @@
import java.util.Comparator; import java.util.Comparator;
import java.util.HashMap; import java.util.HashMap;
import java.util.HashSet; import java.util.HashSet;
import java.util.Iterator;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.TreeMap; import java.util.TreeMap;
import java.util.TreeSet; import java.util.TreeSet;


@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public class HttpParameters implements Map<String, Parameter>, Cloneable { public class HttpParameters implements Map<String, Parameter> {


private Map<String, Parameter> parameters; private Map<String, Parameter> parameters;


private HttpParameters(Map<String, Parameter> parameters) { private HttpParameters(Map<String, Parameter> parameters) {
this.parameters = parameters; this.parameters = parameters;
} }


@SuppressWarnings("rawtypes")
public static Builder create(Map requestParameterMap) { public static Builder create(Map requestParameterMap) {
return new Builder(requestParameterMap); return new Builder(requestParameterMap);
} }
Expand All @@ -49,7 +51,15 @@ public static Builder create() {


public HttpParameters remove(Set<String> paramsToRemove) { public HttpParameters remove(Set<String> paramsToRemove) {
for (String paramName : paramsToRemove) { for (String paramName : paramsToRemove) {
parameters.remove(paramName); String paramNameLowerCase = paramName.toLowerCase();
Iterator<Entry<String, Parameter>> iterator = parameters.entrySet().iterator();

while (iterator.hasNext()) {
Map.Entry<String, Parameter> entry = iterator.next();
if (entry.getKey().equalsIgnoreCase(paramNameLowerCase)) {
iterator.remove();
}
}
} }
return this; return this;
} }
Expand All @@ -61,7 +71,17 @@ public HttpParameters remove(final String paramToRemove) {
} }


public boolean contains(String name) { public boolean contains(String name) {
return parameters.containsKey(name); boolean found = false;
String nameLowerCase = name.toLowerCase();

for (String key : parameters.keySet()) {
if (key.equalsIgnoreCase(nameLowerCase)) {
found = true;
break;
}
}

return found;
} }


/** /**
Expand All @@ -78,7 +98,14 @@ public Map<String, String[]> toMap() {
return result; return result;
} }


/**
* Appends all the parameters by overriding any existing params in a case-insensitive manner
*
* @param newParams A new params to append
* @return a current instance of {@link HttpParameters}
*/
public HttpParameters appendAll(Map<String, Parameter> newParams) { public HttpParameters appendAll(Map<String, Parameter> newParams) {
remove(newParams.keySet());
parameters.putAll(newParams); parameters.putAll(newParams);
return this; return this;
} }
Expand Down Expand Up @@ -109,11 +136,15 @@ public boolean containsValue(Object value) {


@Override @Override
public Parameter get(Object key) { public Parameter get(Object key) {
if (parameters.containsKey(key)) { if (key != null && contains(String.valueOf(key))) {
return parameters.get(key); String keyString = String.valueOf(key).toLowerCase();
} else { for (Map.Entry<String, Parameter> entry : parameters.entrySet()) {
return new Parameter.Empty(String.valueOf(key)); if (entry.getKey() != null && entry.getKey().equalsIgnoreCase(keyString)) {
return entry.getValue();
}
}
} }
return new Parameter.Empty(String.valueOf(key));
} }


@Override @Override
Expand Down Expand Up @@ -206,7 +237,7 @@ public HttpParameters build() {
* Alternate Builder method which avoids wrapping any parameters that are already * Alternate Builder method which avoids wrapping any parameters that are already
* a {@link Parameter} element within another {@link Parameter} wrapper. * a {@link Parameter} element within another {@link Parameter} wrapper.
* *
* @return * @return
*/ */
public HttpParameters buildNoNestedWrapping() { public HttpParameters buildNoNestedWrapping() {
Map<String, Parameter> parameters = (parent == null) Map<String, Parameter> parameters = (parent == null)
Expand Down
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.struts2.dispatcher;

import org.junit.Test;

import java.util.HashMap;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

public class HttpParametersTest {

@Test
public void shouldGetBeCaseInsensitive() {
// given
HttpParameters params = HttpParameters.create(new HashMap<String, Object>() {{
put("param1", "value1");
}}).build();

// then
assertEquals("value1", params.get("Param1").getValue());
assertEquals("value1", params.get("paraM1").getValue());
assertEquals("value1", params.get("pAraM1").getValue());
}

@Test
public void shouldAppendSameParamsIgnoringCase() {
// given
HttpParameters params = HttpParameters.create(new HashMap<String, Object>() {{
put("param1", "value1");
}}).build();

// when
assertEquals("value1", params.get("param1").getValue());

params = params.appendAll(HttpParameters.create(new HashMap<String, String>() {{
put("Param1", "Value1");
}}).build());

// then
assertTrue(params.contains("param1"));
assertTrue(params.contains("Param1"));

assertEquals("Value1", params.get("param1").getValue());
assertEquals("Value1", params.get("Param1").getValue());
}

}

0 comments on commit 162e29f

Please sign in to comment.