Webapp

A Java Web Application (webapp) is a collection of servlets, other Java classes, static resources such as HTML pages, other resources, and meta information that describes the webapp bundled together. You can run a webapp on a servlet container. A Java webapp has a typical structure.

It can be packaged as a WAR file. A webapp usually contains already packed portions called libraries or modules as JAR files.

List of webapps

Magnolia provides the following stand-alone, pre-configured Apache Tomcat server that does not include a webapp:

Artifact Download Usage

magnolia-tomcat-barebone

Nexus

A preconfigured Tomcat server ready to be used with any Magnolia webapp.

Magnolia provides the following webapps and bundles.

To get the complete list of the modules in each webapp or bundle, look at the corresponding POM file of the bundle.

DX Core

Artifact Usage

dx-core-webapp

This is the DX Core webapp for projects. Use dx-core-webapp for local Magnolia Cloud development. (If you are a partner, see dx-core-cloud-webapp below).

Add a tomcat-bundle classifier to use with Apache Tomcat

travel-demo-webapp

DX Core webapp plus the Travel Demo for evaluation purposes.

Add a tomcat-bundle classifier to use with Apache Tomcat.

dx-core-cloud-webapp

For internal and partner cloud Magnolia usage.

Partners should use dx-core-cloud-webapp for local Magnolia Cloud development or when creating a custom cloud bundle for a customer
Use dx-core-webapp for local Magnolia Cloud development.

Community

Artifact Usage

magnolia-empty-webapp

This is the most basic Magnolia webapp. Use this as a basis for your custom webapp.

magnolia-community-webapp

Complete Magnolia Community Edition webapp for community projects.

travel-demo-community-webapp

Community Edition webapp plus the Travel Demo for evaluation purposes.

travel-demo-community-webapp with tomcat

Community Edition webapp plus the Travel Demo for evaluation purposes bundled with Apache Tomcat.

Webapp directory structure

The directory structure is the container that holds the components of a webapp. The first step in creating a Magnolia webapp is creating this structure. The following table describes what each directory should contain.

Path Contents

cache/

Files with cached content.

docroot/

Files extracted from mgnl-files/docroot in the JAR.

logs/

Magnolia log files.

META-INF/

Meta information files, e.g., from Maven.

repositories/

Repository.

templates/

Templates extracted from mgnl-files/templates in the JAR.

tmp/

Temporary work directory.

WEB-INF/

All resources related to the application that are not in the document root. WEB-INF directory is not part of the public document.

No files contained in this directory can be served directly to a client.

WEB-INF/bootstrap

Bootstrap files. Empty by default.

WEB-INF/bootstrap/common

Bootstrapped on author and public instances.

WEB-INF/bootstrap/author

Bootstrapped on author instance only.

WEB-INF/bootstrap/public

Bootstrapped on public instance only.

WEB-INF/classes

Class path for manually deployed classes.

WEB-INF/config

Configuration files for repository and properties.

WEB-INF/config/default

Configuration files.

WEB-INF/config/default/magnolia.properties

Properties such as: repository location, persistence manager to be used, should samples be bootstrapped, should installation be done in unattended mode etc.

WEB-INF/config/default/repositories.xml

Defines repository configuration.

WEB-INF/config/default/log4j.xml

Log4j logging configuration.

WEB-INF/config/magnoliaAuthor

Properties used on author instance only.

WEB-INF/config/magnoliaPublic

Properties used on public instance only.

WEB-INF/config/repo-config/typeOfPM.xml

Persistence manager configuration files.

WEB-INF/config/jaas.config

Configuration for authentication and authorization.

WEB-INF/lib

JAR files.

WEB-INF/web.xml

Deployment descriptor. Describes configuration information for the entire web application.

Adding the Magnolia main filter to the webapp

The Magnolia main filter is registered in the web.xml file. The file only defines one filter:

web.xml
<filter>
    <display-name>Magnolia global filters</display-name>
    <filter-name>magnoliaFilterChain</filter-name>
    <filter-class>info.magnolia.cms.filters.MgnlMainFilter
    </filter-class>
</filter>
<filter-mapping>
    <filter-name>magnoliaFilterChain</filter-name> (1)
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>INCLUDE</dispatcher>
    <dispatcher>ERROR</dispatcher>
</filter-mapping>
1 The Magnolia main filter will delegate the request to the Magnolia filter chain. The filter is also mapped to forward requests, which means that the Magnolia filter chain will be re-executed on internal forwards.

Adding the Magnolia context listener

In web.xml we also register one listener:

<listener> (1)
    <listener-class>
    info.magnolia.cms.servlets.MagnoliaServletContextListener
    </listener-class>
</listener>
1 The listener initializes the system, starts the repository and modules, while the filter handles all requests.
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules