XmlBlaster Logo



XmlBlaster Logo

Type NEW
Priority LOW
Topic XmlBlaster provides a property file to allow a simple configuration

The xmlBlaster.properties file allows to customize the behavior of xmlBlaster.

Here we describe he sequence by which xmlBlaster looks into the file system to find the properties file.

To monitor the lookup sequence (outputs with System.out), use the property property.debug, whereat 0=nothing, 1=info and 2=trace.

java -Dproperty.verbose=2 ...
java -Dproperty.verbose=2 org.xmlBlaster.Main

java MyApp -property.verbose 2

Some plugins can be configured both in the xmlBlaster.properties file and in the xmlBlasterPlugins.xml file. Normally plugins which are loaded by the runlevel manager are defined in the xmlBlasterPlugins.xml file, while such plugins which are loaded dynamically are defined and configured in the xmlBlaster.properties file. There are however cases where the plugins can be loaded in either ways, for instance if a plugin fulfils two different purposes and implements different plugin interfaces for example one which is loaded dynamically as the I_PublishFilter and an I_Plugin which is loaded by the runlevel manager. For such cases you can -and in some cases you must- define the plugin in either files. The parameters/properties/attributes of the plugin however should only be defined in one of the two files.

If you define it in both -in the xmlBlaster.properties file by specifying data after the comma (',') and in the xmlBlasterPlugins.xml by having attribute subtags, you will get a warning and the properties in the xmlBlasterPlugins.xml will be ignored.

Location Example Comment
user.dir /opt/xmlBlaster The current directory
-propertyFile /tmp/xy.properties full property file name (complete with path)
-pluginsFile /tmp/plugins.xml full plugins-property file name (complete with path)
http:// or ftp:// file:xy.properties Supports downloading a configuration or resource file, for example http://www.xmlblaster.org/xmlBlaster/config/xmlBlaster.properties.template
PROJECT_HOME java -DPROJECT_HOME=/opt/xmlBlaster global property
user.home /home/joe Your home directory
CLASSPATH lib/xmlBlaster.jar:/opt/classes.zip The complete given classpath
java.ext.dirs /opt/jdk1.2.2/jre/trb/ext Your JVM installations ext directory
java.home /opt/jdk1.2.2/jre/trb Your JVM installation (JAVA_HOME)

Example to force the configuration files:

java org.xmlBlaster.Main -propertyFile somewhere/xmlBlaster.properties -pluginsFile somewhere/plugins.xml


NOTE: Configuration parameters are specified on command line (-someValue 17) or in the xmlBlaster.properties file (someValue=17). See requirement "util.property" for details.
Columns named Impl tells you if the feature is implemented.
Columns named Hot tells you if the configuration is changeable in hot operation.

See REQ util.property.env
See API org.xmlBlaster.util.property.Property
See TEST org.xmlBlaster.test.AllTests

This page is generated from the requirement XML file xmlBlaster/doc/requirements/util.property.xml

Back to overview