EngineAPI.java

package betsy.common.engines;

import java.nio.file.Path;

import javax.xml.namespace.QName;

import betsy.common.HasLogs;
import betsy.common.model.engine.IsEngine;
import betsy.common.tasks.FileTasks;
import pebl.ProcessLanguage;

public interface EngineAPI<P> extends EngineLifecycle, IsEngine, HasLogs {

    /**
     * Deploy the given <code>process</code> to the current engine.
     * Deployment is always synchronous.
     */
    void deploy(String name, Path path);

    boolean isDeployed(QName process);

    void undeploy(QName process);

    /**
     * Build archives required for deployment.
     *
     * @param process the process for which the archives are being built
     */
    Path buildArchives(P process);

    /**
     * Gets endpoint url of requested endpoint url. This url is used for testing the process later on.
     *
     * @param name the process
     * @return the url of the endpoint
     */
    String getEndpointUrl(String name);

    /**
     * Store logs used for a specific process. This is required for analysis in case of error.
     */
    default void storeLogs(Path targetLogPath) {
        FileTasks.mkdirs(targetLogPath);

        for (Path p : getLogs()) {
            FileTasks.copyFileIntoFolder(p, targetLogPath);
        }
    }

    /**
     * @return returns which process language is supported by this engine.
     */
    ProcessLanguage getSupportedLanguage();

}