Skip to main content

 Advanced

Advanced topics

Berlioz global properties

The Berlioz global configuration file is a simply a list of properties for the content generators running in Berlioz.

/WEB-INF/config/config-[mode].xml

Properties defined this way are available in the content generators using the GlobalSettings class.

Predefined Berlioz properties

The following properties are defined by Berlioz.

NameTypeDefaultDescription
berlioz.http.compressionBooleantrueTo allow Berlioz to use HTTP compression when possible
berlioz.http.get-via-postBooleantrueTo forward HTTP POST requests to GET is there is no specific service for POST
berlioz.http.max-ageInteger60The default maximum age in seconds of cacheable content
berlioz.errors.handleBooleantrueTo allow Berlioz handle errors (they are sent to Web container
berlioz.errors.generator-catchBooleantrueTo catch errors thrown by generators
berlioz.xslt.cacheBooleantrueTo enable the caching of XSLT templates
berlioz.xml.parse-strictBooleantrueTo throw XML/XSLT errors even for warnings
berlioz.control-keyString""Specifies a control Key: a string required to use Berlioz global

File format

There are three possible file formats for the global properties settings, they are the following:

Simple XML file

This is a minimal representation with the property name generated by concatenating the attribute with the parent element and the attribute value being the value of the property. The <document> element is ignored.

For example:

<global>
  <myapp test="abc" acme="true"/>
</global>

creates the following property:

NameValue
myapp.acmetrue
myapp.testabc

XML properties file

This is a terse representation of the properties in XML:

<?xml version="1.0"?>
<!DOCTYPE service-config PUBLIC "-//Berlioz//DTD::Properties 1.0//EN"
           "http://www.weborganic.org/schema/berlioz/properties-1.0.dtd">
<properties>
  <root>
    <map/>
    <!-- Berlioz Global settings -->
    <node name="myapp">
      <map>
        <entry key="test" value="abc"/>
        <entry key="acme" value="true"/>
      </map>
    </node>
  </root>
</properties>

 Unless you have a specific reason, always use the Simple XML format.

Properties file

It is also possible to use a conventional properties file format.

myapp.test=abc
myapp.acme=true
Created on , last edited on