Module io.xpipe.core

Package io.xpipe.core.store

Interface ShellStore

All Superinterfaces:

DataStore

All Known Subinterfaces:

MachineStore

All Known Implementing Classes:

LocalStore

public interface ShellStore
extends DataStore

Method Summary

Modifier and Type	Method	Description
ShellProcessControl	create()
default ShellType	determineType()
static boolean	isLocal(ShellStore s)
static MachineStore	local()
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

Method Details

local

static MachineStore local()

isLocal

static boolean isLocal(ShellStore s)

create

ShellProcessControl create()

determineType

default ShellType 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