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.configuration.web;
019
020import java.util.Collections;
021import java.util.Enumeration;
022import java.util.Iterator;
023
024import javax.servlet.Servlet;
025import javax.servlet.ServletConfig;
026
027/**
028 * A configuration wrapper around a {@link ServletConfig}. This configuration
029 * 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 * @version $Id: ServletConfiguration.java 1211128 2011-12-06 20:56:41Z oheger $
034 * @since 1.1
035 */
036public class ServletConfiguration extends BaseWebConfiguration
037{
038    /** Stores a reference to the wrapped {@code ServletConfig}.*/
039    protected ServletConfig config;
040
041    /**
042     * Create a ServletConfiguration using the initialization parameter of
043     * the specified servlet.
044     *
045     * @param servlet the servlet
046     */
047    public ServletConfiguration(Servlet servlet)
048    {
049        this(servlet.getServletConfig());
050    }
051
052    /**
053     * Create a ServletConfiguration using the servlet initialization parameters.
054     *
055     * @param config the servlet configuration
056     */
057    public ServletConfiguration(ServletConfig config)
058    {
059        this.config = config;
060    }
061
062    public Object getProperty(String key)
063    {
064        return handleDelimiters(config.getInitParameter(key));
065    }
066
067    public Iterator<String> getKeys()
068    {
069        // According to the documentation of getInitParameterNames() the
070        // enumeration is of type String.
071        @SuppressWarnings("unchecked")
072        Enumeration<String> en = config.getInitParameterNames();
073        return Collections.list(en).iterator();
074    }
075}