org.restheart.graal.PluginsReflectionRegistrationFeature Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restheart-core Show documentation
RESTHeart Core - Core services for RESTHeart
The newest version!
/*-
 * ========================LICENSE_START=================================
 * restheart-core
 * %%
 * Copyright (C) 2014 - 2024 SoftInstigate
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 * =========================LICENSE_END==================================
 */
/** WIP
 * Automate reflect configuratio currently done via GenerateGraalvmReflectConfig
 *
 */

package org.restheart.graal;

import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.stream.Collectors;

import org.graalvm.nativeimage.hosted.Feature;
import org.graalvm.nativeimage.hosted.RuntimeReflection;
import org.restheart.plugins.Inject;
import org.restheart.plugins.OnInit;
import org.restheart.plugins.PluginsScanner;

/**
 * Automates reflection configuration of plugins for native-image builds
 *
 * @see https://www.graalvm.org/latest/reference-manual/native-image/dynamic-features/Reflection/#configuration-with-features
 */
public class PluginsReflectionRegistrationFeature implements Feature {
    @Override
    public void beforeAnalysis(BeforeAnalysisAccess access) {
        PluginsScanner.allPluginsClassNames().stream()
                .map(this::clazz)
                .filter(c -> c != null)
                .forEach(this::registerAll);
    }

    private Class clazz(String clazzName) {
        try {
            return Class.forName(clazzName, false, this.getClass().getClassLoader());
        } catch (ClassNotFoundException cfe) {
            return null;
        }
    }

    @Override
    public String getDescription() {
        return "Automates reflection configuration of RESTHeart plugins for native-image builds";
    }

    /**
     * register the plugin for runtime reflection
     *
     * @param clazz
     */
    private void registerAll(Class clazz) {
        RuntimeReflection.register(clazz);
        RuntimeReflection.registerForReflectiveInstantiation(clazz);
        RuntimeReflection.register(annotated(clazz.getDeclaredFields()));
        RuntimeReflection.register(annotated(clazz.getDeclaredMethods()));
    }

    /**
     * selects fields annotated with @Inject
     *
     * @param fields
     * @return an array of fileds that are annotated with @Inject
     */
    private Field[] annotated(Field... fields) {
        var list = Arrays.stream(fields)
                .filter((f -> f.getAnnotation(Inject.class) != null))
                .collect(Collectors.toList());

        return list.toArray(Field[]::new);
    }

    /**
     * selects methods annotated with @OnInit
     *
     * @param fields
     * @return an array of methods that are annotated
     *         with @OnInit, @InjectMongoClient, @InjectConfiguration, @InjectPluginsRegistry
     */
    private Method[] annotated(Method... methods) {
        var list = Arrays.stream(methods)
                .filter(m -> m.getAnnotation(OnInit.class) != null)
                .collect(Collectors.toList());

        return list.toArray(Method[]::new);
    }
}