org.restheart.plugins.FileConfigurablePlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restheart-commons Show documentation
RESTHeart Commons - Common classes for core components and plugins.
There is a newer version: 8.1.7
/*-
 * ========================LICENSE_START=================================
 * restheart-commons
 * %%
 * Copyright (C) 2019 - 2024 SoftInstigate
 * %%
 * 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.
 * =========================LICENSE_END==================================
 */
package org.restheart.plugins;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;

import org.restheart.configuration.Configuration;
import org.restheart.configuration.ConfigurationException;
import org.slf4j.LoggerFactory;
import org.yaml.snakeyaml.LoaderOptions;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.SafeConstructor;

/**
 * An helper class that simplifies getting the Plugin args from a configuration
 * file.
 *
 * @author Maurizio Turatti {@literal }
 */
abstract public class FileConfigurablePlugin implements ConfigurablePlugin {

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(FileConfigurablePlugin.class);

    public abstract Consumer> consumeConfiguration() throws ConfigurationException;

    /**
     * get the configuration args parsing the file specified in the Plugin argument
     * 'conf-file'
     *
     * @param arguments
     * @param type
     * @throws java.io.FileNotFoundException
     * @throws org.restheart.configuration.ConfigurationException
     */
    @SuppressWarnings("unchecked")
    public void init(Map arguments, String type) throws FileNotFoundException, ConfigurationException {
        InputStream is = null;
        try {
            final String confFilePath = extractConfigFilePath(arguments);
            is = new FileInputStream(new File(java.net.URLDecoder.decode(confFilePath, "utf-8")));

            final Map conf = (Map) new Yaml(new SafeConstructor(new LoaderOptions())).load(is);

            List> confItems = extractConfArgs(conf, type);
            confItems.stream().forEach(consumeConfiguration());
        } catch (FileNotFoundException ex) {
            LOGGER.error("*** cannot find the file {} " + "specified in the configuration.", extractConfigFilePath(arguments));

            LOGGER.error("*** note that the path must be either "
              + "absolute "
              + "or relative to the restheart configuration file (if specified) "
              + "or relative to the plugins directory (if using the default configuration)");
            throw ex;
        } catch (UnsupportedEncodingException uee) {
            throw new RuntimeException(uee);
        } finally {
            try {
                if (is != null) {
                    is.close();
                }
            } catch (IOException ex) {
                LOGGER.warn("Can't close the InputStream", ex);
            }
        }
    }

    /**
     * extract the absolute path of the argument 'conf-file'
     * it can be either an absolute path or relative the restheart configuration file
     * @param arguments
     * @return
     * @throws IllegalArgumentException
     */
    String extractConfigFilePath(Map arguments) throws IllegalArgumentException {
        if (arguments == null) {
            throw new IllegalArgumentException("missing required arguments conf-file");
        }

        Object _confFilePath = arguments.getOrDefault("conf-file", null);

        if (_confFilePath == null || !(_confFilePath instanceof String)) {
            throw new IllegalArgumentException("missing required arguments conf-file");
        }

        Path restheartConfFilePath = Configuration.getPath();

        String confFilePath = (String) _confFilePath;
        if (!confFilePath.startsWith("/")) {
            if (restheartConfFilePath != null) {
                confFilePath = restheartConfFilePath.toAbsolutePath().getParent().resolve(confFilePath).toString();
            } else {
                // this is to allow specifying the configuration file path
                // relative to the jar (also working when running from classes)
                URL location = this.getClass().getProtectionDomain().getCodeSource().getLocation();

                File locationFile = new File(location.getPath());
                confFilePath = locationFile.getParent() + File.separator + confFilePath;
            }
        }
        return confFilePath;
    }

    @SuppressWarnings("unchecked")
    List> extractConfArgs(final Map conf, String type) throws IllegalArgumentException {
        Object args = conf.get(type);

        if (args == null || !(args instanceof List)) {
            throw new IllegalArgumentException("wrong configuration file format. missing mandatory '" + type + "' section.");
        }

        List> users = (List>) args;
        return users;
    }
}