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