001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018package org.apache.commons.configuration2.web; 019 020import javax.servlet.ServletRequest; 021import java.util.ArrayList; 022import java.util.Collection; 023import java.util.Iterator; 024import java.util.List; 025import java.util.Map; 026 027/** 028 * A configuration wrapper to read the parameters of a servlet request. This 029 * configuration is read only, adding or removing a property will throw an 030 * UnsupportedOperationException. 031 * 032 * @author <a href="mailto:ebourg@apache.org">Emmanuel Bourg</a> 033 * @since 1.1 034 */ 035public class ServletRequestConfiguration extends BaseWebConfiguration 036{ 037 /** Stores the wrapped request.*/ 038 protected ServletRequest request; 039 040 /** 041 * Create a ServletRequestConfiguration using the request parameters. 042 * 043 * @param request the servlet request 044 */ 045 public ServletRequestConfiguration(final ServletRequest request) 046 { 047 this.request = request; 048 } 049 050 @Override 051 protected Object getPropertyInternal(final String key) 052 { 053 final String[] values = request.getParameterValues(key); 054 055 if (values == null || values.length == 0) 056 { 057 return null; 058 } 059 else if (values.length == 1) 060 { 061 return handleDelimiters(values[0]); 062 } 063 else 064 { 065 // ensure that escape characters in all list elements are removed 066 final List<Object> result = new ArrayList<>(values.length); 067 for (final String value : values) 068 { 069 final Object val = handleDelimiters(value); 070 if (val instanceof Collection) 071 { 072 result.addAll((Collection<?>) val); 073 } 074 else 075 { 076 result.add(val); 077 } 078 } 079 return result; 080 } 081 } 082 083 @Override 084 protected Iterator<String> getKeysInternal() 085 { 086 // According to the documentation of getParameterMap(), keys are Strings. 087 final Map<String, ?> parameterMap = request.getParameterMap(); 088 return parameterMap.keySet().iterator(); 089 } 090}