View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.commons.configuration.web;
    19
    20  import java.util.ArrayList;
    21  import java.util.Collection;
    22  import java.util.Iterator;
    23  import java.util.List;
    24
    25  import javax.servlet.ServletRequest;
    26
    27  import org.apache.commons.collections.iterators.EnumerationIterator;
    28
    29  /***
    30   * A configuration wrapper to read the parameters of a servlet request. This
    31   * configuration is read only, adding or removing a property will throw an
    32   * UnsupportedOperationException.
    33   *
    34   * @author <a href="mailto:ebourg@apache.org">Emmanuel Bourg</a>
    35   * @version $Revision: 515306 $, $Date: 2007-03-06 22:15:00 +0100 (Di, 06 Mrz 2007) $
    36   * @since 1.1
    37   */
    38  public class ServletRequestConfiguration extends BaseWebConfiguration
    39  {
    40      /*** Stores the wrapped request.*/
    41      protected ServletRequest request;
    42
    43      /***
    44       * Create a ServletRequestConfiguration using the request parameters.
    45       *
    46       * @param request the servlet request
    47       */
    48      public ServletRequestConfiguration(ServletRequest request)
    49      {
    50          this.request = request;
    51      }
    52
    53      public Object getProperty(String key)
    54      {
    55          String[] values = request.getParameterValues(key);
    56
    57          if (values == null || values.length == 0)
    58          {
    59              return null;
    60          }
    61          else if (values.length == 1)
    62          {
    63              return handleDelimiters(values[0]);
    64          }
    65          else
    66          {
    67              // ensure that escape characters in all list elements are removed
    68              List result = new ArrayList(values.length);
    69              for (int i = 0; i < values.length; i++)
    70              {
    71                  Object val = handleDelimiters(values[i]);
    72                  if (val instanceof Collection)
    73                  {
    74                      result.addAll((Collection) val);
    75                  }
    76                  else
    77                  {
    78                      result.add(val);
    79                  }
    80              }
    81              return result;
    82          }
    83      }
    84
    85      public Iterator getKeys()
    86      {
    87          return new EnumerationIterator(request.getParameterNames());
    88      }
    89  }