Page tree
Skip to end of metadata
Go to start of metadata

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.

Webapps provided by Magnolia

Magnolia provides the following webapps. Some of them include Tomcat.

Artifact

   Download  

   With STK based demo  

   With travel demo  

   With EE Standard modules  

   With EE Pro modules  

   With Apache Tomcat  

Usage / purposeModules summary 1
Community edition

magnolia-empty-webapp

     This is the most basic Magnolia webapp. Use this as a base for custom tailored webapp.Core modules from main and ui, Activation, cache (core and ehcache), Pages, Resources, Security and Scheduler.

magnolia-community-webapp

     Complete Magnolia community edition webapp; no demo project.Same as magnolia-empty-webapp plus:
Cache tools,  Cache Browser, Categorization, Commenting, Contacts, DAM , Form, Google sitemap, Groovy, Mail, Messages, MTE , REST and Site.

magnolia-community-demo-webapp

 (tick)   Same as magnolia-community-webapp plus the travel demo Travel demo community edition 2

magnolia-bundled-webapp

 

 

(tick)   (warning) Deprecated - use magnolia-community-demo-webapp instead!
magnolia-community-demo-bundle
 (tick)  
Tomcat-bundle including magnolia-bundled-webapp and travel demoTravel demo community edition 2

magnolia-tomcat-bundle

  (tick)  
(warning) Deprecated - use magnolia-community-demo-bundle instead!

Enterprise standard edition

magnolia‑enterprise‑standard‑webapp

  (tick)  Same as magnolia-community-webapp plus Enterprise Standard modules; no demo

Backup, Content Dependencies, Content Translation Support, Diff, Google Analytics, Marketing Tags, Personalization, Soft Locking, Transactional Activation and Workflow.

magnolia‑enterprise‑standard‑demo‑webapp

 (tick)(tick)  Same as magnolia‑enterprise‑standard‑webapp plus the travel demoTravel demo Enterprise Standard edition 3
Enterprise pro edition  

magnolia-enterprise-pro-webapp

  (tick)(tick) magnolia-enterprise-standard-webapp plus Enterprise Pro module(s); no demo

Backup, Content Dependencies , Content Translation Support , Diff , Google Analytics, Marketing Tags , Personalization , Soft Locking , Transactional Activation  and Workflow.

Multisite

magnolia-enterprise-pro-stk-webapp

(tick) (tick)(tick) Same as magnolia-enterprise-pro-webapp plus the STK demoAll modules from magnolia-enterprise-pro-webapp plus STK based demo 5

magnolia-enterprise-pro-stk-bundle

(tick) (tick)(tick)
Tomcat bundle including magnolia-enterprise-pro-stk-webapp with STK demoAll modules from magnolia-enterprise-pro-webapp plus STK based demo 5
magnolia-enterprise-pro-demo-webapp
 (tick)(tick)(tick) magnolia-enterprise-pro-webapp plus the travel demoTravel demo enterprise pro edition 4

magnolia-enterprise-webapp

  (tick)(tick)(tick) (warning) Deprecated - use magnolia-enterprise-pro-demo-webapp instead!
magnolia-enterprise-pro-demo-bundle
 (tick)(tick)(tick)
Tomcat bundle with magnolia-enterprise-webapp including travel demoTravel demo Enterprise Pro edition 4
magnolia-enterprise-installer

 (tick)(tick)(tick)
Installer for magnolia-enterprise-pro-demo-bundle

magnolia-enterprise-bundle

  (tick)(tick)(tick)
(warning) Deprecated - use magnolia-enterprise-pro-demo-bundle instead!

magnolia-enterprise-weblogic-webapp

 (tick)(tick) 6(tick) Webapp based on magnolia-enterprise-webapp including travel demo; tuned for Weblogic without workflow 6Travel demo Enterprise Pro edition 4

magnolia-enterprise-websphere-webapp

 (tick)(tick) 6(tick) Webapp based on magnolia-enterprise-webapp including travel demo; tuned for Websphere without workflow 6Travel demo Enterprise Pro edition 4

(1) The module summary does not list exactly all modules but provides a good summary. To get the complete list of the modules please have careful look at the corresponding pom file of the bundle.
(2) Travel demo community edition contains the following modules: magnolia-travel-demo, magnolia-travel-tours.
(3) Travel demo enterprise standard edition contains the following modules: magnolia-travel-demo, magnolia-travel-tours, magnolia-travel-demo-personalization, magnolia-travel-demo-marketing-tags.
(4) Travel demo enterprise pro edition contains the following modules: magnolia-travel-demo, magnolia-travel-tours, magnolia-travel-demo-personalization, magnolia-travel-demo-marketing-tags, magnolia-travel-demo-multisite.
(5) Complete STK bundle with the modules magnolia-module-standard-templating-kit, magnolia-theme-pop and magnolia-demo-project.
(6) Both magnolia-enterprise-weblogic-webapp and magnolia-enterprise-websphere-webapp contain all enterprise standard and pro modules but not those for workflow.

 

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:

<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>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>INCLUDE</dispatcher>
    <dispatcher>ERROR</dispatcher>
</filter-mapping>

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>
    <listener-class>
    info.magnolia.cms.servlets.MgnlServletContextListener
    </listener-class>
</listener>

The listener initializes the system, starts the repository and modules, while the filter handles all requests.