Configuration Files

Overview

As mentioned in the Starting Out page, the Common Framework ConfigurationManager class provides support for configuration (.properties) file used to customize applications built on the Common Framework. This page provides details on the syntax of those configration files.

Configuration File Syntax

The syntax of Common Framework configuration files is approximately that of Java Properties files, but differs in the following details:

• Additional features/capabilities are supported, specifically those provided by Apache Commons Configuration, the underlying library used to read the configuration files.
• Configuration file authors should escape (by prefixing with a backslash, '', character) the following characters when they appear in a property value:
  • Backslash: \
  • Open and close parentheses: (, )
  • Open and close square bracket: [, ]
  • Dollar sign: $
  • Equals sign: =