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.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 * @since 1.1
034 */
035public class ServletConfiguration extends BaseWebConfiguration
036{
037    /** Stores a reference to the wrapped {@code ServletConfig}.*/
038    protected ServletConfig config;
039
040    /**
041     * Create a ServletConfiguration using the initialization parameter of
042     * the specified servlet.
043     *
044     * @param servlet the servlet
045     */
046    public ServletConfiguration(final Servlet servlet)
047    {
048        this(servlet.getServletConfig());
049    }
050
051    /**
052     * Create a ServletConfiguration using the servlet initialization parameters.
053     *
054     * @param config the servlet configuration
055     */
056    public ServletConfiguration(final ServletConfig config)
057    {
058        this.config = config;
059    }
060
061    @Override
062    protected Object getPropertyInternal(final String key)
063    {
064        return handleDelimiters(config.getInitParameter(key));
065    }
066
067    @Override
068    protected Iterator<String> getKeysInternal()
069    {
070        // According to the documentation of getInitParameterNames() the
071        // enumeration is of type String.
072        final Enumeration<String> en = config.getInitParameterNames();
073        return Collections.list(en).iterator();
074    }
075}