io.opencaesar.owl.fuseki.StartFusekiTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owl-fuseki-gradle Show documentation
A gradle task to invoke owl fuseki
The newest version!
package io.opencaesar.owl.fuseki;

import java.io.IOException;
import java.util.ArrayList;

import org.gradle.api.DefaultTask;
import org.gradle.api.GradleException;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.RegularFile;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.provider.ListProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.OutputFile;
import org.gradle.api.tasks.TaskAction;

/**
 * Gradle task for starting a background Apache Fuseki server that stays running beyond the gradle session.
 */
public abstract class StartFusekiTask extends DefaultTask {

	/**
	 * Creates a new StartFusekiTask object.
	 */
	public StartFusekiTask( ) {
	}
	
    /**
     * The required gradle task fuseki configuration property.
     * 
     * @return RegularFileProperty
     */
	@InputFile
    public abstract RegularFileProperty getConfigurationPath();

    /**
     * The required gradle task fuseki output folder property.
     * 
     * @return DirectoryProperty
     */
	@Internal
    public abstract DirectoryProperty getOutputFolderPath();

    /**
     * The optional gradle task remote Maven repository URL property for resolving Apache Fuseki dependencies
     *         (default is https://repo.maven.apache.org/maven2/).
     * 
     * @return String Property
     */
    @Optional
    @Input
    public abstract Property getRemoteRepositoryURL();

    /**
     * The optional gradle task fuseki version property (default is 4.6.0).
     * 
     * @return String Property
     */
    @Optional
    @Input
    public abstract Property getFusekiVersion();

    /**
     * The list of additional classpath dependencies, each of the form: {group}:{artifact}:{exact version}
     *
     * @return List of additional classpath dependencies.
     */
    @Optional
    @Input
    public abstract ListProperty getClasspath();

    /**
     * The optional list of additional JVM arguments
     *
     * @return List of additional JVM arguments.
     */
    @Optional
    @Input
    public abstract ListProperty getJVMArguments();

    /**
     * The optional gradle task fuseki port property (default is 3030).
     * 
     * @return Integer Property
     */
    @Optional
    @Input
    public abstract Property getPort();

    /**
     * The optional gradle task fuseki web ui property (default is false).
     * 
     * @return Boolean Proprty
     */
    @Optional
    @Input
    public abstract Property getWebUI();

    /**
     * The optional gradle task fuseki maximum pings property (default is 10).
     * 
     * @return Integer Property
     */
    @Optional
    @Input
    public abstract Property getMaxPings();

    /**
     * The optional gradle task debug property (default is false).
     * 
     * @return Boolean Property
     */
    @Optional
    @Input
    public abstract Property getDebug();

    /**
     * The gradle output file, after checking whether the fuseki pid file can be deleted
     *         if the process no longer exists.
     * 
     * @return Regular File Provider
     * @throws IOException error
     */
    @OutputFile
    protected Provider getOutputFile() throws IOException {
        if (getOutputFolderPath().isPresent()) {
            var pidRegularFile = getOutputFolderPath().file(FusekiApp.PID_FILENAME);
            var pidFile = pidRegularFile.get().getAsFile();
            if (pidFile.exists()) {
	        	java.util.Optional pid = FusekiApp.findFusekiProcessId(pidFile);
	            if (pid.isPresent()) {
	    	        java.util.Optional ph = FusekiApp.findProcess(pid.get());
	    	        if (!ph.isPresent()) {
	    	        	pidFile.delete();
	    	        }
	            }
            }
            return pidRegularFile;
        }
        return null;
    }

    /**
     * The gradle task action logic.
     */
    @TaskAction
    public void run() {
        final ArrayList args = new ArrayList<>();
        args.add("-c");
        args.add(FusekiApp.Command.start.toString());
        if (getFusekiVersion().isPresent()) {
            args.add("--fuseki-version");
            args.add(getFusekiVersion().get());
        }
        if (getRemoteRepositoryURL().isPresent()) {
            args.add("-url");
            args.add(getRemoteRepositoryURL().get());
        }
        if (getConfigurationPath().isPresent()) {
            args.add("-g");
            args.add(getConfigurationPath().get().getAsFile().getAbsolutePath());
        }
        if (getOutputFolderPath().isPresent()) {
            args.add("-o");
            args.add(getOutputFolderPath().get().getAsFile().getAbsolutePath());
        }
        if (getPort().isPresent()) {
        	args.add("-p");
        	args.add(getPort().get().toString());
        }
        if (getWebUI().isPresent()) {
        	if (getWebUI().get()) {
                args.add("-ui");
            }
        }
        if (getMaxPings().isPresent()) {
            args.add("-n");
            args.add(getMaxPings().get().toString());
        }
        if (getJVMArguments().isPresent()) {
        	getJVMArguments().get().forEach(arg -> {
                args.add("-jvm");
                args.add(arg);
            });
        }
        if (getClasspath().isPresent()) {
        	getClasspath().get().forEach(dep -> {
                args.add("-cp");
                args.add(dep);
            });
        }
        if (getDebug().isPresent() && getDebug().get()) {
            args.add("-d");
        }
        try {
            String[] a = args.toArray(new String[0]);
        	FusekiApp.main(a);
        } catch (Exception e) {
			throw new GradleException(e.getLocalizedMessage(), e);
        }
    }
    
}