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