Package com.tibco.ep.buildmavenplugin.admin

Class RuntimeCommandRunner

java.lang.Object
com.tibco.ep.buildmavenplugin.admin.RuntimeCommandRunner
public class RuntimeCommandRunner extends Object
An administrative command runner

  • Constructor Details

    • RuntimeCommandRunner

      public RuntimeCommandRunner(org.apache.maven.plugin.logging.Log log, AbstractCommandBuilder builder, String shortLocation, String longLocation)
      Parameters:
      log - The Maven log handle
      builder - The command builder
      shortLocation - Short location for logging
      longLocation - Long location for error reporting

  • Method Details

    • wait

      public RuntimeCommandRunner wait(boolean wait)
      Should the runner wait for command completion ?
      Parameters:
      wait - True if the runner needs to wait
      Returns:
      This

    • errorHandling

      public RuntimeCommandRunner errorHandling(ErrorHandling errorHandling)
      Should the runner fail upon error ?
      Parameters:
      errorHandling - The error handling for the command
      Returns:
      This

    • recordOutput

      public RuntimeCommandRunner recordOutput(boolean recordOutput)
      Should the runner record output
      Parameters:
      recordOutput - True if the runner should record output
      Returns:
      This

    • shutdownHook

      public RuntimeCommandRunner shutdownHook(Consumer<ICommand> shutdownHook)
      Configure a shutdown hook
      Parameters:
      shutdownHook - The shutdown hook
      Returns:
      This

    • onError

      public RuntimeCommandRunner onError(ErrorHandler errorHandler)
      Configure an error hook
      Parameters:
      errorHandler - The error hook
      Returns:
      This

    • run

      public RuntimeCommandNotifier run() throws org.apache.maven.plugin.MojoExecutionException
      Run the command
      Returns:
      This
      Throws:
      org.apache.maven.plugin.MojoExecutionException - An execution failure happened

    • run

      public RuntimeCommandNotifier run(Map<String,String> parameters) throws org.apache.maven.plugin.MojoExecutionException
      Run the command with parameters
      Parameters:
      parameters - The parameters
      Returns:
      This
      Throws:
      org.apache.maven.plugin.MojoExecutionException - An execution failure happened

    • removeShutdownHook

      public void removeShutdownHook()
      Remove the shutdown hook