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 java.util.ArrayList;
021import java.util.Collection;
022import java.util.Iterator;
023import java.util.List;
024import java.util.Map;
025
026import javax.servlet.ServletRequest;
027
028/**
029 * A configuration wrapper to read the parameters of a servlet request. This configuration is read only, adding or
030 * removing a property will throw an UnsupportedOperationException.
031 *
032 * @since 1.1
033 */
034public class ServletRequestConfiguration extends BaseWebConfiguration {
035    /** Stores the wrapped request. */
036    protected ServletRequest request;
037
038    /**
039     * Create a ServletRequestConfiguration using the request parameters.
040     *
041     * @param request the servlet request
042     */
043    public ServletRequestConfiguration(final ServletRequest request) {
044        this.request = request;
045    }
046
047    @Override
048    protected Object getPropertyInternal(final String key) {
049        final String[] values = request.getParameterValues(key);
050
051        if (values == null || values.length == 0) {
052            return null;
053        }
054        if (values.length == 1) {
055            return handleDelimiters(values[0]);
056        }
057        // ensure that escape characters in all list elements are removed
058        final List<Object> result = new ArrayList<>(values.length);
059        for (final String value : values) {
060            final Object val = handleDelimiters(value);
061            if (val instanceof Collection) {
062                result.addAll((Collection<?>) val);
063            } else {
064                result.add(val);
065            }
066        }
067        return result;
068    }
069
070    @Override
071    protected Iterator<String> getKeysInternal() {
072        // According to the documentation of getParameterMap(), keys are Strings.
073        final Map<String, ?> parameterMap = request.getParameterMap();
074        return parameterMap.keySet().iterator();
075    }
076}