All Classes and Interfaces
Class
Description
An abstract implementation of Decryptor.
An abstract implementation of Encryptor.
Allows a
Config object to access the contents of the properties, providing utility methods to perform
consequent operations.The cipher this library ships: AES-256/GCM over a passphrase, behind the name
aes-gcm.Checks a configuration's values with
Bean Validation - the annotations everybody already writes,
@Min, @NotNull, @Pattern and the rest - so that they
mean something on a method named the way this library teaches.A unit of byte size, such as "512 kilobytes".
Reads a
ByteSize from a value such as 10 MB.Represents the possible standards that a
ByteSizeUnit can have.Specifies the available byte size units that a
ByteSize can have.Utility class to create a maps, lists and sets
Marker interface that must be implemented by all Config sub-interfaces.
Specifies a
ConverterCollection
returned by the method, in a single step.Specifies a
ConverterShows, through
Accessible and Object.toString(), only the properties this interface
declares.The default
Decryptor for every Config.EncryptedValue of this interface that does not name
one of its own, so that a whole configuration can share a decryptor.Default value to be used if no property is found.
What this property is for, in a sentence, written where the property is declared.
This enum contains the features that can be disabled using the annotation
Config.DisableFeature.Specifies to disable some of the features supported by the API.
Declares that this method's value is encrypted, and is to be decrypted by the
Decryptor named
here or, when none is, by the one the interface declares with Config.DecryptorClass.Specify that the class implements hot reloading of properties from filesystem baked
Config.Sources (hot
reloading can't be applied to all types of URIs).Allows to specify which type of HotReload should be applied.
The key used for lookup for the property.
Specifies the policy for loading the properties files.
Specifies the policy type to use to load the
Config.Sources files for properties.Marks a property as mandatory.
Specifies a prefix that is prepended to the keys of all the properties declared in the annotated
interface.
Specifies a
PreprocessorMarks a property as sensitive, so that its value is replaced by
Config.Sensitive.MASK in the output
meant to be read by a human: Accessible.list(java.io.PrintStream),
Accessible.list(java.io.PrintWriter) and toString().Specifies simple
StringSpecifies the source from which to load the properties file.
Specifies a
TokenizerUtility class caching Config instances that can be used as Singletons.
A static factory class to instantiate
Config instances.Thrown when a configuration is created and its values do not satisfy the constraints its methods declare.
Checks the constraint annotations of a configuration, which the core can see but cannot check.
One property to be checked: the method that carries the constraints, the key it resolved to, the value it
answered with, and the configuration object it belongs to.
Recognises a Bean Validation constraint by name, which is how the core can know that a
configuration carries constraints while depending on no validation API at all.
Converter interface specifies how to convert an input string coming from a property value to a target object returned
by the Config method.
A decryptor is a class which is able to decrypt a value.
A
loader able to read a .env file, the format that container tooling has made the
commonest way to carry configuration into a process.A duration converter for the OWNER configuration system.
Reads the duration strings that OWNER accepts, in either of two formats:
the ISO-8601 format that
Duration.parse(CharSequence) supports, recognised by a
leading P with an optional plus/minus prefix;
a "value time_unit" string, where value is an integer and
time_unit is one of ns, us, ms, s,
m, h, d or one of their longer spellings.An encryptor is a class which is able to encrypt and decrypt a value.
Turns values into the markers that go in a configuration file, with either of the two ciphers.
The rules by which a
DotEnvLoader reads a .env file.What to make of a line that names a variable without assigning anything to it, as in a bare
HOME on a line of its own.The root event class for all OWNER events.
Interface for factory implementation used to instantiate
Config instances.IdentityDecryptor is a no-op decryptor: it accepts a value and returns the same value for both decrypting and encrypting.
The rules by which an
IniLoader reads an INI file.What to make of a name on a line of its own, with no separator after it.
How a value may be continued on the line after it.
What to make of a key that appears more than once in the same section.
Whether a key is taken as written or folded.
Whether the quotes around a value delimit it or belong to it.
What separates a key from its value.
A
loader for INI files: sections in square brackets, key = value below them.Reads a single JNDI entry into a value:
A
loader that reads the properties bound under a JNDI context:A
loader for JSON, reading a source whose path ends in .json.Defines the interface of a generic Properties loader.
Thrown when a property marked as
Config.Mandatory cannot be resolved: at creation time, listing all
the missing keys, or at access time when the property has become unavailable.Allows a
Config object to change its property values at runtime.Where a property came from: which of the
sources produced it, or whether it was an
import, a Config.DefaultValue or something written at run time.What kind of place a property came from.
Preprocessor interface specifies how to pre-process an input string coming from a property value before being used by
OWNER.
A
loader able to read properties from standard Java properties files.How a tree becomes flat property keys, in one place.
The reflection this library needs and the JDK differences behind it: whether a method is a
default one, how to invoke it on each baseline, and whether a class is on the class path.Allows a
Config object to implement the reloading of the properties at runtime.A semantic event which indicates that a reload occurred.
The listener interface for receiving reload events.
Indicates that whole batch of event must be rolled back.
Superclass for event rollback.
Indicates that operation must be rolled back.
The asymmetric cipher: RSA-OAEP over AES-256/GCM, behind the name
rsa-oaep.The options written on a single source, and the one place every
Loader reads them from.One
name=setting pair written on a source.Allows specifying
system:properties and system:env with the @Sources annotation.Writes the properties file of a mapping interface, from the command line, without running the
application it belongs to.
Tokenizer interface that specifies how to split a single value into tokens to be used as elements for arrays and
collections.
Allows a
Config object to say where each of its properties came from.A Listener that is aware of properties changes, with transactional capability.
A Listener that is aware of properties reloads, with transactional capability.
This class contains utility methods used all over the library.
Abstraction over system properties and environment access, to allow overriding it in tests.
Abstraction over the source of the current time, to allow overriding it in tests.
Turns the payload of a
${$name::payload} marker into the value that replaces it.One constraint that a property value did not satisfy.
A
loader able to read properties from standard XML Java properties files, as well as user defined
XML properties files.A
loader that reads the properties from the children of a ZooKeeper node, addressed with
the zookeeper scheme: