maX Properties Tutorial

Contents

Introduction
Sample
File Syntax
Concepts

Introduction

Das maX Properties System dient zur Verwaltung von Konfigurationseinstellungen in Java Projekten. Da das System keinerlei Abhängigkeiten zu anderen Libraries besitzt, kann es sowohl bei Client als auch Serversystem verwendet werden. Das Properties System ist ab Java 1.3.1 lauffähig.

Für die Verwendung des Properties System muss das JAR File "properties.jar" eingebunden werden. In Server Anwendungen muss das properties.jar im EAR Classloader, WAR Classloader oder EJB Classloader eingebunden werden. Dementsprechend darf dass JAR "properties.jar" bei Serverandwendungen nicht Teil des System Classloaders sein.

Sample

Properties werden in einfachen Textdatein verwaltet. Die Textdatein unterstützen die syntaktischen Möglichkeiten von java.util.Properties Datein. Das Properties System lädt die Properties bei Bedarf vollautomatisch. Das System muss nicht konfiguriert werden. Anstatt einer Konfiguration muss allerdings ein Naming Pattern befolgt werden. Das Properties System sucht während der Initialisierung nach einer Datei mit dem Namen "root.properties". Diese Datei wird über den Classloader des Properties System geladen und muss sich im Root eines JAR oder des WEB-INF/classes Verzeichnis befinden.

Die root.properties kann nun Property Definition enthalten oder andere Property Datein inkludieren. Größere Projekte mit vielen Properties sollten im root File nur Includes auf weitere Property Datein enthalten. Kleinere Projekte können durchaus alle Properties im root File definieren.

Beispiel für ein root.properties File:

#
# Sample root property file
# 

# a property which is defined in the root property file
at.spardat.properties.sample=Hello World!

File Syntax