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.ServletContext;
026
027/**
028 * A configuration wrapper to read the initialization parameters of a servlet
029 * context. This configuration is read only, adding or removing a property will
030 * throw an UnsupportedOperationException.
031 *
032 * @author <a href="mailto:ebourg@apache.org">Emmanuel Bourg</a>
033 * @version $Id: ServletContextConfiguration.java 1211129 2011-12-06 20:57:01Z oheger $
034 * @since 1.1
035 */
036public class ServletContextConfiguration extends BaseWebConfiguration
037{
038    /** Stores the wrapped servlet context.*/
039    protected ServletContext context;
040
041    /**
042     * Create a ServletContextConfiguration using the context of
043     * the specified servlet.
044     *
045     * @param servlet the servlet
046     */
047    public ServletContextConfiguration(Servlet servlet)
048    {
049        this.context = servlet.getServletConfig().getServletContext();
050    }
051
052    /**
053     * Create a ServletContextConfiguration using the servlet context
054     * initialization parameters.
055     *
056     * @param context the servlet context
057     */
058    public ServletContextConfiguration(ServletContext context)
059    {
060        this.context = context;
061    }
062
063    public Object getProperty(String key)
064    {
065        return handleDelimiters(context.getInitParameter(key));
066    }
067
068    public Iterator<String> getKeys()
069    {
070        // According to the documentation of getInitParameterNames() the
071        // enumeration is of type String.
072        @SuppressWarnings("unchecked")
073        Enumeration<String> en = context.getInitParameterNames();
074        return Collections.list(en).iterator();
075    }
076}