Module io.xpipe.core

Package io.xpipe.core.process

Class WrapperShellControl

java.lang.Object

io.xpipe.core.process.WrapperShellControl

All Implemented Interfaces:

ProcessControl, ShellControl, AutoCloseable

Direct Known Subclasses:

StubShellControl

public class WrapperShellControl
extends Object
implements ShellControl

Nested Class Summary

Nested classes/interfaces inherited from interface io.xpipe.core.process.ProcessControl

ProcessControl.ExceptionConverter

Field Summary

Fields

Modifier and Type	Field	Description
protected final ShellControl	parent

Constructor Summary

Constructors

Constructor	Description
WrapperShellControl(ShellControl parent)

Method Summary

Modifier and Type	Method	Description
String	buildElevatedCommand(CommandConfiguration input, String prefix, UUID requestId, CountDown countDown)
void	cd(String directory)
void	checkLicenseOrThrow()
void	close()
void	closeStdin()
void	closeStdout()
CommandControl	command(CommandBuilder builder)
ShellControl	elevated(ElevationFunction elevationFunction)
void	exitAndWait()
ShellCapabilities	getCapabilities()
Charset	getCharset()
ShellSecurityPolicy	getEffectiveSecurityPolicy()
ElevationHandler	getElevationHandler()
List<UUID>	getExitUuids()
List<ShellInitCommand>	getInitCommands()
ParentSystemAccess	getLocalSystemAccess()
ReentrantLock	getLock()
ShellControl	getMachineRootSession()
ShellDialect	getOriginalShellDialect()
String	getOsName()
OsType.Any	getOsType()
Optional<ShellControl>	getParentControl()
ParentSystemAccess	getParentSystemAccess()
ShellDialect	getShellDialect()
Optional<DataStore>	getSourceStore()
Optional<UUID>	getSourceStoreId()
LocalProcessInputStream	getStderr()
LocalProcessOutputStream	getStdin()
LocalProcessInputStream	getStdout()
FilePath	getSystemTemporaryDirectory()
ShellTtyState	getTtyState()
UUID	getUuid()
boolean	isAnyStreamClosed()
boolean	isInteractive()
boolean	isLocal()
boolean	isRunning(boolean refresh)
void	kill()
ShellControl	onExit(Consumer<ShellControl> pc)
ShellControl	onInit(FailableConsumer<ShellControl,Exception> pc)
ShellControl	onKill(Runnable pc)
ShellControl	onStartupFail(Consumer<Throwable> t)
String	prepareIntermediateTerminalOpen(TerminalInitFunction content, TerminalInitScriptConfig config, WorkingDirectoryFunction workingDirectory)
String	prepareTerminalOpen(TerminalInitScriptConfig config, WorkingDirectoryFunction workingDirectory)
void	refreshRunningState()
void	requireLicensedFeature(String id)
void	resetData()
void	restart()
void	setDumbOpen(ShellOpenFunction openFunction)
void	setElevationHandler(ElevationHandler ref)
void	setNonInteractive()
void	setOriginalShellDialect(ShellDialect dialect)
void	setParentSystemAccess(ParentSystemAccess access)
void	setTerminalOpen(ShellOpenFunction openFunction)
void	setWorkingDirectory(WorkingDirectoryFunction workingDirectory)
void	shutdown()
ShellControl	start()
ShellControl	subShell()
ShellView	view()
ShellControl	withErrorFormatter(Function<String,String> formatter)
ShellControl	withExceptionConverter(ProcessControl.ExceptionConverter converter)
ShellControl	withInitSnippet(ShellInitCommand snippet)
ShellControl	withSecurityPolicy(ShellSecurityPolicy policy)
ShellControl	withSourceStore(DataStore store)
void	write(byte[] b)
void	writeLine(String line)
void	writeLine(String line, boolean log)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.xpipe.core.process.ShellControl

canHaveSubshells, command, command, command, elevateIfNeeded, enforceDialect, executeSimpleBooleanCommand, executeSimpleCommand, executeSimpleCommand, executeSimpleStringCommand, identicalDialectSubShell, osascriptCommand, subShell, withShellStateFail, withShellStateInit

Field Details

parent

protected final ShellControl parent

Constructor Details

WrapperShellControl

public WrapperShellControl(ShellControl parent)

Method Details

view

public ShellView view()

Specified by:

view in interface ShellControl

getCapabilities

public ShellCapabilities getCapabilities()

Specified by:

getCapabilities in interface ShellControl

getParentControl

public Optional<ShellControl> getParentControl()

Specified by:

getParentControl in interface ShellControl

getTtyState

public ShellTtyState getTtyState()

Specified by:

getTtyState in interface ShellControl

setNonInteractive

public void setNonInteractive()

Specified by:

setNonInteractive in interface ShellControl

isInteractive

public boolean isInteractive()

Specified by:

isInteractive in interface ShellControl

getElevationHandler

public ElevationHandler getElevationHandler()

Specified by:

getElevationHandler in interface ShellControl

setElevationHandler

public void setElevationHandler(ElevationHandler ref)

Specified by:

setElevationHandler in interface ShellControl

closeStdout

public void closeStdout()
                 throws IOException

Specified by:

closeStdout in interface ShellControl

Throws:

IOException

getExitUuids

public List<UUID> getExitUuids()

Specified by:

getExitUuids in interface ShellControl

setWorkingDirectory

public void setWorkingDirectory(WorkingDirectoryFunction workingDirectory)

Specified by:

setWorkingDirectory in interface ShellControl

getSourceStore

public Optional<DataStore> getSourceStore()

Specified by:

getSourceStore in interface ShellControl

getSourceStoreId

public Optional<UUID> getSourceStoreId()

Specified by:

getSourceStoreId in interface ShellControl

withSourceStore

public ShellControl withSourceStore(DataStore store)

Specified by:

withSourceStore in interface ShellControl

getInitCommands

public List<ShellInitCommand> getInitCommands()

Specified by:

getInitCommands in interface ShellControl

getParentSystemAccess

public ParentSystemAccess getParentSystemAccess()

Specified by:

getParentSystemAccess in interface ShellControl

setParentSystemAccess

public void setParentSystemAccess(ParentSystemAccess access)

Specified by:

setParentSystemAccess in interface ShellControl

getLocalSystemAccess

public ParentSystemAccess getLocalSystemAccess()

Specified by:

getLocalSystemAccess in interface ShellControl

isLocal

public boolean isLocal()

Specified by:

isLocal in interface ShellControl

getMachineRootSession

public ShellControl getMachineRootSession()

Specified by:

getMachineRootSession in interface ShellControl

getOsName

public String getOsName()

Specified by:

getOsName in interface ShellControl

getLock

public ReentrantLock getLock()

Specified by:

getLock in interface ShellControl

requireLicensedFeature

public void requireLicensedFeature(String id)

Specified by:

requireLicensedFeature in interface ShellControl

getOriginalShellDialect

public ShellDialect getOriginalShellDialect()

Specified by:

getOriginalShellDialect in interface ShellControl

setOriginalShellDialect

public void setOriginalShellDialect(ShellDialect dialect)

Specified by:

setOriginalShellDialect in interface ShellControl

onInit

public ShellControl onInit(FailableConsumer<ShellControl,Exception> pc)

Specified by:

onInit in interface ShellControl

onExit

public ShellControl onExit(Consumer<ShellControl> pc)

Specified by:

onExit in interface ShellControl

onKill

public ShellControl onKill(Runnable pc)

Specified by:

onKill in interface ShellControl

onStartupFail

public ShellControl onStartupFail(Consumer<Throwable> t)

Specified by:

onStartupFail in interface ShellControl

getUuid

public UUID getUuid()

Specified by:

getUuid in interface ProcessControl

withExceptionConverter

public ShellControl withExceptionConverter(ProcessControl.ExceptionConverter converter)

Specified by:

withExceptionConverter in interface ProcessControl

Specified by:

withExceptionConverter in interface ShellControl

resetData

public void resetData()

Specified by:

resetData in interface ProcessControl

prepareTerminalOpen

public String prepareTerminalOpen(TerminalInitScriptConfig config,
 WorkingDirectoryFunction workingDirectory)
                           throws Exception

Specified by:

prepareTerminalOpen in interface ProcessControl

Throws:

Exception

refreshRunningState

public void refreshRunningState()

Specified by:

refreshRunningState in interface ProcessControl

closeStdin

public void closeStdin()
                throws IOException

Specified by:

closeStdin in interface ProcessControl

Throws:

IOException

isAnyStreamClosed

public boolean isAnyStreamClosed()

Specified by:

isAnyStreamClosed in interface ProcessControl

isRunning

public boolean isRunning(boolean refresh)

Specified by:

isRunning in interface ProcessControl

getShellDialect

public ShellDialect getShellDialect()

Specified by:

getShellDialect in interface ProcessControl

setDumbOpen

public void setDumbOpen(ShellOpenFunction openFunction)

Specified by:

setDumbOpen in interface ShellControl

setTerminalOpen

public void setTerminalOpen(ShellOpenFunction openFunction)

Specified by:

setTerminalOpen in interface ShellControl

writeLine

public void writeLine(String line)
               throws IOException

Specified by:

writeLine in interface ShellControl

Throws:

IOException

writeLine

public void writeLine(String line,
 boolean log)
               throws IOException

Specified by:

writeLine in interface ShellControl

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Specified by:

write in interface ShellControl

Throws:

IOException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ProcessControl

Throws:

Exception

shutdown

public void shutdown()
              throws Exception

Specified by:

shutdown in interface ProcessControl

Throws:

Exception

kill

public void kill()

Specified by:

kill in interface ProcessControl

start

public ShellControl start()
                   throws Exception

Specified by:

start in interface ProcessControl

Specified by:

start in interface ShellControl

Throws:

Exception

getStdout

public LocalProcessInputStream getStdout()

Specified by:

getStdout in interface ProcessControl

Specified by:

getStdout in interface ShellControl

getStdin

public LocalProcessOutputStream getStdin()

Specified by:

getStdin in interface ProcessControl

Specified by:

getStdin in interface ShellControl

getStderr

public LocalProcessInputStream getStderr()

Specified by:

getStderr in interface ProcessControl

Specified by:

getStderr in interface ShellControl

getCharset

public Charset getCharset()

Specified by:

getCharset in interface ProcessControl

withErrorFormatter

public ShellControl withErrorFormatter(Function<String,String> formatter)

Specified by:

withErrorFormatter in interface ShellControl

checkLicenseOrThrow

public void checkLicenseOrThrow()

Specified by:

checkLicenseOrThrow in interface ShellControl

prepareIntermediateTerminalOpen

public String prepareIntermediateTerminalOpen(TerminalInitFunction content,
 TerminalInitScriptConfig config,
 WorkingDirectoryFunction workingDirectory)
                                       throws Exception

Specified by:

prepareIntermediateTerminalOpen in interface ShellControl

Throws:

Exception

getSystemTemporaryDirectory

public FilePath getSystemTemporaryDirectory()

Specified by:

getSystemTemporaryDirectory in interface ShellControl

withSecurityPolicy

public ShellControl withSecurityPolicy(ShellSecurityPolicy policy)

Specified by:

withSecurityPolicy in interface ShellControl

getEffectiveSecurityPolicy

public ShellSecurityPolicy getEffectiveSecurityPolicy()

Specified by:

getEffectiveSecurityPolicy in interface ShellControl

buildElevatedCommand

public String buildElevatedCommand(CommandConfiguration input,
 String prefix,
 UUID requestId,
 CountDown countDown)
                            throws Exception

Specified by:

buildElevatedCommand in interface ShellControl

Throws:

Exception

restart

public void restart()
             throws Exception

Specified by:

restart in interface ShellControl

Throws:

Exception

getOsType

public OsType.Any getOsType()

Specified by:

getOsType in interface ShellControl

elevated

public ShellControl elevated(ElevationFunction elevationFunction)

Specified by:

elevated in interface ShellControl

withInitSnippet

public ShellControl withInitSnippet(ShellInitCommand snippet)

Specified by:

withInitSnippet in interface ShellControl

subShell

public ShellControl subShell()

Specified by:

subShell in interface ShellControl

cd

public void cd(String directory)
        throws Exception

Specified by:

cd in interface ShellControl

Throws:

Exception

command

public CommandControl command(CommandBuilder builder)

Specified by:

command in interface ShellControl

exitAndWait

public void exitAndWait()
                 throws IOException

Specified by:

exitAndWait in interface ShellControl

Throws:

IOException