io.stallion.plugins.StallionJavaPlugin.java Source code

Introduction

Here is the source code for io.stallion.plugins.StallionJavaPlugin.java

Source

/*
 * Stallion Core: A Modern Web Framework
 *
 * Copyright (C) 2015 - 2016 Stallion Software LLC.
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 2 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 General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/gpl-2.0.html>.
 *
 *
 *
 */

package io.stallion.plugins;

import io.stallion.boot.CommandOptionsBase;
import io.stallion.boot.ServeCommandOptions;
import io.stallion.boot.StallionRunAction;
import io.stallion.dataAccess.DataAccessRegistry;
import io.stallion.dataAccess.ModelBase;
import io.stallion.dataAccess.DataAccessRegistration;
import io.stallion.hooks.HookRegistry;
import io.stallion.hooks.ChainedHook;
import io.stallion.hooks.HookHandler;
import io.stallion.restfulEndpoints.RestEndpointBase;
import io.stallion.restfulEndpoints.EndpointsRegistry;
import io.stallion.restfulEndpoints.EndpointResource;
import io.stallion.restfulEndpoints.JavaRestEndpoint;
import io.stallion.restfulEndpoints.ResourceToEndpoints;
import io.stallion.services.Log;
import io.stallion.utils.ResourceHelpers;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.handler.HandlerCollection;

import java.io.IOException;
import java.net.URL;
import java.util.Collections;
import java.util.List;

import static io.stallion.utils.Literals.UTF8;
import static io.stallion.utils.Literals.empty;
import static io.stallion.utils.Literals.list;

public abstract class StallionJavaPlugin {
    private PluginRegistry pluginRegistry;

    public abstract String getPluginName();

    public List<String> getSqlMigrations() {
        URL resource = getClass().getResource("/sql/migrations.txt");
        if (resource != null) {
            try {
                List<String> migrations = list();
                Log.fine("Found /sql/migrations file for plugin {0}", getClass().getCanonicalName());
                for (String migration : IOUtils.toString(resource, UTF8).split("\\n")) {
                    migration = StringUtils.strip(migration);
                    if (migration.startsWith("#") || migration.startsWith("//")) {
                        continue;
                    }
                    if (!empty(migration)) {
                        migrations.add(migration);
                    }
                }
                return migrations;
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
        return list();
    }

    public void preExecuteAction(String action, CommandOptionsBase options) {

    }

    /**
     * Get a list of available actions
     *
     * @return
     */
    public List<? extends StallionRunAction> getActions() {
        return Collections.EMPTY_LIST;
    }

    /**
     *  Override this to implement configuring this plugin via the command-line.
     */
    public void commandlineConfigure() {
        System.out.println("No special configuration needed for this plugin.");
    }

    /**
     * The main method that gets called to load the plugin -- do everything here,
     * such as loading controllers, loading endpoints, etc.
     *
     * @throws Exception
     */
    public abstract void boot() throws Exception;

    /**
     * This gets called after plugin load, when Stallion is running as an actual
     * web server. Specifically, this gets called by AppContextLoader.startAllServices().
     * Override this if there are background services that do not need
     * to be run when executing most Stallion actions, but do need to be run
     * when running a script action.
     *
     */
    public void startServices() {

    }

    public void preStartJetty(Server server, HandlerCollection handlerCollection, ServeCommandOptions options) {

    }

    public void postStartJetty(Server server, ServeCommandOptions options) {

    }

    /**
     * Called by AppContextLoader.startServicesForTests(), which is called when loading
     * an app context via the BaseIntegrationTestCase JUnit test case base class.
     *
     */
    public void startServicesForTests() {

    }

    /**
     * Override this to shutdown services when the Stallion AppContext shutsdown
     */
    public void shutdownJetty(Server server) {

    }

    /**
     * Override this to shutdown services when the Stallion AppContext shutsdown
     */
    public void shutdown() {

    }

    public void bootForPackage(String packagePath) {

        // TODO: use the Reflect library to find all classes matching each giving interface, insantiate, and load them
    }

    public void setPluginRegistry(PluginRegistry pluginRegistry) {
        this.pluginRegistry = pluginRegistry;
    }
}