io.jenkins.plugins.ml.util

Class ProcessLauncher

java.lang.Object

io.jenkins.plugins.ml.util.ProcessLauncher

All Implemented Interfaces:

org.apache.commons.exec.ExecuteResultHandler

Direct Known Subclasses:

JupyterKernelInterpreter.JupyterKernelProcessLauncher

public abstract class ProcessLauncher
extends Object
implements org.apache.commons.exec.ExecuteResultHandler

Abstract class for launching java process. Copied from org.apache.zeppelin.interpreter.util Added changes to support change working directory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessLauncher.ProcessLogOutputStream
static class	ProcessLauncher.State

Field Summary

Fields

Modifier and Type	Field and Description
protected String	errorMessage
protected ProcessLauncher.State	state

Constructor Summary

Constructors

Constructor and Description
ProcessLauncher(org.apache.commons.exec.CommandLine commandLine, Map<String,String> envs, ProcessLauncher.ProcessLogOutputStream processLogOutput, String workingDirectory)
ProcessLauncher(org.apache.commons.exec.CommandLine commandLine, Map<String,String> envs, String workingDirectory)

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage()
String	getProcessLaunchOutput()
boolean	isLaunchTimeout()
boolean	isRunning()
void	launch()
void	onProcessComplete(int exitValue)
void	onProcessFailed(org.apache.commons.exec.ExecuteException e)
void	onProcessRunning()
void	onTimeout()
void	setRedirectedContext(org.apache.zeppelin.interpreter.InterpreterContext redirectedContext) In some cases we need to redirect process output to paragraph's InterpreterOutput.
void	stop()
void	stopCatchLaunchOutput()
void	transition(ProcessLauncher.State state)
abstract void	waitForReady(int timeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

errorMessage

protected String errorMessage

state

protected ProcessLauncher.State state

Constructor Detail

ProcessLauncher

public ProcessLauncher(org.apache.commons.exec.CommandLine commandLine,
                       Map<String,String> envs,
                       String workingDirectory)

ProcessLauncher

public ProcessLauncher(org.apache.commons.exec.CommandLine commandLine,
                       Map<String,String> envs,
                       ProcessLauncher.ProcessLogOutputStream processLogOutput,
                       String workingDirectory)

Method Detail

setRedirectedContext

public void setRedirectedContext(org.apache.zeppelin.interpreter.InterpreterContext redirectedContext)

In some cases we need to redirect process output to paragraph's InterpreterOutput. e.g. In %r.shiny for shiny app

Parameters:

redirectedContext - redirect process output

launch

public void launch()

waitForReady

public abstract void waitForReady(int timeout)

transition

public void transition(ProcessLauncher.State state)

onTimeout

public void onTimeout()

onProcessRunning

public void onProcessRunning()

onProcessComplete

public void onProcessComplete(int exitValue)

Specified by:

onProcessComplete in interface org.apache.commons.exec.ExecuteResultHandler

onProcessFailed

public void onProcessFailed(org.apache.commons.exec.ExecuteException e)

Specified by:

onProcessFailed in interface org.apache.commons.exec.ExecuteResultHandler

getErrorMessage

public String getErrorMessage()

getProcessLaunchOutput

public String getProcessLaunchOutput()

isLaunchTimeout

public boolean isLaunchTimeout()

isRunning

public boolean isRunning()

stop

public void stop()

stopCatchLaunchOutput

public void stopCatchLaunchOutput()