io.github.rmuhamedgaliev.Plugin Maven / Gradle / Ivy

Go to download
/*
 *     Copyright 2015 Rinat Muhamedgaliev
 *
 *     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.
 */

package io.github.rmuhamedgaliev;

/**
 * Parent class for all plugin in app
 *
 * @author Rinat Muhamedgaliev
 */
public abstract class Plugin {
//    Name of plugin required for logging of loadded plugins
    private String name;

    /**
     * Method provide ability of run plugin and add shutdown hooks
     */
    public void run() {
        performAction();

        synchronized (this) {
            Runtime.getRuntime().addShutdownHook(new Thread(this::tearDown));
        }
    }

    public abstract String getName();

    /**
     * Config your plugin
     * @return
     */
    protected abstract String setup();

    /**
     * Endpoint of your plugin
     */
    protected abstract void performAction();

    /**
     * Teardown hook when app stopping
     */
    protected abstract void tearDown();
}