Package io.deephaven.kv.routing

Class RoutingFileContext

java.lang.Object

io.deephaven.kv.KeyPathContextBase

io.deephaven.kv.meta.AtomicDirectoryContext

io.deephaven.kv.files.FileContext

io.deephaven.kv.routing.RoutingFileContext

All Implemented Interfaces:

GetPrefixResponseParser<Optional<RoutingFile>>, Context, KeyPathContext, KeyValuesCollectionParser<Optional<RoutingFile>>

@Reusable
public class RoutingFileContext
extends FileContext
implements GetPrefixResponseParser<Optional<RoutingFile>>

A single-file KeyPath model for a routing file.

Models the data in RoutingFile

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RoutingFileContext.Builder
static enum	RoutingFileContext.Description	The description is composed of the DISCONFIGS entry.
static interface	RoutingFileContext.GetRoutingFile
static interface	RoutingFileContext.RoutingFileListener	A stateful watch listener interface for RoutingFile.

Nested classes/interfaces inherited from class io.deephaven.kv.files.FileContext

FileContext.File, FileContext.GetFileRequest

Nested classes/interfaces inherited from class io.deephaven.kv.meta.AtomicDirectoryContext

AtomicDirectoryContext.AtomicUpdateWrt, AtomicDirectoryContext.MetaDescription

Field Summary

Fields

Modifier and Type	Field	Description
static final KeyPathContextDescription.Entry<FilesContext,RoutingFileContext>	DISCONFIGS	An entry for the FilesContext, with the part "disconfigs"

Fields inherited from class io.deephaven.kv.files.FileContext

FILE, NAME

Fields inherited from class io.deephaven.kv.meta.AtomicDirectoryContext

META, META_PART, parent

Fields inherited from class io.deephaven.kv.KeyPathContextBase

context, description

Method Summary

Modifier and Type	Method	Description
RoutingFileContext.Builder	builder()
RoutingFileContext.Builder	builder(String user, String code, Instant timestamp, String comment)
ConfigContext	getConfigContext()
RoutingFileContext	getContext()	The context where the parser will look for data in the response
FilesContext	getDisConfigsContext()
String	getPreferredFileName()
RoutingFileContext.GetRoutingFile	getRoutingFileRequest()
RoutingFileContext.GetRoutingFile	getRoutingFileRequest(long modRev)
@NotNull Optional<RoutingFile>	parse(@NotNull KeyValuesCollection response)	Parse the key values into an object.
CompletableFuture<WatchClient.Watch>	watch(KVClient kvClient, WatchClient watchClient, RoutingFileContext.RoutingFileListener listener)

Methods inherited from class io.deephaven.kv.files.FileContext

asFile, asPuts, atomic, entry

Methods inherited from class io.deephaven.kv.meta.AtomicDirectoryContext

asDelete, atomic, atomicDelete, atomicDeleteChildren, expectNewWrtThis, expectUpdateWrtThis, getMetaInfoContext, getMetaInfoContext, getReadPermissions, getReadWritePaths, getReadWritePermissions, isLowestLevelAtomicDirectory, isMetaPart, isNotMeta, parseDirectoryListing, parseDirectoryListingStream, parseDirectoryListingStreamToSubset, watch, watch, watch, wrtAtomicConditionIsTrueHandleUs

Methods inherited from class io.deephaven.kv.KeyPathContextBase

equals, getDescription, getPath, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.kv.common.GetPrefixResponseParser

checkContext, getPrefix, parse

Methods inherited from interface io.deephaven.kv.KeyPathContext

resolve

Field Details

DISCONFIGS

public static final KeyPathContextDescription.Entry<FilesContext,RoutingFileContext> DISCONFIGS

An entry for the FilesContext, with the part "disconfigs"

Method Details

getDisConfigsContext

public FilesContext getDisConfigsContext()

getConfigContext

public ConfigContext getConfigContext()

getPreferredFileName

public String getPreferredFileName()

parse

@NotNull
public @NotNull Optional<RoutingFile> parse(@NotNull
 @NotNull KeyValuesCollection response)

Description copied from interface: KeyValuesCollectionParser

Parse the key values into an object.

Implementations should throw appropriate exceptions if any assumed preconditions for the keyPathCollection are not met.

Specified by:

parse in interface KeyValuesCollectionParser<Optional<RoutingFile>>

Parameters:

response - the key values

Returns:

the non-null parsed object

getContext

public RoutingFileContext getContext()

Description copied from interface: GetPrefixResponseParser

The context where the parser will look for data in the response

Specified by:

getContext in interface GetPrefixResponseParser<Optional<RoutingFile>>

getRoutingFileRequest

public RoutingFileContext.GetRoutingFile getRoutingFileRequest()

getRoutingFileRequest

public RoutingFileContext.GetRoutingFile getRoutingFileRequest(long modRev)

builder

public RoutingFileContext.Builder builder()

builder

public RoutingFileContext.Builder builder(String user,
 String code,
 Instant timestamp,
 String comment)

watch

public CompletableFuture<WatchClient.Watch> watch(KVClient kvClient,
 WatchClient watchClient,
 RoutingFileContext.RoutingFileListener listener)