WebEngine (JAX-RS)

WebEngine Tutorials

Updated: October 16, 2020

In this section we will go deeper into WebEngine model by proposing 5 samples on how to use common WebEngine concepts.

To install the sample modules you need to download the compiled jar and copy them s to a <NXSERVER>/plugins directory. <NXSERVER> is the jboss/server/default/deploy/nuxeo.ear directory on JBoss distribution or the root nxserver directory on other distributions.

To correctly understand the tutorials you need to look into all .java and .ftl files you find in the corresponding sample modules. Each sample is well documented in the corresponding classes using java docs.

You should download the binaries and sources (https://maven.nuxeo.org/nexus/index.html#nexus-search;gav~~nuxeo-webengine-samples*~~~) from our Maven repository.

Tutorial 1 - Hello World.

This tutorial demonstrates how to handle requests. This is the simplest object. It requires only one java class which represents the Resource (the entry point).

You can access the tutorial sample at:  http://NUXEO_SERVER/nuxeo/site/samples/hello

Tutorial 2 - Using Templates

This tutorial demonstrates how to use templates to render dynamic content.

You can access the tutorial sample at: http://NUXEO_SERVER/nuxeo/site/samples/templating

Tutorial 3 - Web Object Model

This tutorial demonstrates the basics of the WebEngine Object Model. You can see how to create new Module Resources, Object Resources, Adapter Resources and views.

You can access the tutorial sample at: http://NUXEO_SERVER/nuxeo/site/samples/basics

Tutorial 4 - Working with Documents

This tutorial demonstrates how to access Nuxeo Platform Documents through WebEngine. You can access the tutorial sample at: http://NUXEO_SERVER/nuxeo/site/samples/documents

Tutorial 5 - Module Extensibility

This tutorial demonstrates how modules can be extended and how the links you are using in your templates can be managed to create easy to maintain and modular applications.

You can access the tutorial sample at: http://NUXEO_SERVER/nuxeo/site/samples/extended

We'd love to hear your thoughts!

All fields required