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;
023import java.util.Objects;
024
025import javax.servlet.Servlet;
026import javax.servlet.ServletContext;
027
028/**
029 * A configuration wrapper to read the initialization parameters of a servlet context. This configuration is read only,
030 * adding or removing a property will throw an UnsupportedOperationException.
031 *
032 * @since 1.1
033 */
034public class ServletContextConfiguration extends BaseWebConfiguration {
035
036    /** Stores the wrapped servlet context. */
037    protected ServletContext context;
038
039    /**
040     * Create a ServletContextConfiguration using the context of the specified servlet.
041     *
042     * @param servlet the servlet
043     */
044    public ServletContextConfiguration(final Servlet servlet) {
045        this.context = Objects.requireNonNull(servlet, "servlet").getServletConfig().getServletContext();
046    }
047
048    /**
049     * Create a ServletContextConfiguration using the servlet context initialization parameters.
050     *
051     * @param context the servlet context
052     */
053    public ServletContextConfiguration(final ServletContext context) {
054        this.context = Objects.requireNonNull(context, "context");
055    }
056
057    @Override
058    protected Iterator<String> getKeysInternal() {
059        // According to the documentation of getInitParameterNames() the
060        // enumeration is of type String.
061        final Enumeration<String> en = context.getInitParameterNames();
062        return Collections.list(en).iterator();
063    }
064
065    @Override
066    protected Object getPropertyInternal(final String key) {
067        return handleDelimiters(context.getInitParameter(key));
068    }
069}