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