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 package org.apache.logging.log4j.core.lookup;
18
19 import java.util.Map;
20 import java.util.Properties;
21
22 /**
23 * {@link RuntimeStrSubstitutor} is a {@link StrSubstitutor} which only supports recursive evaluation of lookups.
24 * This can be dangerous when combined with user-provided inputs, and should only be used on data directly from
25 * a configuration.
26 */
27 public final class ConfigurationStrSubstitutor extends StrSubstitutor {
28
29 public ConfigurationStrSubstitutor() {
30 }
31
32 public ConfigurationStrSubstitutor(final Map<String, String> valueMap) {
33 super(valueMap);
34 }
35
36 public ConfigurationStrSubstitutor(final Properties properties) {
37 super(properties);
38 }
39
40 public ConfigurationStrSubstitutor(final StrLookup lookup) {
41 super(lookup);
42 }
43
44 public ConfigurationStrSubstitutor(final StrSubstitutor other) {
45 super(other);
46 }
47
48 @Override
49 boolean isRecursiveEvaluationAllowed() {
50 return true;
51 }
52
53 @Override
54 void setRecursiveEvaluationAllowed(final boolean recursiveEvaluationAllowed) {
55 throw new UnsupportedOperationException(
56 "recursiveEvaluationAllowed cannot be modified within ConfigurationStrSubstitutor");
57 }
58
59 @Override
60 public String toString() {
61 return "ConfigurationStrSubstitutor{" + super.toString() + "}";
62 }
63 }