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