com.yelstream.topp.standard.microprofile.config.source.DynamicMapConfigSource Maven / Gradle / Ivy

Go to download
/*
 * Project: Topp Standard
 * GitHub: https://github.com/sabroe/Topp-Standard
 *
 * Copyright 2024 Morten Sabroe Mortensen
 *
 * 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 com.yelstream.topp.standard.microprofile.config.source;

import com.yelstream.topp.standard.util.MapBuilders;
import com.yelstream.topp.standard.util.function.MemoizedIntSupplier;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Singular;
import org.eclipse.microprofile.config.spi.ConfigSource;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.IntSupplier;
import java.util.function.Supplier;

/**
 * In-memory configuration-source keeping properties as a {@link Map}.
 * 
 *     Actual properties may be handed over at the time of instantiation and
 *     otherwise created, read, updated or removed during runtime.
 * 
 * 
 *     This may support properties whose value is {@code null} depending upon construction.
 * 
 * 
 *     This may be immutable depending upon construction.
 * 
 * 
 *     This may be thread-safe depending upon construction.
 * 
 *
 * @author Morten Sabroe Mortensen
 * @version 1.0
 * @since 2024-04-15
 */
@AllArgsConstructor(staticName="of",access=AccessLevel.PRIVATE)
public class DynamicMapConfigSource implements ConfigSource {
    /**
     * Name.
     */
    private final Supplier nameSupplier;

    /**
     * Ordinal.
     * 
     *    Note: If the values from this varies at runtime then the configuration-source possibly will not work.
     * 
     */
    private final IntSupplier ordinalSupplier;

    /**
     * Properties held.
     */
    private final AtomicReference> propertiesReference;

    @Override
    public String getName() {
        return nameSupplier.get();
    }

    @Override
    public int getOrdinal() {
        return ordinalSupplier.getAsInt();
    }

    @Override
    public Set getPropertyNames() {
        return propertiesReference.get().keySet();
    }

    @Override
    public String getValue(String propertyName) {
        return propertiesReference.get().get(propertyName);
    }

    @Override
    public Map getProperties() {
        return propertiesReference.get();
    }

    public void replaceProperties(Map properties) {
        propertiesReference.set(properties);
    }

    public static DynamicMapConfigSource of(String name,
                                            int ordinal,
                                            Map properties) {
        properties=properties==null?Map.of():properties;
        AtomicReference> propertiesReference=new AtomicReference<>(properties);
        return of(()->name,()->ordinal,propertiesReference);
    }

    @SuppressWarnings("unused")
    @lombok.Builder(builderClassName="Builder",toBuilder=false)  //Yes, no #toBuilder() wanted!
    private static DynamicMapConfigSource createInstance(Supplier nameSupplier,
                                                         IntSupplier ordinalSupplier,
                                                         @Singular Map properties) {
        AtomicReference> propertiesReference=new AtomicReference<>(properties);
        return of(nameSupplier,ordinalSupplier,propertiesReference);
    }

    @SuppressWarnings({"java:S1068","java:S1450","unused","FieldCanBeLocal","UnusedReturnValue","FieldMayBeFinal"})
    public static class Builder {
        private Supplier nameSupplier=ConfigSources.DEFAULT_NAME_SUPPLIER_FACTORY.get();

        private IntSupplier ordinalSupplier=ConfigSources.DEFAULT_ORDINAL_SUPPLIER;

        private Map properties=new HashMap<>();

        public Builder name(String name) {
            return nameSupplier(()->name);
        }

        public Builder ordinal(int ordinal) {
            return ordinalSupplier(()->ordinal);
        }

        public Builder ordinalSupplierWithStrategy(IntSupplier ordinalSupplier,
                                                   MemoizedIntSupplier.Strategy strategy) {
            return ordinalSupplier(strategy.of(ordinalSupplier));
        }

        public Builder initializeProperties(Map properties) {
            this.properties=properties;
            return this;
        }

        public Builder propertiesBuilder(MapBuilders.MapBuilder mapBuilder) {
            properties=mapBuilder.build();
            return this;
        }

        @SuppressWarnings("java:S1117")
        public MapBuilders.MapBuilder propertiesBuild() {
            MapBuilders.MapBuilder mapBuilder=MapBuilders.mapBuilder();
            mapBuilder.consumer(properties->this.properties=properties);
            return mapBuilder;
        }
    }
}