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.configuration2.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 context. This configuration is read only,
29 * adding or removing a property will throw an UnsupportedOperationException.
30 *
31 * @since 1.1
32 */
33 public class ServletContextConfiguration extends BaseWebConfiguration {
34 /** Stores the wrapped servlet context. */
35 protected ServletContext context;
36
37 /**
38 * Create a ServletContextConfiguration using the context of the specified servlet.
39 *
40 * @param servlet the servlet
41 */
42 public ServletContextConfiguration(final Servlet servlet) {
43 this.context = servlet.getServletConfig().getServletContext();
44 }
45
46 /**
47 * Create a ServletContextConfiguration using the servlet context initialization parameters.
48 *
49 * @param context the servlet context
50 */
51 public ServletContextConfiguration(final ServletContext context) {
52 this.context = context;
53 }
54
55 @Override
56 protected Object getPropertyInternal(final String key) {
57 return handleDelimiters(context.getInitParameter(key));
58 }
59
60 @Override
61 protected Iterator<String> getKeysInternal() {
62 // According to the documentation of getInitParameterNames() the
63 // enumeration is of type String.
64 final Enumeration<String> en = context.getInitParameterNames();
65 return Collections.list(en).iterator();
66 }
67 }