Glossary

You will find here a useful list of concepts and definitions used by Berlioz.

Created on , last edited on

A

Aeson
The Aeson format defines a transformation from XML to JSON that Berlioz uses to generate JSON.
App
Short for Web application.

B

Bastille
Bastille is a Java library that includes a collection of general purpose generators for caching, indexing and reading PSML and XML files. This library is planned for deprecation in 2016.
Berlioz
Although Berlioz is actually a Java server-side component, the term is often used more broadly to describe the library that contains it, a Web application that uses it or the server that hosts it.
Berlioz admin
An administration console for Berlioz to check the configuration, files, caching, logs and general performance of a Berlioz application.
Berlioz logs
Berlioz logs record events reported by the application and are accessible on the Berlioz administrator interface.
Berlioz mode
The Berlioz mode is a special immutable configuration value that Berlioz uses to determine which set of configuration files it should load.
Berlioz path
The path used by Berlioz to match URLs against a URI pattern to determine which service it corresponds to.
Berlioz status
Status that can be returned from generators and services and corresponding the HTTP parameters.
Bridge
The bridge is a Java library providing an API for accessing PageSeeder Web service API. There is also a Java library extended the bridge in the context of a Berlioz application called berlioz-bridge.
Bundler
The bundler is a feature of Berlioz that automatically associates styles and scripts to a service and bundles them in an efficient manner for Web delivery.

C

Control key
A mechanism to restrict usage of the global parameters.

F

Final output
The output of a Berlioz service after transformation. It can be of different media types or character encoding, but typically include HTML, XML or JSON.
Firefox extension
We've developed a Firefox extension for Berlioz which can be downloaded from Mozilla:
Flint
An open source indexing library based on Lucene.

G

Generator
A generator is a server-side component written in Java which produces an XML response from a content request. Berlioz libraries provide a number of built-in generators for common use cases.
Global parameters
Special parameters that can be used for any service providing instructions for Berlioz.

H

HTTP Caching
Whenever it can, Berlioz generates entity tags (ETags) so it can take advantage of HTTP caching. This is done automatically.

J

Java
Java is the language used to write generators and the functional aspects of a Berlioz application.
Jetty
A servlet engine and HTTP server where most Berlioz applications are deployed.
Jetty context
The Jetty context files are used to configure your Web app in Jetty. It not necessary to define it but is more convenient to better control your application

K

Kickstart
Kickstart is a simple library that can be included in a Berlioz app to define the standard mapping and default fallback templates in a Berlioz application.

L

Logging
Berlioz provide several logging options.

N

Nginx
NginX (pronounced "engine x") is a reverse proxy server that can be used with Berlioz to increase the performance and scalibity of a Berlioz Web application.
NoContent generator
A generator which does not return any content. It is the default generator used when no class is specified for a generator in services.xml.

P

Principal XSLT module
The XSLT module that is called directly by Berlioz is the principal module. It is defined by your Berlioz configuration.

R

Raw output
The XML output of a Berlioz service prior to transformation. It is always application/xml using utf-8.

S

Service
A Berlioz service is a single server-side component triggered when matching one of more URI patterns  for a specific HTTP method and returning a response from a list of generators.
Standard file layout
Berlioz uses a standard layout for the files and directories in a Berlioz app, using the convention over configuration philosophy.
Standard mapping
The standard mapping defines which file extensions are associated with Berlioz in a Web application.  It is the Servlet mapping used by Kickstart.

U

URI pattern
A URI pattern is a notation that is used to match a URI. It is used by Berlioz to determine which service should be triggered when receiving HTTP requests.

W

Web descriptor
The Web descriptor located at /WEB-INF/web.xml describes a Web application. It can be used to customize the Berlioz servlet or define additional components that are part of the Berlioz library.

X

XSLT
XSLT is the language used by Berlioz to transform the XML response from services into the response content to send back to the HTTP client.
XSLT module
A file using the .xsl extension and containing an XSLT stylesheet.