View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.configuration.web;
19  
20  import java.util.Collections;
21  import java.util.Enumeration;
22  import java.util.Iterator;
23  
24  import javax.servlet.Servlet;
25  import javax.servlet.ServletContext;
26  
27  /**
28   * A configuration wrapper to read the initialization parameters of a servlet
29   * context. This configuration is read only, adding or removing a property will
30   * throw an UnsupportedOperationException.
31   *
32   * @author <a href="mailto:ebourg@apache.org">Emmanuel Bourg</a>
33   * @version $Id: ServletContextConfiguration.java 1211129 2011-12-06 20:57:01Z oheger $
34   * @since 1.1
35   */
36  public class ServletContextConfiguration extends BaseWebConfiguration
37  {
38      /** Stores the wrapped servlet context.*/
39      protected ServletContext context;
40  
41      /**
42       * Create a ServletContextConfiguration using the context of
43       * the specified servlet.
44       *
45       * @param servlet the servlet
46       */
47      public ServletContextConfiguration(Servlet servlet)
48      {
49          this.context = servlet.getServletConfig().getServletContext();
50      }
51  
52      /**
53       * Create a ServletContextConfiguration using the servlet context
54       * initialization parameters.
55       *
56       * @param context the servlet context
57       */
58      public ServletContextConfiguration(ServletContext context)
59      {
60          this.context = context;
61      }
62  
63      public Object getProperty(String key)
64      {
65          return handleDelimiters(context.getInitParameter(key));
66      }
67  
68      public Iterator<String> getKeys()
69      {
70          // According to the documentation of getInitParameterNames() the
71          // enumeration is of type String.
72          @SuppressWarnings("unchecked")
73          Enumeration<String> en = context.getInitParameterNames();
74          return Collections.list(en).iterator();
75      }
76  }