001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.lookup;
018
019import java.util.Map;
020import java.util.Properties;
021
022/**
023 * {@link RuntimeStrSubstitutor} is a {@link StrSubstitutor} which only supports recursive evaluation of lookups.
024 * This can be dangerous when combined with user-provided inputs, and should only be used on data directly from
025 * a configuration.
026 */
027public final class ConfigurationStrSubstitutor extends StrSubstitutor {
028
029    public ConfigurationStrSubstitutor() {
030    }
031
032    public ConfigurationStrSubstitutor(final Map<String, String> valueMap) {
033        super(valueMap);
034    }
035
036    public ConfigurationStrSubstitutor(final Properties properties) {
037        super(properties);
038    }
039
040    public ConfigurationStrSubstitutor(final StrLookup lookup) {
041        super(lookup);
042    }
043
044    public ConfigurationStrSubstitutor(final StrSubstitutor other) {
045        super(other);
046    }
047
048    @Override
049    boolean isRecursiveEvaluationAllowed() {
050        return true;
051    }
052
053    @Override
054    void setRecursiveEvaluationAllowed(final boolean recursiveEvaluationAllowed) {
055        throw new UnsupportedOperationException(
056                "recursiveEvaluationAllowed cannot be modified within ConfigurationStrSubstitutor");
057    }
058
059    @Override
060    public String toString() {
061        return "ConfigurationStrSubstitutor{" + super.toString() + "}";
062    }
063}