io.streamthoughts.kafka.specs.config.JikkouConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jikkou Show documentation
Show all versions of jikkou Show documentation
A command-line tool to help you automate the management of the configurations that live on your Apache Kafka clusters.
/*
* Copyright 2021 StreamThoughts.
*
* 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 io.streamthoughts.kafka.specs.config;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import com.typesafe.config.ConfigMergeable;
import com.typesafe.config.ConfigParseOptions;
import io.streamthoughts.kafka.specs.internal.ClassUtils;
import io.vavr.control.Option;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Properties;
import java.util.TreeMap;
import java.util.stream.Collectors;
/**
* The default configuration class backed by the Typesafe {@link Config}.
*/
public final class JikkouConfig {
private static final Logger LOG = LoggerFactory.getLogger(JikkouConfig.class);
private static final String DEFAULT_CONFIG = "application.conf";
private static final String ROOT_CONFIG_KEY = "jikkou";
private static JikkouConfig CACHED;
private final Config config;
/**
* Static helper that can be used to create a new empty {@link JikkouConfig} instance.
*
* @return a new {@link JikkouConfig} instance.
*/
public static JikkouConfig empty() {
return new JikkouConfig(ConfigFactory.empty(), false);
}
/**
* Static helper that can be used to create a new {@link JikkouConfig} instance
* from the specified properties.
*
* @return a new {@link JikkouConfig} instance.
*/
public static JikkouConfig create(final Properties config) {
return new JikkouConfig(ConfigFactory.parseProperties(config, ConfigParseOptions.defaults()));
}
/**
* Static helper that can be used to create a new {@link JikkouConfig} instance
* from the specified map.
*
* @return a new {@link JikkouConfig} instance.
*/
public static JikkouConfig create(final Map config) {
return new JikkouConfig(ConfigFactory.parseMap(config));
}
/**
* Retrieves the global static configuration.
*
* @throws IllegalStateException if no configuration was initialized.
* @return the {@link JikkouConfig} configuration object.
*/
public static @NotNull JikkouConfig get() {
if (CACHED != null) return CACHED;
throw new IllegalStateException("No configuration was initialized");
}
/**
* Helper method to get or create a new {@link JikkouConfig} instance.
*
* @param cliConfigParams the config params passed through the command-mine arguments.
* @param cliConfigFile the configFile passed through the command-line arguments.
* @return a new {@link JikkouConfig}
*/
private static JikkouConfig create(final @Nullable Map cliConfigParams,
final @Nullable String cliConfigFile) {
getConfigFile(cliConfigFile).ifPresentOrElse(configFile -> {
LOG.info("Loading configuration from: '{}'", configFile);
System.setProperty("config.file", configFile);
}, () -> LOG.info("No configuration file was found"));
ConfigFactory.invalidateCaches();
Config config = ConfigFactory.load().getConfig(ROOT_CONFIG_KEY);
if (cliConfigParams != null && !cliConfigParams.isEmpty()) {
final Config overridingConfig = ConfigFactory.parseMap(cliConfigParams);
config = overridingConfig.withFallback(config);
}
return new JikkouConfig(config);
}
private static Optional getConfigFile(@Nullable final String clientConfigFile) {
if (clientConfigFile != null && !clientConfigFile.isEmpty())
return Optional.of(clientConfigFile);
Path configFromCurrentRelative = Paths.get(DEFAULT_CONFIG);
if (Files.exists(configFromCurrentRelative)) {
return Optional.of(configFromCurrentRelative.toAbsolutePath().toString());
}
Path configFromUserHome = Paths.get(String.format(
"%s/.%s/%s",
System.getProperty("user.home"),
ROOT_CONFIG_KEY,
DEFAULT_CONFIG)
);
if (Files.exists(configFromUserHome)) {
return Optional.of(configFromUserHome.toAbsolutePath().toString());
}
return Optional.empty();
}
/**
* Creates a new {@link JikkouConfig} instance.
*
* @param config the {@link Config}.
*/
public JikkouConfig(@NotNull final Config config) {
this(config, true);
}
/**
* Creates a new {@link JikkouConfig} instance.
*
* @param config the {@link Config}.
* @param doLog flag indicating if config should be logged.
*/
public JikkouConfig(@NotNull final Config config, final boolean doLog) {
this.config = Objects.requireNonNull(config, "'config' cannot be null");
if (doLog) {
LOG.info("Created new {}:\n\t{}", this.getClass().getName(), toPrettyString());
}
}
/**
* @return the underlying {@link Config} object.
*/
public Config unwrap() {
return config;
}
/**
* @see Config#getString(String)
*/
public String getString(@NotNull final String path) {
return config.getString(path);
}
/**
* @see Config#getString(String)
*/
public Option findString(@NotNull final String path) {
return config.hasPath(path) ? Option.of(config.getString(path)) : Option.none();
}
/**
* @see Config#getBoolean(String)
*/
public boolean getBoolean(@NotNull final String path) {
return config.getBoolean(path);
}
/**
* @see Config#getBoolean(String)
*/
public Option findBoolean(@NotNull final String path) {
return config.hasPath(path) ? Option.of(config.getBoolean(path)) : Option.none();
}
/**
* @see Config#getLong(String)
*/
public long getLong(@NotNull final String path) {
return config.getLong(path);
}
/**
* @see Config#getLong(String)
*/
public Option findLong(@NotNull final String path) {
return config.hasPath(path) ? Option.of(config.getLong(path)) : Option.none();
}
/**
* @see Config#getInt(String)
*/
public int getInt(@NotNull final String path) {
return config.getInt(path);
}
/**
* @see Config#getInt(String)
*/
public Option findInt(@NotNull final String path) {
return config.hasPath(path) ? Option.of(config.getInt(path)) : Option.none();
}
/**
* @see Config#getConfig(String)
*/
public Option findConfig(@NotNull final String path) {
return config.hasPath(path) ? Option.some(new JikkouConfig(config.getConfig(path), false)) : Option.none();
}
/**
* @see Config#getStringList(String)
*/
public Option> findStringList(@NotNull final String path) {
return config.hasPath(path) ? Option.some(config.getStringList(path)) : Option.none();
}
@SuppressWarnings("unchecked")
public Option>> findClassList(@NotNull final String path) {
return findStringList(path).flatMap(classes -> {
var l = classes.stream()
.map(it -> (Class) ClassUtils.forName(it))
.collect(Collectors.toList());
return Option.of(l);
});
}
public Option> findConfigAsMap(@NotNull final String path) {
return findConfig(path).map(JikkouConfig::unwrap).map(JikkouConfig::getConfAsMap);
}
/**
* @see Config#withFallback(ConfigMergeable)
*/
public JikkouConfig withFallback(final JikkouConfig config) {
return new JikkouConfig(this.config.withFallback(config.config), false);
}
private static Map getConfAsMap(@NotNull final Config config) {
Map props = new HashMap<>();
config.entrySet().forEach(e -> props.put(e.getKey(), config.getAnyRef(e.getKey())));
return new TreeMap<>(props);
}
private static Properties getConfAsProperties(@NotNull final Config config) {
Properties properties = new Properties();
config.entrySet().forEach(e -> properties.setProperty(e.getKey(), config.getString(e.getKey())));
return properties;
}
public String toPrettyString() {
Map confAsMap = new TreeMap<>(getConfAsMap(config));
return confAsMap.entrySet()
.stream()
.map(e -> e.getKey() + " = " + e.getValue())
.collect(Collectors.joining("\n\t"));
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String cliConfigFile;
private Map cliConfigParams;
public Builder withCLIConfigFile(final @NotNull String cliConfigFile) {
this.cliConfigFile = cliConfigFile;
return this;
}
public Builder withCLIConfigParams(final @NotNull Map cliConfigParams) {
this.cliConfigParams = cliConfigParams;
return this;
}
public JikkouConfig getOrCreate() {
Option.of(CACHED).onEmpty(() -> CACHED = create(cliConfigParams, cliConfigFile));
return CACHED;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy