Module io.xpipe.core

Package io.xpipe.core.store

Interface ShellStore

All Superinterfaces:

DataStore, FileSystemStore, LaunchableStore, ValidatableStore

All Known Implementing Classes:

LocalStore

public interface ShellStore
extends DataStore, LaunchableStore, FileSystemStore, ValidatableStore

Method Summary

Modifier and Type	Method	Description
ShellControl	control()
default FileSystem	createFileSystem()
static boolean	isLocal(ShellStore s)
default ProcessControl	prepareLaunchCommand()
default void	validate()	Performs a validation of this data store.

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

asNeeded, checkComplete, isComplete, isInStorage

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

canLaunch

Method Details

isLocal

static boolean isLocal(ShellStore s)

createFileSystem

default FileSystem createFileSystem()

Specified by:

createFileSystem in interface FileSystemStore

prepareLaunchCommand

default ProcessControl prepareLaunchCommand()
                                     throws Exception

Specified by:

prepareLaunchCommand in interface LaunchableStore

Throws:

Exception

control

ShellControl control()

validate

default void validate()
               throws Exception

Description copied from interface: ValidatableStore

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 ValidatableStore

Throws:

Exception - if any part of the validation went wrong