Module io.xpipe.core

Package io.xpipe.core.process

Interface ShellControl

All Superinterfaces:

AutoCloseable, ProcessControl

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)
void	cd(String directory)
default CommandControl	command(CommandBuilder builder)
default CommandControl	command(String command)
default CommandControl	command(Consumer<CommandBuilder> builder)
ShellControl	elevated(String message, FailableFunction<ShellControl,Boolean,Exception> elevationFunction)
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 void	executeSimpleCommand(String command, String failMessage)
default byte[]	executeSimpleRawBytesCommand(String command)
default String	executeSimpleStringCommand(ShellDialect type, String command)
default String	executeSimpleStringCommand(String command)
default Optional<String>	executeSimpleStringCommandAndCheck(String command)
void	exitAndWait()
ShellSecurityPolicy	getEffectiveSecurityPolicy()
UUID	getElevationSecretId()
List<UUID>	getExitUuids()
List<ScriptSnippet>	getInitCommands()
ParentSystemAccess	getLocalSystemAccess()
ReentrantLock	getLock()
ShellControl	getMachineRootSession()
ShellDialect	getOriginalShellDialect()
String	getOsName()
OsType.Any	getOsType()
ParentSystemAccess	getParentSystemAccess()
Optional<ShellStore>	getSourceStore()
String	getSystemTemporaryDirectory()
default ShellControl	identicalSubShell()
boolean	isLicenseCheck()
boolean	isLocal()
ShellControl	onExit(Consumer<ShellControl> pc)
ShellControl	onFail(Consumer<Throwable> t)
ShellControl	onInit(FailableConsumer<ShellControl,Exception> pc)
default CommandControl	osascriptCommand(String script)
String	prepareIntermediateTerminalOpen(String content, TerminalInitScriptConfig config, FailableFunction<ShellControl,String,Exception> workingDirectory)
void	restart()
void	setOriginalShellDialect(ShellDialect dialect)
void	setParentSystemAccess(ParentSystemAccess access)
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(ScriptSnippet snippet)
ShellControl	withoutLicenseCheck()
ShellControl	withSecurityPolicy(ShellSecurityPolicy policy)
default <T extends ShellStoreState> ShellControl	withShellStateFail(StatefulDataStore<T> store)
default <T extends ShellStoreState> ShellControl	withShellStateInit(StatefulDataStore<T> store)
ShellControl	withSourceStore(ShellStore store)
void	writeLineAndReadEcho(String command)
void	writeLineAndReadEcho(String command, boolean log)

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

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

Method Details

getElevationSecretId

UUID getElevationSecretId()

getExitUuids

List<UUID> getExitUuids()

getSourceStore

Optional<ShellStore> getSourceStore()

withSourceStore

ShellControl withSourceStore(ShellStore store)

getInitCommands

List<ScriptSnippet> getInitCommands()

getParentSystemAccess

ParentSystemAccess getParentSystemAccess()

setParentSystemAccess

void setParentSystemAccess(ParentSystemAccess access)

getLocalSystemAccess

ParentSystemAccess getLocalSystemAccess()

isLocal

boolean isLocal()

getMachineRootSession

ShellControl getMachineRootSession()

withoutLicenseCheck

ShellControl withoutLicenseCheck()

getOsName

String getOsName()

isLicenseCheck

boolean isLicenseCheck()

getLock

ReentrantLock getLock()

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)

onFail

ShellControl onFail(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)

prepareIntermediateTerminalOpen

String prepareIntermediateTerminalOpen(String content,
 TerminalInitScriptConfig config,
 FailableFunction<ShellControl,String,Exception> workingDirectory)
                                throws Exception

Throws:

Exception

getSystemTemporaryDirectory

String getSystemTemporaryDirectory()

osascriptCommand

default CommandControl osascriptCommand(String script)

executeSimpleRawBytesCommand

default byte[] executeSimpleRawBytesCommand(String command)
                                     throws Exception

Throws:

Exception

executeSimpleStringCommand

default String executeSimpleStringCommand(String command)
                                   throws Exception

Throws:

Exception

executeSimpleStringCommandAndCheck

default Optional<String> executeSimpleStringCommandAndCheck(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

executeSimpleCommand

default void executeSimpleCommand(String command,
 String failMessage)
                           throws Exception

Throws:

Exception

executeSimpleStringCommand

default String executeSimpleStringCommand(ShellDialect type,
 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(String message,
 FailableFunction<ShellControl,Boolean,Exception> elevationFunction)

withInitSnippet

ShellControl withInitSnippet(ScriptSnippet snippet)

subShell

default ShellControl subShell(@NonNull
 @NonNull ShellDialect type)

identicalSubShell

default ShellControl identicalSubShell()

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)

writeLineAndReadEcho

void writeLineAndReadEcho(String command)
                   throws Exception

Throws:

Exception

writeLineAndReadEcho

void writeLineAndReadEcho(String command,
 boolean log)
                   throws Exception

Throws:

Exception

cd

void cd(String directory)
 throws Exception

Throws:

Exception

command

default CommandControl command(String command)

command

default CommandControl command(Consumer<CommandBuilder> builder)

command

default CommandControl command(CommandBuilder builder)

exitAndWait

void exitAndWait()
          throws IOException

Throws:

IOException