Nuxeo Server

Session and Transaction Management

Updated: October 13, 2017 Page Information Edit on GitHub

Transaction Management

By default WebEngine will automatically start a transaction for any request to a JAX-RS application (or WebEngine module). The default locations of static resources are omitted (so that no transaction will be started when requesting a static resource). The static resources locations is */skin/* — this will match any path that targets a resource inside a skin directory in a JAX-RS application.

You may want to adapt the transaction timeout per-request. In that case, you should specify in the HTTP headers the timeout value in seconds using the header Nuxeo-Transaction-Timeout.

Session Management

WebEngine provides a managed CoreSession to any JAX-RS resource that wants to connect to the repository. WebEngine will close the managed CoreSession when no more needed (at the end of the request) so you should not worry about leaks. This session can be used either in a JAX-RS resource method, or in JAX-RS a MessageBodyReader or MessageBodyWriter.

To get the managed CoreSession from a JAX-RS resource you can use the following code:


If you don't have access to the current HTTP request object you can use this code (in that case a ThreadLocal variable will be used to retrieve the UserSession):


Then using the UserSession object you can get either the current Principal or a CoreSession:

UserSession userSession = WebEngine.getActiveContext().getUserSession();
Principal principal = userSession.getPrincipal();
CoreSession session1 = userSession.getCoreSession();
CoreSession session2 = userSession.getCoreSession("myrepo");

When calling the getCoreSession() method and no managed CoreSession was yet created for the target repository then a new CoreSession is created and returned. If a CoreSession already exists then it is returned.

You can see that there are two flavors of getCoreSession() method:

  • getCoreSession()
  • getCoreSession(String repositoryName)

The first one is returning a session for the default repository. The second one will return a session for the given repository. By default the getCoreSession() method will use the default repository as configured in Nuxeo server, but you can change the repository that will be used on a request basis. See next section for how to change the default repository used by this method.

Note that the UserSession object is available only in the context of a WebEngine request (i.e., inside JAX-RS applications or WebEngine modules).

Selecting the Default Repository

You can choose from the client side which will be the repository used to create a managed CoreSession. To do this you can either use an HTTP request header:

Repository: myrepo

or a request parameter:


If not specified the default repository defined by the Nuxeo server will be used.

Cleaning Up at the End of the Request

Some JAX-RS resources will need to create temporary files or open other system resources that cannot be removed in the JAX-RS method because they are used by a MessageBodyWriter. In that case you can register a cleanup handler that will be invoked at the request end (after all JAX-RS objects finished their work and response was sent to the servlet output stream).

To register a cleanup handler you can do the following:

UserSession.addRequestCleanupHandler(httpRequest, new RequestCleanupHandler() {
    public void cleanup(HttpServletRequest httpRequest) {

The cleanup method will be invoked after the request is processed and the response created.

Configuring Transaction Management on a Path Basis

You can also configure how the transaction is managed on a subset of resources in your JAX-RS application. To do this you can contribute an extension as follows:

<extension target="org.nuxeo.ecm.webengine.WebEngineComponent" point="request-configuration">
  <path value="/mymodule1" autoTx="false" />
  <path value="/mymodule2/resources" autoTx="true" />
  <path value="/mymodule3/.*\.gif" autoTx="false" regex="true"/>

The first rule says that for any resource which path begins with "/mymodule1" then automatic transaction is off. The second one says that for any resource which path begins with "/mymodule2/resources" then automatic transaction is true. The third rule says that for any .gif file inside "/mymodule3" automatic transaction is off.

By default the value attribute represent a path prefix. If you want to use a regular expression you must specify regex="true".

The recommended way to define rules is to use prefixes and not regular expression.

Path Rule Matching

All the contributed path matching rules will be ordered from the longest path to the shortest one in lexicographical order. Regular expression rules will be always put after the prefix based rules (i.e. prefix based rules are stronger). Then to find the best matching rule, the path rules are iterated until a match occurs.

Paths specified in a rule must begin with a / (if not, a / will be automatically added by WebEngine). These paths are matched against the HttpServletRequest path info (which will always begin with a /).

For example, given the following path matching rule contributions:


they will be ordered as follow:


Therefore for the URL path /a/b the first match will be /a, and this rule will be used to define the transaction management for this resource.

Using Custom Exception Mapper

When using a custom exception mapper implementation, don't forget to add the transaction rollback flagging TransactionHelper.setTransactionRollbackOnly();.

This flag is needed to tell to org.nuxeo.ecm.platform.web.common.requestcontroller.filter.NuxeoRequestControllerFilter, which does handle the TransactionManagement, to take care of the rollback.

5 days ago manonlumeau NXDOC-1346-FT review screenshot
a year ago Solen Guitter 15
2 years ago Solen Guitter 14
2 years ago Vladimir Pasquier 13
2 years ago Vladimir Pasquier 12
2 years ago Vincent Dutat 11
2 years ago Solen Guitter 10 | Update table of contents look
4 years ago Solen Guitter 9
4 years ago Solen Guitter 8 | Added TOC and related topics
4 years ago Florent Guillaume 7
5 years ago Stéphane Lacoin 6
6 years ago Solen Guitter 4
6 years ago Solen Guitter 5 | Migrated to Confluence 4.0
7 years ago Bogdan Stefanescu 3
7 years ago Bogdan Stefanescu 2
7 years ago Bogdan Stefanescu 1
History: Created by Bogdan Stefanescu