Description

Some best practice.

Index

Key-Name

Use unique and meaningful names for your Keys (like your package-Name) e.g.: "com/mycompany/myapp/myKeyForNumberFormatting"

Or at least your AppName: e.g.: "MyPowerApp/myKeyForTheFormularToSolvingEveryThing"

Customized settings4j.xml

settings4j.xml (accurate to log4j.xml) must be availabel inside the classpath. But DO NOT put it into the resulting JAR of a Sub-Library.

  • On Webapps it could be placed on the Server (e.g.: %TOMCAT_HOME%/common/classes/).
  • On commandline apps it should be placed on the FileSystem which is included into the classpath (e.g.: -cp ./config/ )
  • For UnitTests, you can but it into /src/test/resources/ (Maven Folder Structure)

What SHOULD be configured with Settings4j

Applikation specific configurations like third part Server adresses.

  • Datasource (Settings4j supports also environments without JNDI-Context)
  • Webservice URLs
  • Filesystem paths (e.g.: import/export of Files or temporary usage)
  • system mail addresses (e.g.: customer service mail address)

Everything who should be differ from Development-, Testing- and Production-System, but changes never (or at least rarely) after deploying.

What SHOULD NOT be configured with Settings4j

Webapp-User specific configurations like personal preferences have nothing to do with settings4j !