com.launchdarkly.sdk.server.integrations

Class FileData.FileSynchronizerBuilder

java.lang.Object

com.launchdarkly.sdk.server.integrations.FileData.FileSynchronizerBuilder

All Implemented Interfaces:

DataSourceBuilder<Synchronizer>

Enclosing class:

FileData

public static final class FileData.FileSynchronizerBuilder
extends java.lang.Object
implements DataSourceBuilder<Synchronizer>

Builder for creating an FDv2 Synchronizer that loads and watches file data.

This class is not stable, and not subject to any backwards compatibility guarantees or semantic versioning. It is in early access. If you want access to this feature please join the EAP. https://launchdarkly.com/docs/sdk/features/data-saving-mode

Method Summary

Modifier and Type	Method and Description
FileData.FileSynchronizerBuilder	autoUpdate(boolean autoUpdate) Specifies whether the data source should watch for changes to the source file(s) and reload flags whenever there is a change.
Synchronizer	build(DataSourceBuildInputs context) Builds a data source instance based on the provided context.
FileData.FileSynchronizerBuilder	classpathResources(java.lang.String... resourceLocations) Adds any number of classpath resources for loading flag data.
FileData.FileSynchronizerBuilder	duplicateKeysHandling(FileData.DuplicateKeysHandling duplicateKeysHandling) Specifies how to handle keys that are duplicated across files.
FileData.FileSynchronizerBuilder	filePaths(java.nio.file.Path... filePaths) Adds any number of source files for loading flag data, specifying each file path as a Path.
FileData.FileSynchronizerBuilder	filePaths(java.lang.String... filePaths) Adds any number of source files for loading flag data, specifying each file path as a string.
FileData.FileSynchronizerBuilder	shouldPersist(boolean shouldPersist) Configures whether file data should be persisted to persistent stores.

Methods inherited from class java.lang.Object

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

Method Detail

shouldPersist

public FileData.FileSynchronizerBuilder shouldPersist(boolean shouldPersist)

Configures whether file data should be persisted to persistent stores.

By default, file data is not persisted (shouldPersist = false).

Set this to true if you want the SDK to persist flag data to persistent stores. This isn't the recommended configuration but may be useful for testing scenarios.

Example:

     FileData fd = FileData.synchronizer()
         .filePaths("./testData/flags.json")
         .shouldPersist(true);
 

Parameters:

shouldPersist - true if file data should be persisted to persistent stores, false otherwise

Returns:

the same FileSynchronizerBuilder instance

filePaths

public FileData.FileSynchronizerBuilder filePaths(java.lang.String... filePaths)
                                           throws java.nio.file.InvalidPathException

Adds any number of source files for loading flag data, specifying each file path as a string.

Parameters:

filePaths - path(s) to the source file(s); may be absolute or relative to the current working directory

Returns:

the same builder

Throws:

java.nio.file.InvalidPathException - if one of the parameters is not a valid file path

See Also:

FileDataSourceBuilder.filePaths(String...)

filePaths

public FileData.FileSynchronizerBuilder filePaths(java.nio.file.Path... filePaths)

Adds any number of source files for loading flag data, specifying each file path as a Path.

Parameters:

filePaths - path(s) to the source file(s); may be absolute or relative to the current working directory

Returns:

the same builder

See Also:

FileDataSourceBuilder.filePaths(Path...)

classpathResources

public FileData.FileSynchronizerBuilder classpathResources(java.lang.String... resourceLocations)

Adds any number of classpath resources for loading flag data.

Parameters:

resourceLocations - resource location(s) in the format used by ClassLoader.getResource()

Returns:

the same builder

See Also:

FileDataSourceBuilder.classpathResources(String...)

autoUpdate

public FileData.FileSynchronizerBuilder autoUpdate(boolean autoUpdate)

Specifies whether the data source should watch for changes to the source file(s) and reload flags whenever there is a change.

Parameters:

autoUpdate - true if flags should be reloaded whenever a source file changes

Returns:

the same builder

See Also:

FileDataSourceBuilder.autoUpdate(boolean)

duplicateKeysHandling

public FileData.FileSynchronizerBuilder duplicateKeysHandling(FileData.DuplicateKeysHandling duplicateKeysHandling)

Specifies how to handle keys that are duplicated across files.

Parameters:

duplicateKeysHandling - specifies how to handle duplicate keys

Returns:

the same builder

See Also:

FileDataSourceBuilder#duplicateKeysHandling(DuplicateKeysHandling)

build

public Synchronizer build(DataSourceBuildInputs context)

Description copied from interface: DataSourceBuilder

Builds a data source instance based on the provided context.

Specified by:

build in interface DataSourceBuilder<Synchronizer>

Parameters:

context - the context for building the data source

Returns:

the built data source instance