Module io.xpipe.core

Package io.xpipe.core.process

Interface ShellControl

All Superinterfaces:

AutoCloseable, ProcessControl

All Known Implementing Classes:

StubShellControl, WrapperShellControl

public interface ShellControl
extends ProcessControl

Nested Class Summary

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

ProcessControl.ExceptionConverter

Method Summary

Modifier and Type	Method	Description
String	buildElevatedCommand(CommandConfiguration input, String prefix, UUID requestId, CountDown countDown)
default boolean	canHaveSubshells()
void	cd(String directory)
void	checkLicenseOrThrow()
CommandControl	command(CommandBuilder builder)
default CommandControl	command(String command)
default CommandControl	command(Consumer<CommandBuilder> builder)
ShellControl	elevated(ElevationFunction elevationFunction)
default ShellControl	elevateIfNeeded(ElevationFunction function)
default <T> T	enforceDialect(@NonNull ShellDialect type, FailableFunction<ShellControl,T,Exception> sc)
default boolean	executeSimpleBooleanCommand(String command)
default void	executeSimpleCommand(CommandBuilder command)
default void	executeSimpleCommand(String command)
default String	executeSimpleStringCommand(String command)
void	exitAndWait()
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()
Optional<DataStore>	getSourceStore()
FilePath	getSystemTemporaryDirectory()
ShellTtyState	getTtyState()
default ShellControl	identicalSubShell()
boolean	isInteractive()
boolean	isLocal()
ShellControl	onExit(Consumer<ShellControl> pc)
ShellControl	onInit(FailableConsumer<ShellControl,Exception> pc)
ShellControl	onKill(Runnable pc)
ShellControl	onStartupFail(Consumer<Throwable> t)
default CommandControl	osascriptCommand(String script)
String	prepareIntermediateTerminalOpen(TerminalInitFunction content, TerminalInitScriptConfig config, WorkingDirectoryFunction workingDirectory)
void	requireLicensedFeature(String id)
void	restart()
void	setElevationHandler(ElevationHandler ref)
void	setNonInteractive()
void	setOriginalShellDialect(ShellDialect dialect)
void	setParentSystemAccess(ParentSystemAccess access)
void	setWorkingDirectory(WorkingDirectoryFunction workingDirectory)
ShellControl	singularSubShell(ShellOpenFunction command)
ShellControl	start()
default ShellControl	subShell(@NonNull ShellDialect type)
ShellControl	subShell(ShellOpenFunction command, ShellOpenFunction terminalCommand)
ShellControl	withErrorFormatter(Function<String,String> formatter)
ShellControl	withExceptionConverter(ProcessControl.ExceptionConverter converter)
ShellControl	withInitSnippet(ShellInitCommand snippet)
ShellControl	withSecurityPolicy(ShellSecurityPolicy policy)
default <T extends ShellStoreState> ShellControl	withShellStateFail(StatefulDataStore<T> store)
default <T extends ShellStoreState> ShellControl	withShellStateInit(StatefulDataStore<T> store)
ShellControl	withSourceStore(DataStore store)

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

close, closeStdin, getCharset, getShellDialect, getStderr, getStdin, getStdout, getUuid, isRunning, isStdinClosed, kill, prepareTerminalOpen, refreshRunningState, resetData, shutdown, write, writeLine, writeLine

Method Details

getParentControl

Optional<ShellControl> getParentControl()

getTtyState

ShellTtyState getTtyState()

setNonInteractive

void setNonInteractive()

isInteractive

boolean isInteractive()

getElevationHandler

ElevationHandler getElevationHandler()

setElevationHandler

void setElevationHandler(ElevationHandler ref)

getExitUuids

List<UUID> getExitUuids()

setWorkingDirectory

void setWorkingDirectory(WorkingDirectoryFunction workingDirectory)

getSourceStore

Optional<DataStore> getSourceStore()

withSourceStore

ShellControl withSourceStore(DataStore store)

getInitCommands

List<ShellInitCommand> getInitCommands()

getParentSystemAccess

ParentSystemAccess getParentSystemAccess()

setParentSystemAccess

void setParentSystemAccess(ParentSystemAccess access)

getLocalSystemAccess

ParentSystemAccess getLocalSystemAccess()

isLocal

boolean isLocal()

canHaveSubshells

default boolean canHaveSubshells()

getMachineRootSession

ShellControl getMachineRootSession()

getOsName

String getOsName()

getLock

ReentrantLock getLock()

requireLicensedFeature

void requireLicensedFeature(String id)

getOriginalShellDialect

ShellDialect getOriginalShellDialect()

setOriginalShellDialect

void setOriginalShellDialect(ShellDialect dialect)

onInit

ShellControl onInit(FailableConsumer<ShellControl,Exception> pc)

withShellStateInit

default <T extends ShellStoreState> ShellControl withShellStateInit(StatefulDataStore<T> store)

withShellStateFail

default <T extends ShellStoreState> ShellControl withShellStateFail(StatefulDataStore<T> store)

onExit

ShellControl onExit(Consumer<ShellControl> pc)

onKill

ShellControl onKill(Runnable pc)

onStartupFail

ShellControl onStartupFail(Consumer<Throwable> t)

withExceptionConverter

ShellControl withExceptionConverter(ProcessControl.ExceptionConverter converter)

Specified by:

withExceptionConverter in interface ProcessControl

start

ShellControl start()
            throws Exception

Specified by:

start in interface ProcessControl

Throws:

Exception

withErrorFormatter

ShellControl withErrorFormatter(Function<String,String> formatter)

checkLicenseOrThrow

void checkLicenseOrThrow()

prepareIntermediateTerminalOpen

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

Throws:

Exception

getSystemTemporaryDirectory

FilePath getSystemTemporaryDirectory()

osascriptCommand

default CommandControl osascriptCommand(String script)

executeSimpleStringCommand

default String executeSimpleStringCommand(String command)
                                   throws Exception

Throws:

Exception

executeSimpleBooleanCommand

default boolean executeSimpleBooleanCommand(String command)
                                     throws Exception

Throws:

Exception

executeSimpleCommand

default void executeSimpleCommand(CommandBuilder command)
                           throws Exception

Throws:

Exception

executeSimpleCommand

default void executeSimpleCommand(String command)
                           throws Exception

Throws:

Exception

withSecurityPolicy

ShellControl withSecurityPolicy(ShellSecurityPolicy policy)

getEffectiveSecurityPolicy

ShellSecurityPolicy getEffectiveSecurityPolicy()

buildElevatedCommand

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

Throws:

Exception

restart

void restart()
      throws Exception

Throws:

Exception

getOsType

OsType.Any getOsType()

elevated

ShellControl elevated(ElevationFunction elevationFunction)

withInitSnippet

ShellControl withInitSnippet(ShellInitCommand snippet)

subShell

default ShellControl subShell(@NonNull
 @NonNull ShellDialect type)

identicalSubShell

default ShellControl identicalSubShell()

elevateIfNeeded

default ShellControl elevateIfNeeded(ElevationFunction function)
                              throws Exception

Throws:

Exception

enforceDialect

default <T> T enforceDialect(@NonNull
 @NonNull ShellDialect type,
 FailableFunction<ShellControl,T,Exception> sc)
                      throws Exception

Throws:

Exception

subShell

ShellControl subShell(ShellOpenFunction command,
 ShellOpenFunction terminalCommand)

singularSubShell

ShellControl singularSubShell(ShellOpenFunction command)

cd

void cd(String directory)
 throws Exception

Throws:

Exception

command

default CommandControl command(String command)

command

default CommandControl command(Consumer<CommandBuilder> builder)

command

CommandControl command(CommandBuilder builder)

exitAndWait

void exitAndWait()
          throws IOException

Throws:

IOException