Module io.inverno.tool.buildtools
Package io.inverno.tool.buildtools

Interface StopTask

All Superinterfaces:
Task<Long,StopTask>
public interface StopTask extends Task<Long,StopTask>

A task for stopping a running project whose pid is provided in a file.

This task is typically executed to stop a project started using StartTask.

Since:
1.4
Author:
Jeremy Kuhn

  • Method Summary

    Modifier and Type
    Method
    Description
    StopTask
    pidfile(Path pidfile)
    Sets the path to the file containing the pid of the running project.
    StopTask
    timeout(long timeout)
    Sets the time to wait for the running project to stop after sending the SIGINT signal.

    Methods inherited from interface io.inverno.tool.buildtools.Task

    doOnComplete, execute

  • Method Details

    • pidfile

      StopTask pidfile(Path pidfile)

      Sets the path to the file containing the pid of the running project.

      Defaults to [WORKING_PATH]/[PROJECT_NAME].pid

      Parameters:
      pidfile - The path tp the pidfile
      Returns:
      the task

    • timeout

      StopTask timeout(long timeout)

      Sets the time to wait for the running project to stop after sending the SIGINT signal.

      If the process is not stopped after the timeout, task execution fails with a TaskExecutionException.

      Defaults to 60000.

      Parameters:
      timeout - the timeout in milliseconds
      Returns:
      the task