Package org.aeonbits.owner

package org.aeonbits.owner

The goal of OWNER API is to minimize the code required to handle application configuration through Java properties files.

The approach used by OWNER APIs, is to define a Java interface associated to a properties file.

Suppose your properties file is defined as ServerConfig.properties:

  port=80
  hostname=foobar.com
  maxThreads=100
  

To access this property you need to define a convenient Java interface in ServerConfig.java:

  public interface ServerConfig extends Config {
      int port();
      String hostname();

      @DefaultValue("42");
      int maxThreads();
  }
  

We'll call this interface the Properties Mapping Interface or just Mapping Interface since its goal is to map Properties into a an easy to use piece of code.

Owner has a lot of features and its behavior is fully customizable to your needs.

Have a look at the full documentation from the OWNER website.

Related Packages

Package	Description
org.aeonbits.owner.converters	The converters this library ships for types its own conversion rules do not already cover: a Duration and a ByteSize.
org.aeonbits.owner.crypto	The seam through which a decryptor of yours is called: what Config.EncryptedValue and Config.DecryptorClass name, and the base classes that save an implementation from writing the same two methods.
org.aeonbits.owner.event	Provides interfaces and classes for dealing with different types of events fired by OWNER components.
org.aeonbits.owner.handlers	Provides the interface of a value handler, which resolves a ${$name::payload} marker into the value that replaces it, and the handlers OWNER ships.
org.aeonbits.owner.loaders	Provides interfaces and classes to allow OWNER to load properties from several file formats.
org.aeonbits.owner.util	Provides utility interfaces and classes.
org.aeonbits.owner.validation	The seam through which a Bean Validation provider checks a configuration, and the vocabulary the core uses to talk about constraints without depending on a validation API.

Class	Description
Accessible	Allows a Config object to access the contents of the properties, providing utility methods to perform consequent operations.
Config	Marker interface that must be implemented by all Config sub-interfaces.
Config.CollectionConverterClass	Specifies a Converter class to convert the property value into the Collection returned by the method, in a single step.
Config.ConverterClass	Specifies a Converter class to allow the user to define a custom conversion logic for the type returned by the method.
Config.DeclaredOnly	Shows, through Accessible and Object.toString(), only the properties this interface declares.
Config.DecryptorClass	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.
Config.DefaultValue	Default value to be used if no property is found.
Config.Description	What this property is for, in a sentence, written where the property is declared.
Config.DisableableFeature	This enum contains the features that can be disabled using the annotation Config.DisableFeature.
Config.DisableFeature	Specifies to disable some of the features supported by the API.
Config.EncryptedValue	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.
Config.HotReload	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).
Config.HotReloadType	Allows to specify which type of HotReload should be applied.
Config.Key	The key used for lookup for the property.
Config.LoadPolicy	Specifies the policy for loading the properties files.
Config.LoadType	Specifies the policy type to use to load the Config.Sources files for properties.
Config.Mandatory	Marks a property as mandatory.
Config.Prefix	Specifies a prefix that is prepended to the keys of all the properties declared in the annotated interface.
Config.PreprocessorClasses	Specifies a Preprocessor class to allow the user to define a custom logic to pre-process the property value before being used by the library.
Config.Sensitive	Marks 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().
Config.Separator	Specifies simple String as separator to tokenize properties values specified as a single string value, into elements for vectors and collections.
Config.Sources	Specifies the source from which to load the properties file.
Config.TokenizerClass	Specifies a Tokenizer class to allow the user to define a custom logic to split the property value into tokens to be used as single elements for vectors and collections.
ConfigCache	Utility class caching Config instances that can be used as Singletons.
ConfigFactory	A static factory class to instantiate Config instances.
Converter<T>	Converter interface specifies how to convert an input string coming from a property value to a target object returned by the Config method.
Factory	Interface for factory implementation used to instantiate Config instances.
MissingMandatoryPropertyException	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.
Mutable	Allows a Config object to change its property values at runtime.
Origin	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.
Origin.Kind	What kind of place a property came from.
Preprocessor	Preprocessor interface specifies how to pre-process an input string coming from a property value before being used by OWNER.
Reloadable	Allows a Config object to implement the reloading of the properties at runtime.
TemplateTool	Writes the properties file of a mapping interface, from the command line, without running the application it belongs to.
Tokenizer	Tokenizer interface that specifies how to split a single value into tokens to be used as elements for arrays and collections.
Traceable	Allows a Config object to say where each of its properties came from.