org.forgerock.config.resolvers

Class FlatFileResolver

java.lang.Object

org.forgerock.config.resolvers.FlatFileResolver

All Implemented Interfaces:

PropertyResolver

public class FlatFileResolver
extends Object
implements PropertyResolver

A PropertyResolver in which each property is stored in its own file in some directory. The entire contents of the file (as UTF-8) is returned as the value of the property. For efficiency and consistency with the other property resolvers, the contents of files are cached in-memory. A maximum size of 2MB is imposed on files, and any file larger than this will be ignored.

Constructor Summary

Constructors

Constructor and Description
FlatFileResolver(Path rootDirectory) Initializes the resolver with the given root directory and an empty suffix.
FlatFileResolver(Path rootDirectory, String suffix) Initializes the resolver with the given root directory.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getProperty(String key) Returns the value of the specified property.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.config.resolvers.PropertyResolver

getProperty

Constructor Detail

FlatFileResolver

public FlatFileResolver(Path rootDirectory,
                        String suffix)

Initializes the resolver with the given root directory.

Parameters:

rootDirectory - the root directory to resolve files relative to.

suffix - a suffix to append to property names such as a file extension, for instance ".txt" (note: include the dot in this case).

FlatFileResolver

public FlatFileResolver(Path rootDirectory)

Initializes the resolver with the given root directory and an empty suffix.

Parameters:

rootDirectory - the root directory to resolve files relative to.

Method Detail

getProperty

public Optional<String> getProperty(String key)

Description copied from interface: PropertyResolver

Returns the value of the specified property. The method returns an empty Optional if the property is not found.

Specified by:

getProperty in interface PropertyResolver

Parameters:

key - The name of the requested property. The key can't be null.

Returns:

An Optional string that contains the value of the requested property, or empty Optional if property is undefined.

toString

public String toString()

Overrides:

toString in class Object