io.helidon.config.PrefixedConfigSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-config Show documentation
Configuration Core module.
There is a newer version: 4.1.1
/*
 * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * Licensed 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 io.helidon.config;

import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;

import io.helidon.config.spi.ConfigContent;
import io.helidon.config.spi.ConfigContext;
import io.helidon.config.spi.ConfigNode;
import io.helidon.config.spi.ConfigSource;
import io.helidon.config.spi.EventConfigSource;
import io.helidon.config.spi.NodeConfigSource;
import io.helidon.config.spi.RetryPolicy;

/**
 * {@link ConfigSource} implementation wraps another config source and add key prefix to original one.
 * Only supports "eager" config sources, such as {@link io.helidon.config.spi.ParsableSource}
 *  and {@link io.helidon.config.spi.NodeConfigSource}.
 *
 * @see io.helidon.config.ConfigSources#prefixed(String, java.util.function.Supplier)
 */
public final class PrefixedConfigSource implements ConfigSource,
                                                   NodeConfigSource,
                                                   EventConfigSource {
    private static final String KEY_KEY = "key";

    private final String key;
    private final ConfigSource source;
    private BiConsumer listener;
    private ConfigSourceRuntime sourceRuntime;

    private PrefixedConfigSource(String key, ConfigSource source) {
        Objects.requireNonNull(key, "key cannot be null");
        Objects.requireNonNull(source, "source cannot be null");

        this.key = key;
        this.source = source;
    }

    /**
     * Create a prefixed config source from meta configuration.
     * The meta configuration must contain the configuration key {@value #KEY_KEY}
     *  and meta configuration of another config source to be prefixed with the key.
     *
     * @param metaConfig meta configuration
     * @return a new prefixed config source
     */
    public static PrefixedConfigSource create(Config metaConfig) {
        String prefix = metaConfig.get(KEY_KEY).asString().orElse("");
        ConfigSource configSource = MetaConfig.configSource(metaConfig).get(0);

        return create(prefix, configSource);
    }

    /**
     * Create a new prefixed config source.
     *
     * @param key    prefix key
     * @param source wrapped source
     * @return a new prefixed config source
     */
    public static PrefixedConfigSource create(String key, ConfigSource source) {
        return new PrefixedConfigSource(key, source);
    }

    @Override
    public void init(ConfigContext context) {
        this.sourceRuntime = context.sourceRuntime(source);
    }

    @Override
    public String description() {
        return String.format("prefixed[%s]:%s", key, source.description());
    }

    @Override
    public Optional load() throws ConfigException {
        sourceRuntime.onChange((key, config) -> listener.accept(key, config));

        return sourceRuntime.load()
                .map(originRoot -> ConfigContent.NodeContent.builder()
                        .node(new ObjectNodeBuilderImpl().addObject(key, originRoot).build())
                        .build());
    }

    @Override
    public void onChange(BiConsumer changedNode) {
        this.listener = changedNode;
    }

    @Override
    public boolean exists() {
        return source.exists();
    }

    @Override
    public Optional retryPolicy() {
        return source.retryPolicy();
    }

    @Override
    public boolean optional() {
        return source.optional();
    }
}