Package com.intellij.execution.process

Class OSProcessHandler

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.execution.process.ProcessHandler

com.intellij.execution.process.BaseProcessHandler<java.lang.Process>

com.intellij.execution.process.BaseOSProcessHandler

com.intellij.execution.process.OSProcessHandler

All Implemented Interfaces:

TaskExecutor, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

BinaryOSProcessHandler, CapturingProcessHandler, DefaultJavaProcessHandler, KillableProcessHandler, OSProcessHandler.Silent, SvnProcessHandler

public class OSProcessHandler
extends BaseOSProcessHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OSProcessHandler.Silent

Nested classes/interfaces inherited from class com.intellij.execution.process.BaseOSProcessHandler

BaseOSProcessHandler.SimpleOutputReader

Field Summary

Fields inherited from class com.intellij.execution.process.BaseProcessHandler

myCharset, myCommandLine, myPresentableName, myProcess, myWaitFor

Fields inherited from class com.intellij.execution.process.ProcessHandler

SILENTLY_DESTROY_ON_CLOSE, TERMINATION_REQUESTED

Constructor Summary

Constructors

Constructor and Description
OSProcessHandler(GeneralCommandLine commandLine)
OSProcessHandler(java.lang.Process process) Deprecated. use OSProcessHandler(Process, String) (or any other constructor)
OSProcessHandler(java.lang.Process process, java.lang.String commandLine) commandLine must not be empty (for correct thread attribution in the stacktrace)
OSProcessHandler(java.lang.Process process, java.lang.String commandLine, java.nio.charset.Charset charset) commandLine must not be empty (for correct thread attribution in the stacktrace)
OSProcessHandler(java.lang.Process process, java.lang.String commandLine, java.nio.charset.Charset charset, java.util.Set<? extends java.io.File> filesToDelete) commandLine must not be empty (for correct thread attribution in the stacktrace)

Method Summary

Modifier and Type	Method and Description
static void	checkEdtAndReadAction(ProcessHandler processHandler) Checks if we are going to wait for processHandler to finish on EDT or under ReadAction.
static void	deleteFileOnTermination(GeneralCommandLine commandLine, java.io.File fileToDelete) Registers a file to delete after the given command line finishes.
protected void	doDestroyProcess()
static ModalityState	getDefaultModality()
protected void	killProcessTree(java.lang.Process process) Kills the whole process tree asynchronously.
protected void	onOSProcessTerminated(int exitCode)
static boolean	processCanBeKilledByOS(java.lang.Process process)
protected boolean	processHasSeparateErrorStream()
protected BaseOutputReader.Options	readerOptions() Rule of thumb: use BaseOutputReader.Options#BLOCKING for short-living process that you never want to "disconnect" from.
void	setHasPty(boolean hasPty) In case of PTY this process handler will use blocking read because InputStream.available() doesn't work for Pty4j, and there is no reason to "disconnect" leaving PTY alive.
void	setShouldDestroyProcessRecursively(boolean destroyRecursively)
protected boolean	shouldDestroyProcessRecursively()
boolean	waitFor() Wait for process execution.
boolean	waitFor(long timeoutInMilliseconds)

Methods inherited from class com.intellij.execution.process.BaseOSProcessHandler

createErrorDataReader, createOutputDataReader, createProcessErrReader, createProcessOutReader, executeOnPooledThread, executeTask, startNotify, toString

Methods inherited from class com.intellij.execution.process.BaseProcessHandler

closeStreams, destroyProcessImpl, detachIsDefault, detachProcessImpl, getCharset, getCommandLine, getProcess, getProcessInput

Methods inherited from class com.intellij.execution.process.ProcessHandler

addProcessListener, addProcessListener, destroyProcess, detachProcess, getExitCode, isProcessTerminated, isProcessTerminating, isSilentlyDestroyOnClose, isStartNotified, notifyProcessDetached, notifyProcessTerminated, notifyTextAvailable, removeProcessListener

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Constructor Detail

OSProcessHandler

public OSProcessHandler(GeneralCommandLine commandLine)
                 throws ExecutionException

Throws:

ExecutionException

OSProcessHandler

@Deprecated
public OSProcessHandler(java.lang.Process process)

Deprecated. use OSProcessHandler(Process, String) (or any other constructor)

OSProcessHandler

public OSProcessHandler(java.lang.Process process,
                        java.lang.String commandLine)

commandLine must not be empty (for correct thread attribution in the stacktrace)

OSProcessHandler

public OSProcessHandler(java.lang.Process process,
                        java.lang.String commandLine,
                        java.nio.charset.Charset charset)

commandLine must not be empty (for correct thread attribution in the stacktrace)

OSProcessHandler

public OSProcessHandler(java.lang.Process process,
                        java.lang.String commandLine,
                        java.nio.charset.Charset charset,
                        java.util.Set<? extends java.io.File> filesToDelete)

commandLine must not be empty (for correct thread attribution in the stacktrace)

Method Detail

getDefaultModality

public static ModalityState getDefaultModality()

waitFor

public boolean waitFor()

Description copied from class: ProcessHandler

Wait for process execution.

Overrides:

waitFor in class BaseOSProcessHandler

Returns:

true if target process has actually ended; false if we stopped watching the process execution and don't know if it has completed.

waitFor

public boolean waitFor(long timeoutInMilliseconds)

Overrides:

waitFor in class BaseOSProcessHandler

checkEdtAndReadAction

public static void checkEdtAndReadAction(ProcessHandler processHandler)

Checks if we are going to wait for processHandler to finish on EDT or under ReadAction. Logs error if we do so.

HOW-TO fix an error from this method:

• You are on the pooled thread under ReadAction:
  • Synchronous (you need to return execution result or derived information to the caller) - get rid the ReadAction or synchronicity. * Move execution part out of the code executed under ReadAction, or make your execution asynchronous - execute on * other thread and invoke a callback.
  • Non-synchronous (you don't need to return something) - execute on another thread. E.g. using Task.Backgroundable
• You are on EDT:
  • Outside of WriteAction:
    • Synchronous (you need to return execution result or derived information to the caller) - execute under modal progress.
    • Non-synchronous (you don't need to return something) - execute on the pooled thread. E.g. using Task.Backgroundable
  • Under WriteAction
    • Synchronous (you need to return execution result or derived information to the caller) - get rid the WriteAction or synchronicity. Move execution part out of the code executed under WriteAction, or make your execution asynchronous - execute on other thread and invoke a callback.
    • Non-synchronous (you don't need to return something) - execute on the pooled thread. E.g. using Task.Backgroundable

onOSProcessTerminated

protected void onOSProcessTerminated(int exitCode)

Overrides:

onOSProcessTerminated in class BaseProcessHandler<java.lang.Process>

processHasSeparateErrorStream

protected boolean processHasSeparateErrorStream()

Overrides:

processHasSeparateErrorStream in class BaseOSProcessHandler

shouldDestroyProcessRecursively

protected boolean shouldDestroyProcessRecursively()

setShouldDestroyProcessRecursively

public void setShouldDestroyProcessRecursively(boolean destroyRecursively)

doDestroyProcess

protected void doDestroyProcess()

Overrides:

doDestroyProcess in class BaseProcessHandler<java.lang.Process>

processCanBeKilledByOS

public static boolean processCanBeKilledByOS(java.lang.Process process)

killProcessTree

protected void killProcessTree(java.lang.Process process)

Kills the whole process tree asynchronously. As a potentially time-consuming operation, it's executed asynchronously on a pooled thread.

Parameters:

process - Process

setHasPty

public void setHasPty(boolean hasPty)

In case of PTY this process handler will use blocking read because InputStream.available() doesn't work for Pty4j, and there is no reason to "disconnect" leaving PTY alive. See BaseDataReader.SleepingPolicy for more info.

The value should be set before BaseOSProcessHandler.startNotify() invocation. It is set by default in case of using GeneralCommandLine based constructor.

Parameters:

hasPty - true if process is PTY-based.

readerOptions

protected BaseOutputReader.Options readerOptions()

Rule of thumb: use BaseOutputReader.Options#BLOCKING for short-living process that you never want to "disconnect" from. See BaseDataReader.SleepingPolicy for the whole story.

Overrides:

readerOptions in class BaseOSProcessHandler

deleteFileOnTermination

public static void deleteFileOnTermination(GeneralCommandLine commandLine,
                                           java.io.File fileToDelete)

Registers a file to delete after the given command line finishes. In order to have an effect, the command line has to be executed with OSProcessHandler(GeneralCommandLine).