fish.payara.microprofile.openapi.impl.config.OpenApiConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-client Show documentation
Appclient for Payara Server
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2018-2023] Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.microprofile.openapi.impl.config;

import static java.util.stream.Collectors.toSet;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.ConfigProvider;
import org.eclipse.microprofile.openapi.OASFilter;
import org.eclipse.microprofile.openapi.OASModelReader;
import org.glassfish.hk2.classmodel.reflect.Type;

import fish.payara.microprofile.openapi.impl.model.media.SchemaImpl;
import java.util.Optional;

public class OpenApiConfiguration {

    private static final Logger LOGGER = Logger.getLogger(OpenApiConfiguration.class.getName());

    private static final String MODEL_READER_KEY = "mp.openapi.model.reader";
    private static final String FILTER_KEY = "mp.openapi.filter";
    private static final String SCAN_LIB_KEY = "mp.openapi.extensions.scan.lib";
    private static final String SCAN_DISABLE_KEY = "mp.openapi.scan.disable";
    private static final String SCAN_PACKAGES_KEY = "mp.openapi.scan.packages";
    private static final String SCAN_CLASSES_KEY = "mp.openapi.scan.classes";
    private static final String SCAN_EXCLUDE_PACKAGES_KEY = "mp.openapi.scan.exclude.packages";
    private static final String SCAN_EXCLUDE_CLASSES_KEY = "mp.openapi.scan.exclude.classes";
    private static final String SERVERS_KEY = "mp.openapi.servers";
    private static final String PATH_PREFIX_KEY = "mp.openapi.servers.path.";
    private static final String OPERATION_PREFIX_KEY = "mp.openapi.servers.operation.";
    private static final String SCHEMA_DEFINITIONS_PREFIX_KEY = "mp.openapi.schema.";

    private Class modelReader;
    private Class filter;
    private boolean scanDisable = false;
    private boolean scanLib = false;
    private List scanPackages = new ArrayList<>();
    private List scanClasses = new ArrayList<>();
    private List scanExcludePackages = new ArrayList<>();
    private List scanExcludeClasses = new ArrayList<>();
    private List servers = new ArrayList<>();
    private Map> pathServerMap = new HashMap<>();
    private Map> operationServerMap = new HashMap<>();
    private Map schemaMap = new HashMap<>();

    public OpenApiConfiguration(ClassLoader applicationClassLoader) {
        // Find the correct configuration instance
        if (applicationClassLoader == null) {
            applicationClassLoader = getClass().getClassLoader();
        }
        Config config = ConfigProvider.getConfig(applicationClassLoader);

        // Find each variable
        for (String propertyName : config.getPropertyNames()) {
            parseModelReader(propertyName, config);
            parseFilter(propertyName, config);
            parseScanDisable(propertyName, config);
            parseScanLib(propertyName, config);
            parseScanPackages(propertyName, config);
            parseScanClasses(propertyName, config);
            parseExcludePackages(propertyName, config);
            parseExcludeClasses(propertyName, config);
            parseServers(propertyName, config);
            parsePathServer(propertyName, config);
            parseOperationServer(propertyName, config);
            parseSchema(propertyName, config);
        }
    }

    /**
     * @return the {@link OASModelReader} class provided by the application.
     */
    public Class getModelReader() {
        return modelReader;
    }

    /**
     * @return the {@link OASFilter} class provided by the application.
     */
    public Class getFilter() {
        return filter;
    }

    /**
     * @return whether to disable application scanning.
     */
    public boolean getScanDisable() {
        return scanDisable;
    }

    /**
     * @return whether to disable packaged libraries scanning.
     */
    public boolean getScanLib() {
        return scanLib;
    }

    /**
     * @return a list of servers to add to the root document.
     */
    public List getServers() {
        return servers;
    }

    /**
     * @return a map of paths to the servers it contains.
     */
    public Map> getPathServerMap() {
        return pathServerMap;
    }

    /**
     * @return a map of operation ids to the servers it contains.
     */
    public Map> getOperationServerMap() {
        return operationServerMap;
    }

    /**
     * @return a map of schema objects
     */
    public Map getSchemaMap() {
        return schemaMap;
    }

    private void parseModelReader(String propertyName, Config config) {
        if (propertyName.equals(MODEL_READER_KEY)) {
            this.modelReader = parseClass(propertyName, config, "Model Reader", OASModelReader.class);
        }
    }

    private void parseFilter(String propertyName, Config config) {
        if (propertyName.equals(FILTER_KEY)) {
            this.filter = parseClass(propertyName, config, "Filter", OASFilter.class);
        }
    }

    private void parseScanDisable(String propertyName, Config config) {
        if (propertyName.equals(SCAN_DISABLE_KEY)) {
            this.scanDisable = config.getValue(propertyName, Boolean.class);
        }
    }

    private void parseScanLib(String propertyName, Config config) {
        if (propertyName.equals(SCAN_LIB_KEY)) {
            this.scanLib = config.getValue(propertyName, Boolean.class);
        }
    }

    private void parseScanPackages(String propertyName, Config config) {
        if (propertyName.equals(SCAN_PACKAGES_KEY)) {
            this.scanPackages = parseList(propertyName, config);
        }
    }

    private void parseScanClasses(String propertyName, Config config) {
        if (propertyName.equals(SCAN_CLASSES_KEY)) {
            this.scanClasses = parseList(propertyName, config);
        }
    }

    private void parseExcludePackages(String propertyName, Config config) {
        if (propertyName.equals(SCAN_EXCLUDE_PACKAGES_KEY)) {
            this.scanExcludePackages = parseList(propertyName, config);
        }
    }

    private void parseExcludeClasses(String propertyName, Config config) {
        if (propertyName.equals(SCAN_EXCLUDE_CLASSES_KEY)) {
            this.scanExcludeClasses = parseList(propertyName, config);
        }
    }

    private void parseServers(String propertyName, Config config) {
        if (propertyName.equals(SERVERS_KEY)) {
            this.servers = parseList(propertyName, config);
        }
    }

    private void parsePathServer(String propertyName, Config config) {
        if (propertyName.startsWith(PATH_PREFIX_KEY)) {
            final String pathServer = propertyName.replaceFirst(PATH_PREFIX_KEY, "");
            pathServerMap.put(pathServer, parseSet(propertyName, config));
        }
    }

    private void parseOperationServer(String propertyName, Config config) {
        if (propertyName.startsWith(OPERATION_PREFIX_KEY)) {
            final String operationServer = propertyName.replaceFirst(OPERATION_PREFIX_KEY, "");
            operationServerMap.put(operationServer, parseSet(propertyName, config));
        }
    }

    private void parseSchema(String propertyName, Config config) {
        if (propertyName.startsWith(SCHEMA_DEFINITIONS_PREFIX_KEY)) {
            final String schemaName = propertyName.replaceFirst(SCHEMA_DEFINITIONS_PREFIX_KEY, "");
            schemaMap.put(schemaName, config.getValue(propertyName, SchemaImpl.class));
        }
    }

    /**
     * @param types the list of classes to filter.
     * @return a filtered list of classes, using scanClasses,
     *         scanExcludeClasses, scanPackages and scanExcludePackages.
     */
    public Set getValidClasses(Collection types) {
        return types.stream()
                .filter(type -> checkValidity(type.getName()))
                .collect(toSet());
    }

    /**
     * Follow the OpenApi rules for scan inclusions and exclusions.
     *
     * @param type Class name to be checked
     * @return true if the files is to be scanned
     */
    private boolean checkValidity(String type) {
        // A class is not scanned if it's listed in mp.openapi.scan.exclude.classes
        if (scanExcludeClasses.contains(type)) {
            return false;
        }
        // A class is scanned if it's listed in mp.openapi.scan.classes
        if (scanClasses.contains(type)) {
            return true;
        }
        // A class is not scanned if its package, or any of its parent packages
        // are listed in mp.openapi.scan.exclude.packages, unless a more
        // complete package or parent package is listed in
        // mp.openapi.scan.packages
        Optional mostSpecificInclude = scanPackages.stream()
                .filter(pkg -> type.startsWith(pkg))
                // find longest, e.g. most specific package
                .sorted((p1, p2) -> p2.length() - p1.length())
                .findFirst();
        Optional mostSpecificExclude = scanExcludePackages.stream()
                .filter(pkg -> type.startsWith(pkg))
                // find longest, e.g. most specific package
                .sorted((p1, p2) -> p2.length() - p1.length())
                .findFirst();
        if (mostSpecificExclude.isPresent()) {
            if (mostSpecificInclude.isPresent()
                    && mostSpecificInclude.get().length() > mostSpecificExclude.get().length()) {
                // more specific include found, overrides exclude, do nothing now
            } else {
                // most specific exclude
                return false;
            }
        }
        // A class is scanned if its package or any of its parent packages are
        // listed in mp.openapi.scan.packages
        if (mostSpecificInclude.isPresent()) {
            return true;
        }
        // A class is scanned if mp.openapi.scan.classes and
        // mp.openapi.scan.packages are both empty or not set
        return scanClasses.isEmpty() && scanPackages.isEmpty();
    }

    // static Config API convenience methods

    @SuppressWarnings("unchecked")
    private static  Class parseClass(String propertyName, Config config, String className, Class clazz) {
        try {
            return (Class) config.getValue(propertyName, Class.class);
        } catch (NoSuchElementException ex) {
            LOGGER.warning(className + " class not found: " + config.getValue(propertyName, String.class));
        } catch (ClassCastException ex) {
            LOGGER.log(Level.WARNING, className + " class was wrong type: " + config.getValue(propertyName, String.class), ex);
        } catch (Exception ex) {
            LOGGER.log(Level.WARNING, "Failed to read " + className + " class" + config.getValue(propertyName, String.class), ex);
        }
        return null;
    }

    private static List parseList(String propertyName, Config config) {
        return parseCollection(propertyName, config, new ArrayList<>());
    }

    private static Set parseSet(String propertyName, Config config) {
        return parseCollection(propertyName, config, new HashSet<>());
    }

    private static > C parseCollection(String propertyName, Config config, C instance) {
        final String[] array = config.getValue(propertyName, String[].class);
        if (array != null) {
            for (String item : array) {
                instance.add(item.strip()); // Strip because MP TCK uses ", " as separator for array properties
            }
        }
        return instance;
    }

}