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