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

Modifier and Type	Interface	Description
static interface	ShellControl.TerminalOpenFunction

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

ProcessControl.ExceptionConverter

Method Summary

Modifier and Type	Method	Description
ShellControl	additionalTimeout(int ms)
default CommandControl	buildCommand(Consumer<CommandBuilder> builder)
ElevationResult	buildElevatedCommand(String input, String prefix)
void	cd(String directory)
ShellControl	changesHosts()
void	checkRunning()
default CommandControl	command(CommandBuilder builder)
CommandControl	command(FailableFunction<ShellControl,String,Exception> command)
CommandControl	command(FailableFunction<ShellControl,String,Exception> command, FailableFunction<ShellControl,String,Exception> terminalCommand)
default CommandControl	command(String... command)
default CommandControl	command(List<String> command)
ShellControl	elevated(String message, FailableFunction<ShellControl,Boolean,Exception> elevationFunction)
ShellControl	elevationPassword(FailableSupplier<SecretValue> value)
default ShellControl	elevationPassword(SecretValue value)
default ShellControl	enforcedDialect(ShellDialect type)
default <T> T	enforceDialect(@NonNull ShellDialect type, FailableFunction<ShellControl,T,Exception> sc)
void	executeLine(String command)
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)
void	exitAndWait()
ElevationConfig	getElevationConfig()
FailableSupplier<SecretValue>	getElevationPassword()
List<ScriptSnippet>	getInitCommands()
ReentrantLock	getLock()
ShellControl	getMachineRootSession()
String	getOsName()
OsType	getOsType()
BufferedProcessInputStream	getStderr()
BufferedProcessInputStream	getStdout()
String	getSubTemporaryDirectory()
UUID	getSystemId()
String	getSystemTemporaryDirectory()
ShellDialect	getTargetTerminalShellDialect()
default boolean	hasLocalSystemAccess()
default ShellControl	identicalSubShell()
ShellControl	initWith(ScriptSnippet snippet)
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, String displayName)
String	prepareTerminalOpen(String displayName)
void	restart()
ShellControl	start()
default ShellControl	subShell(@NonNull ShellDialect type)
ShellControl	subShell(FailableFunction<ShellControl,String,Exception> command, ShellControl.TerminalOpenFunction terminalCommand)
default ShellControl	subShell(@NonNull String command)
ShellControl	withErrorFormatter(Function<String,String> formatter)
ShellControl	withExceptionConverter(ProcessControl.ExceptionConverter converter)
ShellControl	withoutLicenseCheck()
default <T extends ShellStoreState> ShellControl	withShellStateFail(StatefulDataStore<T> store)
default <T extends ShellStoreState> ShellControl	withShellStateInit(StatefulDataStore<T> store)
default ShellControl	withSupportCheckInit(Predicate<ShellControl> predicate, String name)
ShellControl	withTargetTerminalShellDialect(ShellDialect d)

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

close, closeStdin, getCharset, getShellDialect, getStdin, isRunning, isStdinClosed, kill, resetData, write, writeLine

Method Details

getInitCommands

List<ScriptSnippet> getInitCommands()

withTargetTerminalShellDialect

ShellControl withTargetTerminalShellDialect(ShellDialect d)

getTargetTerminalShellDialect

ShellDialect getTargetTerminalShellDialect()

getStdout

BufferedProcessInputStream getStdout()

Specified by:

getStdout in interface ProcessControl

getStderr

BufferedProcessInputStream getStderr()

Specified by:

getStderr in interface ProcessControl

hasLocalSystemAccess

default boolean hasLocalSystemAccess()

isLocal

boolean isLocal()

changesHosts

ShellControl changesHosts()

getMachineRootSession

ShellControl getMachineRootSession()

withoutLicenseCheck

ShellControl withoutLicenseCheck()

getOsName

String getOsName()

getSystemId

UUID getSystemId()

getLock

ReentrantLock getLock()

onInit

ShellControl onInit(FailableConsumer<ShellControl,Exception> pc)

withShellStateInit

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

withSupportCheckInit

default ShellControl withSupportCheckInit(Predicate<ShellControl> predicate,
 String name)

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

withErrorFormatter

ShellControl withErrorFormatter(Function<String,String> formatter)

prepareTerminalOpen

String prepareTerminalOpen(String displayName)
                    throws Exception

Specified by:

prepareTerminalOpen in interface ProcessControl

Throws:

Exception

prepareIntermediateTerminalOpen

String prepareIntermediateTerminalOpen(String content,
 String displayName)
                                throws Exception

Throws:

Exception

getSystemTemporaryDirectory

String getSystemTemporaryDirectory()

getSubTemporaryDirectory

String getSubTemporaryDirectory()

checkRunning

void checkRunning()

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

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

buildElevatedCommand

ElevationResult buildElevatedCommand(String input,
 String prefix)
                              throws Exception

Throws:

Exception

restart

void restart()
      throws Exception

Throws:

Exception

getOsType

OsType getOsType()

getElevationConfig

ElevationConfig getElevationConfig()
                            throws Exception

Throws:

Exception

elevated

ShellControl elevated(String message,
 FailableFunction<ShellControl,Boolean,Exception> elevationFunction)

elevationPassword

default ShellControl elevationPassword(SecretValue value)

elevationPassword

ShellControl elevationPassword(FailableSupplier<SecretValue> value)

initWith

ShellControl initWith(ScriptSnippet snippet)

additionalTimeout

ShellControl additionalTimeout(int ms)

getElevationPassword

FailableSupplier<SecretValue> getElevationPassword()

subShell

default ShellControl subShell(@NonNull
 @NonNull ShellDialect type)

identicalSubShell

default ShellControl identicalSubShell()

subShell

default ShellControl subShell(@NonNull
 @NonNull String command)

enforcedDialect

default ShellControl enforcedDialect(ShellDialect type)
                              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(FailableFunction<ShellControl,String,Exception> command,
 ShellControl.TerminalOpenFunction terminalCommand)

executeLine

void executeLine(String command)
          throws Exception

Throws:

Exception

cd

void cd(String directory)
 throws Exception

Throws:

Exception

start

ShellControl start()

Specified by:

start in interface ProcessControl

command

CommandControl command(FailableFunction<ShellControl,String,Exception> command)

command

CommandControl command(FailableFunction<ShellControl,String,Exception> command,
 FailableFunction<ShellControl,String,Exception> terminalCommand)

command

default CommandControl command(String... command)

buildCommand

default CommandControl buildCommand(Consumer<CommandBuilder> builder)

command

default CommandControl command(List<String> command)

command

default CommandControl command(CommandBuilder builder)

exitAndWait

void exitAndWait()
          throws IOException

Throws:

IOException