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