org.apache.camel.util.OrderedLocationProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-util Show documentation
The Camel Utilities
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.util;

import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

/**
 * An {@link OrderedProperties} that also keeps track from which location the properties are sourced from, and default
 * values.
 *
 * This can be used to track all the various sources for configuration that a Camel application uses (properties file,
 * ENV variables, hardcoded in java, spring-boot, quarkus, camel-k modeline, camel-yaml-dsl etc.
 *
 * Important: Use the put method that takes location as argument to store location information, and the put
 * method that takes default value as argument to store default value information.
 */
public final class OrderedLocationProperties extends BaseOrderedProperties {

    private final Map locations = new HashMap<>();
    private final Map defaultValues = new HashMap<>();

    public void put(String location, Object key, Object value) {
        locations.put(key, location);
        put(key, value);
    }

    public void put(String location, Object key, Object value, Object defaultValue) {
        put(location, key, value);
        if (defaultValue != null) {
            defaultValues.put(key, defaultValue);
        }
    }

    public void putAll(OrderedLocationProperties other) {
        for (var entry : other.entrySet()) {
            put(other.getLocation(entry.getKey()), entry.getKey(), entry.getValue(), other.getDefaultValue(entry.getKey()));
        }
    }

    public void putAll(String location, Map map) {
        for (var entry : map.entrySet()) {
            put(location, entry.getKey(), entry.getValue());
        }
    }

    public void putAll(String location, Properties properties) {
        for (var entry : properties.entrySet()) {
            put(location, entry.getKey(), entry.getValue());
        }
    }

    /**
     * Gets the location from where the property was resolved
     *
     * @param  key the property key
     * @return     the location, or null if not possible to determine the location.
     */
    public String getLocation(Object key) {
        return locations.get(key);
    }

    /**
     * Gets the default value of the property, if a default value exists
     *
     * @param  key the property key
     * @return     the default value, or null if not possible to determine the default value.
     */
    public Object getDefaultValue(Object key) {
        return defaultValues.get(key);
    }

    @Override
    public void clear() {
        lock.lock();
        try {
            locations.clear();
            defaultValues.clear();
            super.clear();
        } finally {
            lock.unlock();
        }
    }

    @Override
    public Object remove(Object key) {
        lock.lock();
        try {
            locations.remove(key);
            defaultValues.remove(key);
            return super.remove(key);
        } finally {
            lock.unlock();
        }
    }
}