Nuxeo Server

Using the Java API Server-Side

Updated: December 19, 2017 Page Information Edit on GitHub

This page explains how to use the Nuxeo Java API.

Java Services

The Nuxeo Platform contains a built-in notion of service. Services are Java interfaces exposed and implemented by a Component.

From within a Nuxeo Runtime aware context, you can access a service locally (in the same JVM) by simply looking up its interface with Framework#getService(T):

RelationManager rm = Framework.getService(RelationManager.class)

You can find the list of existing services on the Nuxeo Platform Explorer. You will also need to understand main Java classes, using the javadoc.

You must not store the service itself as a field of a long-running component in Nuxeo, as this would prevent proper hot-reloading.


Typical Use Cases

You may want to use this API from:

  • A Seam component when customizing the default webapp,
  • An Event Listener that would do some specific things,
  • A custom operation that would use the built-in services,
  • ...
a month ago manonlumeau NXDOC-1395: Review 'Using the Java API Server-Side'
a month ago Manon Lumeau add tags for doc days
2 months ago manonlumeau Added content-review-lts2017 label
3 months ago manonlumeau NXDOC-1346-FT review screenshot
2 years ago Manon Lumeau 11
2 years ago Manon Lumeau 10
2 years ago Florent Guillaume 9
3 years ago Manon Lumeau 8 | TOC
4 years ago Vincent Dutat 7
4 years ago Solen Guitter 6
4 years ago Alain Escaffre 5
4 years ago Alain Escaffre 4
4 years ago Alain Escaffre 3
4 years ago Alain Escaffre 1
4 years ago Alain Escaffre 2
History: Created by Alain Escaffre