Module io.xpipe.core

Package io.xpipe.core.store

Interface ShellStore

All Superinterfaces:

DataStore, FileSystemStore, LaunchableStore, StatefulDataStore

All Known Implementing Classes:

LocalStore

public interface ShellStore
extends DataStore, StatefulDataStore, LaunchableStore, FileSystemStore

Method Summary

Modifier and Type	Method	Description
default ShellControl	create()
ShellControl	createControl()
default FileSystem	createFileSystem()
static ShellStore	createLocal()
default ShellDialect	determineType()
default Charset	getCharset()
default OsType	getOsType()
default ShellDialect	getShellType()
static boolean	isLocal(ShellStore s)
default String	prepareLaunchCommand()
default String	queryMachineName()
default void	validate()	Performs a validation of this data store.

Methods inherited from interface io.xpipe.core.store.DataStore

asNeeded, canOpen, checkComplete, delete, determineDefaultName, determineLastModified, getFlow, isComplete, isContentExclusivelyAccessible, shouldPersist, shouldSave

Methods inherited from interface io.xpipe.core.store.StatefulDataStore

getOrComputeState, getState, setState

Method Details

createLocal

static ShellStore createLocal()

isLocal

static boolean isLocal(ShellStore s)

createFileSystem

default FileSystem createFileSystem()

Specified by:

createFileSystem in interface FileSystemStore

prepareLaunchCommand

default String prepareLaunchCommand()
                             throws Exception

Specified by:

prepareLaunchCommand in interface LaunchableStore

Throws:

Exception

create

default ShellControl create()

getShellType

default ShellDialect getShellType()

getOsType

default OsType getOsType()

getCharset

default Charset getCharset()

createControl

ShellControl createControl()

determineType

default ShellDialect determineType()
                            throws Exception

Throws:

Exception

validate

default void validate()
               throws Exception

Description copied from interface: DataStore

Performs a validation of this data store.

This validation can include one of multiple things: - Sanity checks of individual properties - Existence checks - Connection checks

All in all, a successful execution of this method should almost guarantee that the data store can be successfully accessed in the near future.

Note that some checks may take a long time, for example if a connection has to be validated. The caller should therefore expect a runtime of multiple seconds when calling this method.

Specified by:

validate in interface DataStore

Throws:

Exception - if any part of the validation went wrong

queryMachineName

default String queryMachineName()
                         throws Exception

Throws:

Exception