Module io.xpipe.core

Package io.xpipe.core.process

Interface ShellControl

All Superinterfaces:

AutoCloseable, Closeable, 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
ElevationResult	buildElevatedCommand(String input)
void	cd(String directory)
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)
ElevationResult	elevateCommand(String input)
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(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()
Semaphore	getCommandLock()
ElevationConfig	getElevationConfig()
FailableSupplier<SecretValue>	getElevationPassword()
OsType	getOsType()
String	getSubTemporaryDirectory()
UUID	getSystemId()
String	getSystemTemporaryDirectory()
default ShellControl	identicalSubShell()
ShellControl	initWith(String cmds)
ShellControl	initWith(List<String> cmds)
default boolean	isLocal()
ShellControl	onExit(Consumer<ShellControl> pc)
ShellControl	onFail(Consumer<Throwable> t)
ShellControl	onInit(Consumer<ShellControl> pc)
default CommandControl	osascriptCommand(String script)
String	prepareIntermediateTerminalOpen(String content, String displayName)
String	prepareTerminalOpen(String displayName)
void	restart()
ShellControl	start()
ShellControl	startTimeout(int ms)
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)

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

close, closeStdin, getCharset, getShellDialect, getStderr, getStderrReader, getStdin, getStdout, getStdoutReader, isRunning, isStdinClosed, kill, resetData, write, writeLine

Method Details

isLocal

default boolean isLocal()

getSystemId

UUID getSystemId()

getCommandLock

Semaphore getCommandLock()

onInit

ShellControl onInit(Consumer<ShellControl> pc)

onExit

ShellControl onExit(Consumer<ShellControl> pc)

onFail

ShellControl onFail(Consumer<Throwable> t)

elevateCommand

ElevationResult elevateCommand(String input)
                        throws Exception

Throws:

Exception

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(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)
                              throws Exception

Throws:

Exception

restart

void restart()
      throws Exception

Throws:

Exception

getOsType

OsType getOsType()

getElevationConfig

ElevationConfig getElevationConfig()

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(String cmds)

initWith

ShellControl initWith(List<String> cmds)

startTimeout

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

command

default CommandControl command(List<String> command)

command

default CommandControl command(CommandBuilder builder)

exitAndWait

void exitAndWait()
          throws IOException

Throws:

IOException