Module io.xpipe.core

Package io.xpipe.core.store

Interface ValidatableStore

All Superinterfaces:

DataStore

All Known Subinterfaces:

ShellStore

All Known Implementing Classes:

LocalStore

public interface ValidatableStore
extends DataStore

Method Summary

Modifier and Type	Method	Description
default void	validate()	Performs a validation of this data store.

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

asNeeded, checkComplete, isComplete, isInStorage

Method Details

validate

default void validate()
               throws Exception

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.

Throws:

Exception - if any part of the validation went wrong