Nuxeo DMS

Nuxeo Document Management -
Version 5.3
The Reference guide
5.3
Copyright © 2000-2010, Nuxeo SA.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
Documentation License, Version 1.2; with Invariant Section “Commercial Support”, no Front-Cover Texts, and
no Back-Cover Texts. A copy of the license is available at the URL: http://www.gnu.org/copyleft/fdl.html
Table of Contents
I. Introduction .................................................................................................................................. 1
1. Preface ................................................................................................................................. 2
1.1. What this Book Covers ............................................................................................... 2
1.2. What this book doesn't cover ....................................................................................... 2
1.3. Target Audience ......................................................................................................... 2
1.4. About Nuxeo ............................................................................................................. 3
1.5. About Open Source .................................................................................................... 3
2. Introduction .......................................................................................................................... 4
2.1. Enterprise Content Management .................................................................................. 4
2.1.1. Why ECM? ..................................................................................................... 4
2.2. The Nuxeo ECM platform .......................................................................................... 4
2.3. Introduction FAQ ....................................................................................................... 4
2.3.1. What are Nuxeo EP 5, Nuxeo EP and Nuxeo RCP? ........................................... 4
2.4. Intended audience ...................................................................................................... 4
2.5. What this book covers ................................................................................................ 4
3. Getting Started ...................................................................................................................... 6
3.1. Overview ................................................................................................................... 6
3.2. Prerequisites .............................................................................................................. 6
3.3. Eclipse Plugins v Command Line ................................................................................ 7
3.4. Learning from the project sample ................................................................................ 7
3.5. Setting up the sample project ...................................................................................... 7
3.5.1. Some handy environment settings ..................................................................... 7
3.5.2. Checking the sample project out of mercurial .................................................... 8
3.5.3. Initialize the Eclipse workspace ........................................................................ 8
3.5.4. Setting up your project for importing into Eclipse .............................................. 8
3.5.5. Importing the sample project into Eclipse .......................................................... 9
3.5.6. Running JUnit tests on the sample code ............................................................ 9
3.5.7. Building the jar file from the sample project ...................................................... 9
3.5.8. Deploying the jar file to the Nuxeo server ......................................................... 9
3.5.9. Starting the nuxeo server .................................................................................. 9
3.5.10. Viewing your changes via the UI .................................................................. 10
3.5.11. Using Ant ................................................................................................... 11
3.6. Understanding the sample code ................................................................................. 12
3.6.1. Two types of changes .................................................................................... 12
3.6.2. The layout of our sample project .................................................................... 12
3.6.3. A bit about extension points ........................................................................... 13
3.6.4. Declaring the 'Book' document type ................................................................ 14
3.6.5. Displaying book documents ........................................................................... 17
3.6.6. Actions, tabs and behavior ............................................................................. 22
3.6.7. Making book documents indexable and searchable .......................................... 24
3.6.8. Enabling drag&drop creation (plus creating our own extension points) ............. 26
3.6.9. Regulating book states ................................................................................... 29
3.6.10. Workflow .................................................................................................... 30
3.6.11. Listening for events ..................................................................................... 30
3.7. Starting a new project ............................................................................................... 32
3.8. Using Documentation ............................................................................................... 33
3.9. Other IDEs: IntelliJ IDEA and NetBeans ................................................................... 33
3.9.1. IDEA ............................................................................................................ 33
3.9.2. NetBeans ...................................................................................................... 33
4. General Overview ............................................................................................................... 34
4.1. Introduction ............................................................................................................. 34
4.1.1. Architecture Goals ......................................................................................... 34
4.1.2. Main concepts and design .............................................................................. 37
4.2. Nuxeo 5 Architecture Overview ................................................................................ 39
4.3. Nuxeo Runtime: the Nuxeo EP component model ...................................................... 40
4.3.1. The motivations for the runtime layer ............................................................. 40
4.3.2. Extensible component model .......................................................................... 41
Nuxeo EP 5.3 ii
Nuxeo Document Management - Version 5.3
4.3.3. Flexible deployment system ........................................................................... 44

4.4. Nuxeo EP layered architecture .................................................................................. 45
4.4.1. Layers in Nuxeo EP ....................................................................................... 45
4.4.2. API and Packaging impacts ............................................................................ 47
4.5. Core Layer overview ................................................................................................ 47
4.5.1. Features of Nuxeo Core ................................................................................. 48
4.5.2. Nuxeo Core main modules ............................................................................. 49
4.5.3. Schemas and document types ......................................................................... 49
4.5.4. The life cycle associated with documents ........................................................ 50
4.5.5. Security model .............................................................................................. 51
4.5.6. Core events system ........................................................................................ 51
4.5.7. Query system ................................................................................................ 52
4.5.8. Versioning system ......................................................................................... 52
4.5.9. Repository and SPI Model ............................................................................. 52
4.5.10. DocumentModel .......................................................................................... 52
4.5.11. Proxies ........................................................................................................ 53
4.5.12. Core API ..................................................................................................... 54
4.6. Service Layer overview ............................................................................................ 54
4.6.1. Role of services in Nuxeo EP architecture ....................................................... 54
4.6.2. Services implementation patterns .................................................................... 54
4.6.3. Platform API ................................................................................................. 55
4.6.4. Adapters ....................................................................................................... 56
4.6.5. Some examples of Nuxeo EP services ............................................................. 56
4.7. Web presentation layer overview ............................................................................... 56
4.7.1. Technology choices ....................................................................................... 56
4.7.2. Componentized web application ..................................................................... 57
5. Schemas and Documents ..................................................................................................... 60
5.1. Introduction ............................................................................................................. 60
5.1.1. Concepts ....................................................................................................... 60
5.2. Schemas .................................................................................................................. 60
5.3. Core Document Types .............................................................................................. 61
5.4. ECM Document Types ............................................................................................. 61
5.4.1. Label and Icon .............................................................................................. 62
5.4.2. Default view ................................................................................................. 62
5.4.3. Layout .......................................................................................................... 62
5.4.4. Containment rules ......................................................................................... 63
5.4.5. Hidden cases ................................................................................................. 63
5.4.6. Summary ...................................................................................................... 63
II. Platform Services ....................................................................................................................... 65
6. Exception Handling ............................................................................................................ 66
6.1. Introduction ............................................................................................................. 66
6.2. Extension Points ...................................................................................................... 66
6.2.1. requestdump ................................................................................................. 66
6.2.2. listener .......................................................................................................... 66
6.2.3. errorhandlers ................................................................................................. 66
7. Actions, Views, Navigation URLs and JSF tags .................................................................... 68
7.1. Introduction ............................................................................................................. 68
7.2. Actions .................................................................................................................... 68
7.2.1. Concepts ....................................................................................................... 68
7.2.2. Manage actions ............................................................................................. 68
7.3. Views ...................................................................................................................... 71
7.3.1. UI Views ...................................................................................................... 71
7.3.2. Manage views ............................................................................................... 71
7.4. Navigation URLs ..................................................................................................... 72
7.4.1. Document view codec service ........................................................................ 72
7.4.2. URL policy service ........................................................................................ 73
7.4.3. Additional configuration ................................................................................ 74
7.4.4. URL JSF tags ................................................................................................ 74
7.5. Nuxeo Document Lists Manager ............................................................................... 75
7.6. Nuxeo File Manager ................................................................................................. 76
7.7. Nuxeo JSF tags ........................................................................................................ 76
8. Layouts .............................................................................................................................. 78
Nuxeo EP 5.3 iii

8.1. Introduction ............................................................................................................. 78

8.1.1. Layouts ......................................................................................................... 78
8.1.2. Widgets ........................................................................................................ 78
8.1.3. Widget types ................................................................................................. 78
8.1.4. Modes .......................................................................................................... 78
8.2. Manage layouts ........................................................................................................ 78
8.2.1. Layout registration ........................................................................................ 79
8.2.2. Layout definition ........................................................................................... 79
8.2.3. Widget definition .......................................................................................... 80
8.2.4. Listing layout definition ................................................................................. 81
8.2.5. EL expressions in layouts and widgets ............................................................ 83
8.3. Document layouts .................................................................................................... 84
8.4. Layout display ......................................................................................................... 84
8.5. Standard widget types ............................................................................................... 85
8.5.1. text ............................................................................................................... 85
8.5.2. int ................................................................................................................. 85
8.5.3. secret ............................................................................................................ 85
8.5.4. textarea ......................................................................................................... 85
8.5.5. datetime ........................................................................................................ 85
8.5.6. template ........................................................................................................ 86
8.5.7. file ................................................................................................................ 86
8.5.8. htmltext ........................................................................................................ 86
8.5.9. selectOneDirectory ........................................................................................ 86
8.5.10. selectManyDirectory .................................................................................... 86
8.5.11. list .............................................................................................................. 86
8.5.12. checkbox ..................................................................................................... 86
8.6. Custom templates ..................................................................................................... 86
8.6.1. Custom layout template ................................................................................. 86
8.6.2. Listing template ............................................................................................ 88
8.6.3. Custom widget template ................................................................................. 89
8.6.4. Builtin templates to handle complex properties ................................................ 90
8.7. Custom widget types ................................................................................................ 92
8.8. Generic layout usage ................................................................................................ 93
9. Event Listeners and Scheduling ........................................................................................... 94
9.1. Introduction ............................................................................................................. 94
9.2. Concepts .................................................................................................................. 94
9.3. Adding an event listener ........................................................................................... 94
9.4. Upgrading an event listener ....................................................................................... 95
9.5. Adding an event ....................................................................................................... 95
9.6. From CoreEvents to JMS Messages ........................................................................... 95
9.7. Adding a JMS message listener ................................................................................. 96
9.8. Scheduling ............................................................................................................... 97
10. User Notification Service ................................................................................................... 98
10.1. Introduction ........................................................................................................... 98
10.2. Notification concept ............................................................................................... 98
10.3. Notification channels .............................................................................................. 98
10.4. E-mail notifications ................................................................................................ 98
11. Indexing & Searching ...................................................................................................... 100
11.1. Introduction ......................................................................................................... 100
11.2. Configuration ....................................................................................................... 100
11.2.1. Concepts ................................................................................................... 100
11.2.2. The indexableDocType extension point ...................................................... 100
11.2.3. The resource extension point .................................................................... 100
11.2.4. Field configuration .................................................................................... 101
11.2.5. Text fields and analyzers ............................................................................ 101
11.2.6. Boolean attributes ...................................................................................... 102
11.2.7. Schema resources and fields without configuration ...................................... 102
11.2.8. Schema resources ...................................................................................... 102
11.2.9. Automatic fields configuration ................................................................... 102
11.3. Programmatic Searching ....................................................................................... 103
11.3.1. Fields and literals ....................................................................................... 103
11.3.2. WHERE statements ....................................................................................... 103
Nuxeo EP 5.3 iv
11.4. The Compass plugin ............................................................................................. 105

11.4.1. Configuring Compass ................................................................................ 105
11.4.2. Global configuration .................................................................................. 105
11.4.3. Mappings for Nuxeo .................................................................................. 106
11.4.4. Text fields behavior ................................................................................... 107
11.5. Building a search UI with QueryModel .................................................................. 108
12. Look and feel .................................................................................................................. 109
12.1. Introduction ......................................................................................................... 109
12.2. Principle .............................................................................................................. 109
12.3. Mechanism .......................................................................................................... 109
12.3.1. The Elements ............................................................................................ 110
12.3.2. The format ................................................................................................ 110
12.3.3. The negotiation ......................................................................................... 111
12.3.4. The engine ................................................................................................ 112
12.3.5. Resource management ............................................................................... 112
12.3.6. Application ............................................................................................... 113
12.4. Customizing the theme ......................................................................................... 113
12.4.1. Modifying the current theme using theme-default.xml ............................... 113
12.4.2. Modifying the current theme ...................................................................... 116
12.4.3. Adding a new theme and its pages .............................................................. 117
13. Authentication, Users & Groups Management ................................................................... 120
13.1. Introduction ......................................................................................................... 120
13.2. Users and Groups configuration ............................................................................ 120
13.2.1. Schemas .................................................................................................... 120
13.2.2. Directories ................................................................................................ 121
13.2.3. UserManager ............................................................................................. 121
13.2.4. User Management Interface ........................................................................ 123
13.3. Authentication ...................................................................................................... 127
13.3.1. Authentication Framework Overview .......................................................... 127
13.3.2. Pluggable JAAS Login Module .................................................................. 127
13.3.3. Pluggable Web Authentication Filter ........................................................... 129
14. Security Policy Service .................................................................................................... 136
14.1. Introduction ......................................................................................................... 136
14.2. Architecture ......................................................................................................... 136
14.3. Policy contributions .............................................................................................. 136
14.3.1. Core policy contribution ............................................................................. 136
14.3.2. Search policy contribution .......................................................................... 137
15. Workflow & jBPM .......................................................................................................... 139
15.1. Workflow in Nuxeo 5.1 ........................................................................................ 139
15.1.1. Deploying process definitions ..................................................................... 139
15.2. Workflow from Nuxeo 5.2: the jBPM Service ........................................................ 140
15.2.1. Introduction .............................................................................................. 140
15.2.2. jBPM service configuration ........................................................................ 140
15.2.3. Document management .............................................................................. 143
15.2.4. Default processes ....................................................................................... 143
15.2.5. Nuxeo jBPM How-to ................................................................................. 146
16. Document Versioning ...................................................................................................... 148
16.1. Setting the version of a document .......................................................................... 148
16.2. Modifying automatically the version of a document ................................................ 148
16.3. Accessing document from previous version ............................................................ 149
16.4. The versioning service implementation .................................................................. 149
17. Audit Service .................................................................................................................. 150
17.1. Introduction ......................................................................................................... 150
17.2. Features ............................................................................................................... 150
17.3. Architecture ......................................................................................................... 150
17.4. Retrieving entries ................................................................................................. 150
17.5. Contributing the audit service ................................................................................ 151
17.5.1. Recording new events types ....................................................................... 151
17.5.2. Recording additional informations .............................................................. 151
18. Tag Service .................................................................................................................... 152
18.1. Introduction ......................................................................................................... 152
18.2. Features ............................................................................................................... 152
Nuxeo EP 5.3 v
18.3. Architecture ......................................................................................................... 152

19. Directories and Vocabularies ........................................................................................... 154
19.1. Introduction ......................................................................................................... 154
19.2. Directory with a Relational Database Management System (SQL) server as backend 154
19.3. Directory with an LDAP server as backend ............................................................ 155
19.3.1. Server definition ........................................................................................ 155
19.3.2. Directory declaration ................................................................................. 155
19.4. Handling references between directory entries ........................................................ 156
19.4.1. References defined by a many-to-many SQL table ....................................... 156
19.4.2. Static reference as a dn-valued LDAP attribute ............................................ 156
19.4.3. Dynamic reference as a ldapUrl-valued LDAP attribute ............................... 157
19.4.4. LDAP tree reference .................................................................................. 157
19.4.5. Defining inverse references ........................................................................ 157
19.5. Combining multiple directories into a single virtual directory .................................. 157
19.5.1. Multi-directory sources .............................................................................. 157
19.5.2. Sub-directories .......................................................................................... 158
19.6. The Directory API ................................................................................................ 158
19.7. ............................................................................................................................ 158
19.7.1. Building custom option lists in forms with directories .................................. 158
19.7.2. Vocabularies/Directories management ........................................................ 160
20. Binary content ................................................................................................................ 162
20.1. Introduction ......................................................................................................... 162
20.2. Standard blob management ................................................................................... 162
20.3. External blob management .................................................................................... 162
20.4. About BlobHolder ................................................................................................ 164
21. Mimetype detection ......................................................................................................... 165
21.1. Introduction ......................................................................................................... 165
21.2. MimetypeRegistry ................................................................................................ 165
21.3. Mimetype sniffing ................................................................................................ 166
21.4. Invoking the mimetype detection ........................................................................... 168
22. Content Transformation ................................................................................................... 169
22.1. Introduction ......................................................................................................... 169
22.2. Plugins module .................................................................................................... 169
22.2.1. Creating a plugin ....................................................................................... 169
22.2.2. Declaring a plugin module ......................................................................... 169
22.2.3. Using a transform plugin ............................................................................ 170
22.3. Available transforms ............................................................................................ 171
22.3.1. Document conversion ................................................................................ 171
22.3.2. Pdfbox ...................................................................................................... 173
22.3.3. OLE objects extraction ............................................................................... 173
22.3.4. Office files merger ..................................................................................... 175
22.3.5. XSL Transformation .................................................................................. 176
23. Nuxeo Conversion Service ............................................................................................... 177
23.1. Conversion Service vs Transformation Service ....................................................... 177
23.1.1. Motivations for this API changes ................................................................ 177
23.1.2. What has been improved ............................................................................ 177
23.1.3. About compatibility ................................................................................... 177
23.2. Using Conversion Service ..................................................................................... 178
23.2.1. built-in converters ...................................................................................... 178
23.2.2. Conversion Service API ............................................................................. 178
23.2.3. Configuring the Convertion Service ............................................................ 179
23.2.4. Contributing converters .............................................................................. 179
23.2.5. Converters based on external command line tools ........................................ 180
24. Relations ........................................................................................................................ 182
24.1. Introduction ......................................................................................................... 182
24.2. Concepts .............................................................................................................. 182
24.3. Configuration ....................................................................................................... 182
24.3.1. Graph instances ......................................................................................... 182
24.3.2. Resource adapters ...................................................................................... 183
24.4. Manage relations .................................................................................................. 183
24.5. Display relations .................................................................................................. 183
24.6. Architecture overview .......................................................................................... 184
Nuxeo EP 5.3 vi
25. Placeful Configuration ..................................................................................................... 185

25.1. Introduction ......................................................................................................... 185
25.2. Using Placeful Configuration ................................................................................ 185
25.3. Contributing a placeful configuration ..................................................................... 185
25.4. Available storage .................................................................................................. 186
25.4.1. In memory storage ..................................................................................... 187
25.4.2. Directory storage ....................................................................................... 187
25.5. Exemple of extension definition ............................................................................ 187
26. Content Template Service ................................................................................................ 189
26.1. Introduction ......................................................................................................... 189
26.2. Contributing a content factory ............................................................................... 189
26.2.1. Factory Binding ......................................................................................... 189
26.2.2. Template ................................................................................................... 189
26.2.3. ACL ......................................................................................................... 190
26.3. How to Register your own Factory ........................................................................ 190
27. Nuxeo's Management Service .......................................................................................... 192
27.1. Integrating Nuxeo monitoring in your management system ..................................... 192
27.1.1. Inventory (nx:*,management=inventory) ..................................................... 192
27.1.2. Metric (nx:*,metric=*,management=metric) ................................................ 192
27.1.3. Quality (nx:*,usecase=*,management=usecase) ........................................... 192
27.2. Integrating management in nuxeo server ................................................................ 192
27.2.1. nuxeo-runtime-management ....................................................................... 192
27.2.2. nuxeo-platform-management ...................................................................... 192
27.2.3. nuxeo-webengine-management ................................................................... 193
27.3. Contributing management ..................................................................................... 193
27.3.1. Publishing ................................................................................................. 193
27.3.2. Providing shortcuts .................................................................................... 194
27.3.3. Reporting quality ....................................................................................... 195
28. Publisher Service ............................................................................................................ 196
28.1. Overview ............................................................................................................. 196
28.2. Local sections ...................................................................................................... 196
28.3. Remote sections ................................................................................................... 197
28.3.1. Server configuration .................................................................................. 197
28.3.2. Client configuration ................................................................................... 197
28.4. File system ........................................................................................................... 198
III. Core Services .......................................................................................................................... 200
29. Nuxeo Runtime ............................................................................................................... 201
29.1. Overview ............................................................................................................. 201
29.1.1. Main Goals ............................................................................................... 201
29.1.2. Main Features ............................................................................................ 201
29.2. What is OSGi? ..................................................................................................... 201
29.3. OSGi Support ...................................................................................................... 202
29.3.1. Supported Features .................................................................................... 202
29.3.2. Unsupported Features ................................................................................ 203
29.3.3. Planned Features ....................................................................................... 203
29.4. Component Model ................................................................................................ 203
29.4.1. What are components? ............................................................................... 203
29.4.2. Main Features ............................................................................................ 204
29.4.3. Planned Features ....................................................................................... 204
29.4.4. Adapting Components ............................................................................... 204
29.4.5. Flexible Model .......................................................................................... 204
29.4.6. Component Life Cycle ............................................................................... 205
29.4.7. Component Extensibility ............................................................................ 205
29.5. Supported Host Platforms ..................................................................................... 207
29.5.1. JBoss Integration ....................................................................................... 207
29.5.2. Eclipse Integration ..................................................................................... 208
29.6. Using Nuxeo Runtime .......................................................................................... 208
29.6.1. Creating Components ................................................................................. 208
29.6.2. Using components ..................................................................................... 211
29.6.3. XML Component Descriptors ..................................................................... 215
29.7. Integration tests for Nuxeo Runtime applications .................................................... 216
29.7.1. The NXRuntimeTestCase base class ........................................................... 216
Nuxeo EP 5.3 vii

29.7.2. Frequent patterns ....................................................................................... 217

29.8. Detailed Architecture ............................................................................................ 217
29.9. References ........................................................................................................... 218
30. Nuxeo Core Documentation ............................................................................................. 219
30.1. TODO: BS ........................................................................................................... 219
30.2. Overview ............................................................................................................. 219
30.2.1. Main goals ................................................................................................ 219
30.2.2. Nuxeo Core Components ........................................................................... 219
30.3. Nuxeo Core Architecture ...................................................................................... 220
30.3.1. Model Layer (or Internal API) .................................................................... 220
30.3.2. Implementation Layer ................................................................................ 220
30.3.3. Facade Layer (or Public API) ..................................................................... 220
30.3.4. Deployment .............................................................................................. 220
30.3.5. Client Session ........................................................................................... 221
30.4. The Repository Model .......................................................................................... 221
30.4.1. Document and Schemas ............................................................................. 221
30.4.2. Document Facets ....................................................................................... 222
30.4.3. Document Annotations .............................................................................. 222
30.4.4. Document Access Control .......................................................................... 223
30.4.5. Life Cycle ................................................................................................. 225
30.4.6. Query Engine ............................................................................................ 227
30.4.7. The Public API .......................................................................................... 227
30.4.8. Integration with Applications Servers ......................................................... 228
30.5. Extension Points ................................................................................................... 229
30.5.1. Session Factories ....................................................................................... 229
30.5.2. LifeCycle Managers ................................................................................... 229
31. Nuxeo Core Import / Export API ...................................................................................... 230
31.1. Export Format ...................................................................................................... 230
31.1.1. document.xml format ................................................................................. 230
31.1.2. Inlining Blobs ........................................................................................... 231
31.2. Document Pipe ..................................................................................................... 232
31.3. Document Reader ................................................................................................. 232
31.4. Document Writer .................................................................................................. 233
31.5. Document Transformer ......................................................................................... 234
31.6. API Examples ...................................................................................................... 234
31.6.1. Exporting data from a Nuxeo repository to a Zip archive .............................. 235
31.6.2. Importing data from a Zip archive to a Nuxeo repository .............................. 235
31.6.3. Export a single document as an XML with blobs inlined. ............................. 236
32. Nuxeo Event Service ....................................................................................................... 237
32.1. Nuxeo event model ............................................................................................... 237
32.1.1. Event ........................................................................................................ 237
32.1.2. EventContext ............................................................................................ 237
32.1.3. EventListener ............................................................................................ 238
32.1.4. Transactions and Events ............................................................................. 238
32.1.5. EventBundle ............................................................................................. 238
32.1.6. PostCommitEventListener .......................................................................... 238
32.2. Using Events ........................................................................................................ 239
32.2.1. Firing Events ............................................................................................. 239
32.2.2. Contributing an EventListener .................................................................... 239
32.2.3. Contributing a PostCommitEventListener ................................................... 240
32.3. JMS and Nuxeo Events ......................................................................................... 241
32.3.1. JMS integration ......................................................................................... 241
32.3.2. Enabling JMS bridge ................................................................................. 241
32.3.3. From 5.1 event model to 5.2 ....................................................................... 241
33. Experimental Topics ....................................................................................................... 243
33.1. Introduction ......................................................................................................... 243
33.2. Runtime Support for Scripting Languages .............................................................. 243
33.2.1. Introduction .............................................................................................. 243
33.2.2. Supported languages .................................................................................. 243
33.2.3. Running a Script ........................................................................................ 244
IV. SOA, Web Services and various integration solutions ................................................................ 246
34. The Nuxeo Restlet API .................................................................................................... 247
Nuxeo EP 5.3 viii

34.1. Restlet Integration ................................................................................................ 247

34.1.1. Restlet types in Nuxeo 5 ............................................................................. 247
34.1.2. Restlet URL and parameters mapping ......................................................... 247
34.1.3. Contributing a new restlet .......................................................................... 248
34.2. Nuxeo default restlets ........................................................................................... 248
34.2.1. Browse restlet ............................................................................................ 248
34.2.2. Export restlet ............................................................................................. 249
34.2.3. Lock restlet ............................................................................................... 249
34.2.4. Plugin upload restlet .................................................................................. 250
34.3. Nuxeo RestPack ................................................................................................... 251
34.3.1. Installing the RestPack ............................................................................... 251
34.3.2. Restlets included in the RestPack ................................................................ 251
34.4. Nuxeo WebEngine Restlets ................................................................................... 255
35. Nuxeo HTTP client ......................................................................................................... 256
35.1. HTTP Client Library ............................................................................................ 256
35.2. HTTP client authentication ................................................................................... 256
36. Web services .................................................................................................................. 258
36.1. Audit web service ................................................................................................. 258
36.2. Remoting web service ........................................................................................... 258
36.3. Indexing gateway service ...................................................................................... 258
36.4. Metro web services ............................................................................................... 258
37. Nuxeo JSR 168 Integration .............................................................................................. 260
37.1. Overview ............................................................................................................. 260
37.2. Testing Nuxeo Portlets .......................................................................................... 260
37.2.1. Prerequisites .............................................................................................. 260
37.2.2. Generate a sample project with nuxeo-archetype-portlet archetype ................ 261
37.2.3. Test the newly created portlet ..................................................................... 262
37.3. Developping Nuxeo Portlets .................................................................................. 262
37.3.1. NuxeoPortlet class ..................................................................................... 262
37.3.2. Project from nuxeo-archetype-portlet archetype ........................................... 262
37.3.3. portlet.xml ................................................................................................ 263
37.3.4. Restlets ..................................................................................................... 263
37.4. Available portlets ................................................................................................. 263
37.4.1. Nuxeo Search Portlet ................................................................................. 263
38. Desktop integration tools ................................................................................................. 265
38.1. Drag and drop browser extensions ......................................................................... 265
38.1.1. Server side import service: the FileManagerService ..................................... 265
38.1.2. Microsoft Internet Explorer plugin .............................................................. 265
38.1.3. Mozilla Firefox plugin ............................................................................... 265
38.2. Online document editing with LiveEdit .................................................................. 265
38.2.1. Functional overview .................................................................................. 265
38.2.2. Functional use cases .................................................................................. 266
38.2.3. Architectural overview ............................................................................... 267
38.2.4. The Web Service component ...................................................................... 270
38.2.5. More on editor launch ................................................................................ 270
38.2.6. More on pre- and post-editing actions ......................................................... 271
38.3. Configuring LiveEdit links .................................................................................... 271
38.3.1. Configuration policies ................................................................................ 271
38.3.2. Changing the configuration policy .............................................................. 272
39. Nuxeo WebDAV interface ............................................................................................... 273
39.1. WebDAV clients .................................................................................................. 273
39.1.1. Path vs displayName .................................................................................. 273
39.1.2. Filesystem resource vs Nuxeo DocumentModel artifact ............................... 273
39.1.3. MS Web Folder client ................................................................................ 273
39.2. Fooling WebDAV clients ...................................................................................... 273
39.2.1. Available hacks ......................................................................................... 274
39.2.2. Configuring Nuxeo WebDAV connector for each client. .............................. 274
39.3. Nuxeo EP WebDAV implementation ..................................................................... 274
39.3.1. Nuxeo EP WebDAV-specific features ......................................................... 275
39.3.2. Known limitations ..................................................................................... 275
39.4. Using the Nuxeo WebDAV connector ................................................................... 276
39.4.1. Installing the WebDAV connector .............................................................. 276
Nuxeo EP 5.3 ix
39.4.2. Connecting a client to Nuxeo WebDAV connector ...................................... 276

40. Reporting: Eclipse BIRT Driver ....................................................................................... 277
40.1. Overview ............................................................................................................. 277
40.2. How to use it ........................................................................................................ 277
40.3. Tomcat integration HOWTO ................................................................................. 282
41. Nuxeo Flex Connector ..................................................................................................... 284
41.1. Overview ............................................................................................................. 284
41.2. Development environment .................................................................................... 284
41.3. Build and Deploy ................................................................................................. 284
41.3.1. Sample Overview ...................................................................................... 284
41.4. Dive In ................................................................................................................ 285
41.4.1. Data Services Configuration ....................................................................... 285
41.4.2. Your First Flex application ......................................................................... 286
41.4.3. Granite DS configuration ........................................................................... 287
V. Administration overview .......................................................................................................... 288
42. OS requirements, existing and recommended configuration ............................................... 289
42.1. Required software ................................................................................................ 289
42.2. Recommended configuration ................................................................................. 289
42.2.1. Hardware configuration ............................................................................. 289
42.2.2. Default configuration ................................................................................. 289
42.2.3. For optimal performances .......................................................................... 289
42.3. Known working configurations ............................................................................. 290
42.3.1. OS ............................................................................................................ 290
42.3.2. JVM ......................................................................................................... 290
42.3.3. Storage backends ....................................................................................... 290
42.3.4. LDAP ....................................................................................................... 291
43. SMTP Server configuration ............................................................................................. 292
44. RDBMS Storage and Database Configuration ................................................................... 293
44.1. Storages in Nuxeo EP ........................................................................................... 293
44.2. Installing the JDBC driver ..................................................................................... 293
44.3. Configuring Nuxeo Core Storage ........................................................................... 293
44.3.1. Visible Content Store configuration ............................................................ 293
44.3.2. JCR backend configuration ........................................................................ 294
44.3.3. Set up your RDBMS .................................................................................. 297
44.3.4. Start Nuxeo EP .......................................................................................... 297
44.4. Configuring Storage for other Nuxeo Services ........................................................ 297
44.4.1. Configuring datasources ............................................................................. 298
44.4.2. Relation service configuration .................................................................... 299
44.4.3. Tag service configuration ........................................................................... 300
44.4.4. Compass search engine dialect configuration ............................................... 300
44.5. Setting up a new repository configuration .............................................................. 300
44.5.1. Add the new repository configuration ......................................................... 300
44.5.2. Declare the new repository to the platform .................................................. 302
45. LDAP Integration ............................................................................................................ 303
45.1. For users/groups storage backend .......................................................................... 303
46. OpenOffice.org server installation .................................................................................... 304
46.1. Installation ........................................................................................................... 304
46.1.1. Start server ................................................................................................ 304
46.1.2. Parameters ................................................................................................ 304
46.1.3. Installing an extension ............................................................................... 305
46.1.4. Notes ........................................................................................................ 305
46.2. Running OpenOffice as a Daemon ......................................................................... 305
46.2.1. Nuxeo OOo Daemon ................................................................................. 305
46.2.2. Configuring Nuxeo OOo Daemon ............................................................... 306
47. Run Nuxeo EP with a specific IP binding ......................................................................... 307
48. Backup, restore and reset ................................................................................................. 308
48.1. Backup ................................................................................................................ 308
48.2. Backup before an upgrade ..................................................................................... 309
48.3. Restore ................................................................................................................ 309
48.4. Reset ................................................................................................................... 309
49. Offline client synchronization .......................................................................................... 310
49.1. Working environment ........................................................................................... 310
Nuxeo EP 5.3 x
49.2. Use case .............................................................................................................. 310

49.3. User guide ........................................................................................................... 310
49.4. How does it work? ................................................................................................ 310
50. Replication tool ............................................................................................................... 312
50.1. Functional Objective ............................................................................................ 312
50.2. Use cases ............................................................................................................. 312
50.3. User guide ........................................................................................................... 313
50.4. How does it work? ................................................................................................ 313
50.5. Customizing the import code ................................................................................. 316
51. Monitoring Nuxeo ........................................................................................................... 317
51.1. Configure Nuxeo to use a single JMX server. ......................................................... 317
51.1.1. Configuration from Nuxeo 5.3.0 ................................................................. 317
51.1.2. Configuration for Nuxeo 5.2.0 .................................................................... 317
51.1.3. Configuration for Nuxeo before 5.2.0 .......................................................... 318
51.2. Interesting data to monitor. ................................................................................... 318
51.3. Persisting and analysing data. ................................................................................ 318
51.4. Querying the JMX server remotely ........................................................................ 318
52. The Nuxeo Shell ............................................................................................................. 320
52.1. Overview ............................................................................................................. 320
52.2. User Manual ........................................................................................................ 320
52.2.1. Command Options ..................................................................................... 322
52.2.2. Commands ................................................................................................ 323
52.3. Troubleshooting ................................................................................................... 327
52.3.1. Check listened IP ....................................................................................... 327
52.3.2. Check connected server .............................................................................. 327
52.3.3. Multi-machine case .................................................................................... 327
52.4. Extending the shell ............................................................................................... 327
52.4.1. Registering New Custom Commands .......................................................... 328
52.4.2. Java Code for the new commands ............................................................... 328
52.4.3. Building the shell plugin ............................................................................ 328
52.4.4. Deploying the shell plugin .......................................................................... 329
53. Build Nuxeo distributions from sources ............................................................................ 330
53.1. Requirements ....................................................................................................... 330
53.2. Limitations .......................................................................................................... 330
53.3. Download Nuxeo distribution sources .................................................................... 330
53.3.1. Download archive ...................................................................................... 330
53.3.2. Download sources with Mercurial ............................................................... 330
53.4. Build from sources ............................................................................................... 330
53.4.1. Available packages .................................................................................... 330
53.4.2. Usage ....................................................................................................... 331
VI. Core developer guide .............................................................................................................. 332
54. Coding and Design Guidelines ......................................................................................... 333
54.1. Introduction ......................................................................................................... 333
54.2. External Coding Standards .................................................................................... 333
54.3. Some points that need attention ............................................................................. 333
54.3.1. Java code formating ................................................................................... 333
54.3.2. XML code formatting ................................................................................ 334
54.3.3. Design ...................................................................................................... 334
54.3.4. Unit tests ................................................................................................... 335
54.3.5. Security .................................................................................................... 335
54.3.6. Naming convention .................................................................................... 336
54.3.7. Information hiding ..................................................................................... 336
54.3.8. Use modern Java features ........................................................................... 336
54.3.9. Logging .................................................................................................... 336
54.3.10. Documentation: Comments and Javadoc ................................................... 337
54.3.11. Deprecation ............................................................................................. 338
54.4. Methodology tips ................................................................................................. 339
54.4.1. Use the power of your IDE (and its plugins) ................................................ 339
54.4.2. Refactor .................................................................................................... 340
54.5. Important references ............................................................................................. 340
55. Development Tools and Process ....................................................................................... 341
55.1. Mercurial usage .................................................................................................... 341
Nuxeo EP 5.3 xi
55.1.1. Overview and online documentation ........................................................... 341

55.1.2. Nuxeo common usage ................................................................................ 341
55.1.3. Best practices ............................................................................................ 344
55.1.4. Useful scripts, commands and tips .............................................................. 344
55.1.5. Advanced usage and specific use cases ....................................................... 347
55.2. Maven usage ........................................................................................................ 348
55.2.1. Overview and online documentation ........................................................... 348
55.2.2. Generate a new project with the nuxeo-archetype-start archetype .................. 349
55.3. Code Quality with Eclipse Plugins ......................................................................... 350
55.3.1. Using Checkstyle ....................................................................................... 350
55.3.2. Using TPTP .............................................................................................. 350
55.3.3. Using FindBugs ......................................................................................... 350
55.4. Profiling with NetBeans Profiler ............................................................................ 350
55.5. NXPointDoc Documentation tool .......................................................................... 350
55.5.1. Documenting a component ......................................................................... 351
55.5.2. Creating the NxPointDoc site ..................................................................... 353
55.5.3. Browsing NxPointDoc ............................................................................... 353
55.6. Quality Assurance with continuous integration ....................................................... 353
55.6.1. Rules and means ........................................................................................ 354
55.6.2. Quality directives for Nuxeo developers ...................................................... 355
55.7. Release process .................................................................................................... 357
55.7.1. Overview .................................................................................................. 357
55.7.2. Continuous integration coverage ................................................................. 357
55.7.3. Help testing release candidates ................................................................... 358
56. Packaging Nuxeo EAR .................................................................................................... 359
56.1. Introduction ......................................................................................................... 359
56.2. Basic project structure .......................................................................................... 359
56.3. The EAR module ................................................................................................. 360
56.3.1. Assembly descriptor .................................................................................. 360
56.3.2. Add some resources ................................................................................... 363
56.4. Improve usability ................................................................................................. 363
56.4.1. Thanks to Maven ....................................................................................... 363
56.4.2. Thanks to Ant ............................................................................................ 364
56.5. Recommended multi-machine packagings .............................................................. 367
56.5.1. Bi-machine: stateful/stateless ...................................................................... 367
57. Release Management ....................................................................................................... 372
57.1. Introduction ......................................................................................................... 372
57.2. Let's release! ........................................................................................................ 372
57.2.1. Remove all dependencies on SNAPSHOT versions ...................................... 372
57.2.2. Checkout the code and clean your repository ............................................... 373
57.2.3. Test the release .......................................................................................... 373
57.2.4. Perform the release .................................................................................... 373
57.2.5. You're done ............................................................................................... 374
VII. Add-ons ................................................................................................................................ 375
58. Add-ons ......................................................................................................................... 376
58.1. Introduction ......................................................................................................... 376
59. Nuxeo Annotation Service ............................................................................................... 377
59.1. Introduction ......................................................................................................... 377
59.1.1. W3C Annotea ............................................................................................ 377
59.1.2. Logical architecture overview ..................................................................... 377
59.1.3. XPointer integration and extension. ............................................................ 377
59.2. Annotation Service Core ....................................................................................... 378
59.2.1. Overview .................................................................................................. 378
59.2.2. Implementation ......................................................................................... 378
59.2.3. Storage ..................................................................................................... 378
59.2.4. uriResolver ............................................................................................... 379
59.2.5. urlPatternFilter .......................................................................................... 379
59.2.6. metadata ................................................................................................... 379
59.2.7. permissionManager and permissionMapper ................................................. 379
59.2.8. annotabilityManager .................................................................................. 380
59.2.9. UID Generation ......................................................................................... 380
59.2.10. Event management ................................................................................... 380
Nuxeo EP 5.3 xii

59.3. NXAS Repository Plugin ...................................................................................... 380

59.3.1. Overview .................................................................................................. 381
59.3.2. Default contribution ................................................................................... 381
59.3.3. Extension Point ......................................................................................... 382
59.3.4. documentEventListener .............................................................................. 382
59.3.5. securityManager ........................................................................................ 382
59.3.6. jcrLifecycleEventId and graphManagerEventListener .................................. 382
59.4. NXAS Web .......................................................................................................... 382
59.4.1. Overview .................................................................................................. 382
59.4.2. Extension Point ......................................................................................... 382
59.4.3. Configuration ............................................................................................ 383
59.5. Annotation Service Facade .................................................................................... 383
59.6. Annotation Service HTTP Gateway ....................................................................... 383
59.6.1. Overview .................................................................................................. 383
59.7. References ........................................................................................................... 384
60. Virtual Navigation .......................................................................................................... 385
60.1. Virtual Navigation ................................................................................................ 385
60.1.1. Virtual Navigation presentation .................................................................. 385
60.1.2. Virtual Navigation configuration ................................................................ 385
61. Metadata Extraction Service ............................................................................................ 389
61.1. Introduction ......................................................................................................... 389
61.2. Metadata extraction module .................................................................................. 389
61.2.1. Defining a contribution for metadata extraction ........................................... 389
61.2.2. Specifying input parameters ....................................................................... 390
61.2.3. Chaining extractions .................................................................................. 390
61.2.4. Creating a plugin for metadata extraction .................................................... 390
61.2.5. Using a metadata extraction plugin ............................................................. 390
62. Unicity Service ............................................................................................................... 392
62.1. How does it works ? ............................................................................................. 392
62.2. What you need: .................................................................................................... 392
62.3. Configuration ....................................................................................................... 392
62.4. Snippets ............................................................................................................... 392
63. Nuxeo Mail Service ......................................................................................................... 394
63.1. Presentation ......................................................................................................... 394
63.2. Basic Use ............................................................................................................. 394
63.2.1. Configuration ............................................................................................ 394
63.3. Advanced Use ...................................................................................................... 395
64. Imaging .......................................................................................................................... 396
64.1. Introduction ......................................................................................................... 396
64.2. Imaging API ........................................................................................................ 396
64.3. Imaging transform ................................................................................................ 396
64.4. Imaging web ........................................................................................................ 396
64.5. Imaging core ........................................................................................................ 396
65. Nuxeo Preview Addon .................................................................................................... 397
65.1. Overview ............................................................................................................. 397
65.2. Installing the Preview Addon ................................................................................ 397
65.2.1. Deploy the Addon ..................................................................................... 397
65.2.2. Configure Transformers ............................................................................. 397
65.3. Extensions and Pluggability .................................................................................. 398
65.3.1. Pluggable Adapters .................................................................................... 398
65.3.2. Pluggable HTML Transformers .................................................................. 399
65.4. Previews and URLs .............................................................................................. 399
66. Nuxeo Tiling service Addon ............................................................................................ 401
66.1. Overview ............................................................................................................. 401
66.2. How tiles are defined and computed ...................................................................... 401
66.3. Installing the picture tiling Addon ......................................................................... 402
66.3.1. Requirements ............................................................................................ 402
66.3.2. Deploy the addon ....................................................................................... 403
66.3.3. Configuration ............................................................................................ 403
66.4. Testing the tiling service ....................................................................................... 403
66.4.1. URL and restAPI ....................................................................................... 403
66.4.2. simple test client ........................................................................................ 404
Nuxeo EP 5.3 xiii

67. Nuxeo DocumentLink Addon .......................................................................................... 406

67.1. Overview ............................................................................................................. 406
67.2. How does it work ................................................................................................. 406
67.3. DocumentLink and Repository .............................................................................. 407
67.4. Using DocumentLink ........................................................................................... 407
67.4.1. Using the adapter ....................................................................................... 407
67.4.2. Using the DocRepository ........................................................................... 408
68. Nuxeo Search Center ....................................................................................................... 409
68.1. Overview ............................................................................................................. 409
68.2. Installing and testing the search center ................................................................... 409
68.2.1. Building from source ................................................................................. 409
68.2.2. Deploying on a Nuxeo server ..................................................................... 409
68.2.3. Using the Search Center ............................................................................. 410
68.3. How does it work ................................................................................................. 410
68.3.1. The GWT client ......................................................................................... 410
68.3.2. The JAX-RS server .................................................................................... 410
68.3.3. The SearchCenterService ........................................................................... 410
68.4. How to customize the list of available filters .......................................................... 411
68.4.1. FilterWidgets ............................................................................................ 411
68.4.2. FilterSets ................................................................................................... 411
68.5. How to build new GWT filter widgets ................................................................... 412
68.5.1. Setting up a GWT eclipse development environment ................................... 412
68.5.2. Existing filter widgets ................................................................................ 412
68.5.3. TODO: layout and extension points ............................................................ 413
VIII. Annexes ............................................................................................................................... 414
A. FAQs .............................................................................................................................. 415
A.1. Deployment and Operations ................................................................................... 415
B. Detailed Development Software Installation Instructions .................................................... 418
B.1. Installing Java ....................................................................................................... 418
B.1.1. Using the Sun Java Development Kit (Windows and linux) ........................... 418
B.1.2. Using a package management systems (Linux) ............................................. 418
B.1.3. Manual installation (Linux) ......................................................................... 419
B.1.4. Setting up JAVA_HOME (Windows, Linux, Mac OS) .................................. 419
B.2. Installing Ant ........................................................................................................ 419
B.3. Installing Maven .................................................................................................... 420
B.3.1. What is Maven? .......................................................................................... 420
B.3.2. Installing Maven ......................................................................................... 420
B.4. Installing JBoss AS ................................................................................................ 421
B.4.1. JBoss documentation ................................................................................... 421
B.4.2. Enable EJB3 support ................................................................................... 421
B.4.3. JBoss AS listening ports customization ........................................................ 421
B.4.4. Affected JBoss services ............................................................................... 424
B.5. Installing a Subversion client .................................................................................. 425
B.5.1. Generic subversion clients with linux ........................................................... 425
B.5.2. Windows .................................................................................................... 425
B.6. Installing mercurial ................................................................................................ 425
B.6.1. Linux ......................................................................................................... 425
B.6.2. Windows .................................................................................................... 425
B.6.3. Mac OS ...................................................................................................... 425
B.6.4. Setting a username ...................................................................................... 426
B.6.5. Activating pre-integrated extensions ............................................................ 426
B.6.6. Using forest ................................................................................................ 426
B.7. Chapter Key Point ................................................................................................. 426
C. Commercial Support ......................................................................................................... 428
C.1. About Us .............................................................................................................. 428
C.2. Contact information ............................................................................................... 428
C.2.1. General ...................................................................................................... 428
C.2.2. Europe ....................................................................................................... 428
C.2.3. USA .......................................................................................................... 428
Nuxeo EP 5.3 xiv

Part I. Introduction
Nuxeo EP 5.3 1
Chapter 1. Preface
Nuxeo EP is a comprehensive open source Enterprise Content Management (ECM) platform. It has been
designed to be robust, scalable and highly extensible, by using modern open source Java EE technologies, such
as JSF, EJB3, JBoss Seam, OSGi, and a Service Oriented Approach. It can be used to develop both web-based
server applications and Rich Client applications.
Nuxeo EP provides services that currently cover the following functions of the ECM spectrum:
• Document management
• Collaborative Work
• Business process management (workflow)
• Compliance
• Records management
• Digital asset management (DAM)
Thanks to the modular and service oriented nature of Nuxeo EP, it is easy to create specialized applications,
vertical or horizontal. Examples of applications that have been successfully created and used include
applications for:
• Document management
• Digital assets management (DAM)
• Case management
• Correspondence management
• News management systems for press agencies
• Museum collections management
• Etc.
1.1. What this Book Covers

The primary focus of this book it the presentation of Nuxeo EP, from the perspective of its configuration and its
architecture.
1.2. What this book doesn't cover

This book is not an end-user manual for Nuxeo DM or other applications based on the Nuxeo EP platform. If
you are interested in such a document, we recommend that you get it from http://www.nuxeo.org/.
This book is not a tutorial either. There is also a tutorial on http://www.nuxeo.org/.
1.3. Target Audience

As a reference book for the Nuxeo platform, this book has several intended audiences:
• System integrators, who need to understand how to configure and adapt the Nuxeo platform to their
customers needs.
Nuxeo EP 5.3 2
Preface
• Third-party application developers, who will typically need both to customize the behavior of some
components and to write new components to extend the functionalities of the platform.
• System administrators, who need to understand how to configure the platform for the specific needs of
their hosting environment.
• Core developers, who work on the platform and need a reference documentation.
We fully understand that these different people with different concerns, and we plan to create, thanks to the
modular structure of this document, more targeted books for these different people.
Readers of this book are presumed familiar with the Java 5 language and with the Java EE and XML
technologies.
1.4. About Nuxeo

Founded in 2000, Nuxeo SA is part of the "second wave" of open source companies, and focuses on developing
and supporting applications, instead of system software or development tools.
By entering the ECM field early in 2002, Nuxeo has established itself as the leader of open source ECM, with
customers for critical projects in the Government, Energy and Finance sectors. Nuxeo currently has 50
employees, about half of them developers.
Nuxeo has customers and partners in Europe, in Northern and Southern America, in the Middle East and in
Africa.
1.5. About Open Source

Simply put, Open source is a better way to develop and support software.
Nuxeo fully embraces the open source vision, by fostering collaboration with a community of external
contributors.
Nuxeo EP 5.3 3
Chapter 2. Introduction
This chapter will give you an overview of ECM and the motivation for using the Nuxeo platform in your next
ECM project.
2.1. Enterprise Content Management

According to the AIIM, the Association for Information and Image Management, ECM is defined as "the
technologies used to capture, manage, store, preserve, and deliver content and documents related to
organizational processes".
2.1.1. Why ECM?

A March 2005 white paper on “The Hidden Costs of Information Work” by the IDC in the United States found
that the average office employee spent approximately one day per week organizing and filing documents that
they used. This can equate to a considerable amount of cost and inefficiency. A further twelve hours was spent
on managing document approval, managing document routing and publishing to other channels. Nine hours
was spent searching for documents.
2.2. The Nuxeo ECM platform
2.3. Introduction FAQ
2.3.1. What are Nuxeo EP 5, Nuxeo EP and Nuxeo RCP?

Nuxeo EP 5 is the 5th version of the open source platforms developed by Nuxeo (the four previous ones where
known as "CPS").
Nuxeo EP or "Enterprise Platform" is the server part of Nuxeo EP 5. It is a Java EE application intended to run
in a standard Java EE 5 application server like JBoss. It can be accessed by end users from a web browser, from
office productivity suites like MS-Office or OpenOffice.org, or from rich client developed using the Nuxeo
RCP technology (see below).
Nuxeo RCP or "Rich Client Platform" is a platform for building rich client applications, that usually connect to
a Nuxeo EP server.
Nuxeo EP and Nuxeo RCP run on top of a common runtime, "Nuxeo Runtime", and share a common set of
core components, called "Nuxeo Core".
2.4. Intended audience
2.5. What this book covers

Part 1: Introduction
Part 2:
Part 3:
Nuxeo EP 5.3 4
Introduction
Part 4:
Nuxeo EP 5.3 5
Chapter 3. Getting Started
3.1. Overview
In this chapter we will show you how to develop with Nuxeo EP. It is recommended that you first read the
'Learning Nuxeo EP5 Guide' before reading this chapter. It will also provide you with a good introduction to
developing with Nuxeo EP and give you a better understanding of the additional examples provided by the
sample project which are discussed here.
You can think of your development task as using an IDE (such as Eclipse) to create a jar file from your source
code, that can then be deployed (ie. copied) to the nuxeo server's 'plugin' directory. This new plugin (jar file)
which you will create, adds functionality to the basic 'out of the box' Nuxeo EP Server that you will also
download and setup. Here is a diagram that tries to show in simple terms what we would like to do:
It also explains simply what Nuxeo is. The nuxeo server is essentially an application (nuxeo.ear) that runs
inside a JBOSS container. It contains an embedded H2 database that acts as the default document repository.
The user interface to nuxeo is provided by a web browser or a rich client.
If you encounter any problems don't forget you can share your experience on the ecm mailing list .
3.2. Prerequisites
We assume from now on that you have the following ready-to-use environment set up on your computer:
• Java Development Kit (JDK) 1.5.x or JDK 1.6.x (Sun's JDK, OpenJDK is not yet supported)
• Eclipse 3.5 (aka galileo) (J2EE edition)
• A Nuxeo EP installation from the last release (download the installation wizard). You can also download
Nuxeo EP 5.3 6
Getting Started
a nightly build installer from http://www.nuxeo.org/static/snapshots/ , but keep in mind that this
one may be broken, so don't erase your working setup with a nightly build: the result is not guaranteed.
• Maven (for setting up eclipse and builds)
• Mercurial (for checking out the source controlled version(s) of sample project used throughout this
chapter)
• A "unix-type" shell: if you are running windows, you can install cygwin
Note: The Nuxeo EP installer also installs and sets up the right version of JBoss on your computer, so you don't
need to install it on your own.
For detailed instructions on how to set up all of this software, there is a good guide in Chapter 2 of the
'Learning Nuxeo EP5 Guide'.
3.3. Eclipse Plugins v Command Line

We will check out our sample project's source code from a remote repository using Mercurial and then import
this source into Eclipse. We will use Eclipse as a development tool only here. The resulting artifact (Nuxeo
projects are well described as maven artifacts - which can be thought of as just the output of a given project, for
eg. a jar, a war, and ear file etc), will be built from the source we create in Eclipse, via the command line using
Maven.
It is possible to configure Eclipse to use plugins that will let you run both Maven and Mercurial from within
eclipse. You can set up your Eclipse to do so if you prefer, however in this chapter we will describe how to use
these tools from the command line. If you prefer to use the plugins you can download them from:
• Maven Integration for eclipse
• Mercurial Integration for eclipse
3.4. Learning from the project sample

Nuxeo provides you a sample project that teaches you the main components used by Nuxeo EP by introducing
the 'Book' document type, which equates to a book you'd buy in a bookstore or borrow from a library (complete
with ISBN number). By following this chapter, you will learn how to:
• declare the book document type;
• display book documents;
• regulate book document states;
• make book documents indexable and searchable;
• enable drag and drop book creation mode;
• handle book document creation events.
3.5. Setting up the sample project
3.5.1. Some handy environment settings

Before we start you may want to set the following in your .bashrc file in your home directory:
Nuxeo EP 5.3 7
Getting Started
export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=512M"
It sets the amount of memory available to Maven when it is doing its stuff and will help you avoid "out of
memory" errors.
3.5.2. Checking the sample project out of mercurial

Create a directory called 'workspace' in your home home directory. Change into this directory and check the
sample project out of the remote repository ( http://hg.nuxeo.org/addons/nuxeo-sample-project/) by running
mercurial from the command line:
$ mkdir ~/workspace
$ cd ~/workspace
$ hg clone http://hg.nuxeo.org/addons/nuxeo-sample-project/
This will create a directory in your home directory called ~/workspace/nuxeo-sample-project which contains
the source code used for this lesson. There are 2 branches in the mercurial repository: 5.1 and 5.2. The 5.1
branch source has been tested against the Nuxeo 5.1.6 server, whilst the 5.2 branch has been tested against the
Nuxeo 5.2.0 server.
To see what branch you are using, type "hg branches". To switch between branches you can type "hg update
branchName". Eg:
$ hg update 5.1
The accompanying version of JBOSS used with the 5.1 Nuxeo server is jboss 4.0.5 and with the 5.2 Nuxeo
server is 4.2.3.
3.5.3. Initialize the Eclipse workspace

From the workspace directory, run the command:
$ mvn -Declipse.workspace=. eclipse:configure-workspace
This command will initialise your Eclipse workspace for you, which basically means it tells Eclipse where to
find your local Maven repository by setting a variable called M2_REPO in the file:
~/workspace/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.jdt.core.prefs .Your local Maven
repository (which is usually in ~/.m2/repository) will hold all the jar files that our sample project depends on.
You will only need to run the Maven 'configure-workspace' command (listed above) once. If you create
projects in addition to the sample project later on, they can all use this same workspace (and hence the same
local maven repository).
3.5.4. Setting up your project for importing into Eclipse

Next, Maven will help us set up the sample project so that it can be readily imported into eclipse. Change into
your sample project directory and run the Maven commands:
$ cd ~/workspace/nuxeo-sample-project
$ mvn eclipse:clean
$ mvn eclipse:eclipse
The 'eclipse:clean' command will clean any previous eclipse setup of your sample project (ie. cleans up all the
eclipse related files so that you can start again).
Nuxeo EP 5.3 8
Getting Started
The 'eclipse:eclipse' command will set up eclipse related files for your project and also download any
dependencies that your project needs to compile, based on the sample project's (Maven) pom.xml file. It will
store these dependencies in your local Maven repository (defined by the M2_REPO variable we described
above). So the first time you run this command, it may take a while. Now when you import your project into
eclipse, it should have everything it needs to compile the source.
3.5.5. Importing the sample project into Eclipse

Now that your workspace, Eclipse project files, and all the dependencies have been prepared, you can import
the sample project into eclipse. Start Eclipse and select File>Import-General-Existing Projects into Workspace,
click next and set the root of the workspace as: ~/workspace/nuxeo-sample-project. Hopefully it will be
imported with no errors.
3.5.6. Running JUnit tests on the sample code

Our sample project has some JUnit test classes defined that enables you to run tests from within Eclipse.
Expand the src/test/java branch to reveal the classes under the org.nuxeo.ecm.sample tree:
i. TestBookLifeCycle
ii. TestBookTitleService
iii. TestBookType
iv. TestRepository
You can right click on these classes and select: Run As>JUnit Test.
3.5.7. Building the jar file from the sample project

The sample project code contains all the source in a working format that is ready to be built into a jar.
Normally, you'd be creating these changes yourself. However, this has already been done for you in the sample
project (we will explain what it all means in the sections that follow).
So now we are ready to create a jar file from our source code. To do this run the following Maven command
from your ~/workspace/nuxeo-sample-project directory:
$ mvn clean install
If all goes well you should see the "BUILD SUCCESSFUL" message and a new jar file created in the
~/workspace/nuxeo-sample-project/target subdirectory called something like:
nuxeo-project-sample-5.1.6-SNAPSHOT.jar
3.5.8. Deploying the jar file to the Nuxeo server

Now that we have created the jar file, deploying it to the nuxeo server is simply a matter of copying it to the
'plugins' directory. Assuming that the nuxeo server is located in the ~/nuxeo directory, then copy the jar as
follows:
$ cp ~/workspace/nuxeo-sample-project/nuxeo-project-sample-5.1.6-SNAPSHOT.jar
/nuxeo/server/default/deploy/nuxeo.ear/plugins
3.5.9. Starting the nuxeo server

We can now start the nuxeo server. After it has started, we will open up a web browser to see what our sample
project has produced ((Section 3.5.10, “Viewing your changes via the UI” ).
There are 2 ways to run the nuxeo server:
Nuxeo EP 5.3 9
Getting Started
3.5.9.1. Running the nuxeo server from the command line
To start the nuxeo server from the command line (assuming it is installed in ~/nuxeo):
$ cd ~/nuxeo
$ bin/run.sh
Note: you can shutdown the server from the command line by entering ^C (control-C) or by running the script
"~/nuxeo/bin/shutdown.sh -S" from another shell session.
3.5.9.2. Running the nuxeo server from within Eclipse
You can also set up an instance of the nuxeo server to run within Eclipse. You do this by pointing your eclipse
server to the installation of the nuxeo server on your filesystem. Defining a server configuration for the Nuxeo
runtime within eclipse enables you to start and stop Nuxeo directly from within eclipse.
This can be achieved by launching the new server wizard from the servers tab (make sure you are in the J2EE
view in Eclipse): Right click inside the server pane, and select New>Server. You should select a Jboss v4.0
server type, click 'Next' and provide the Nuxeo EP home directory as server home (eg. ~/nuxeo) on the next
screen. Select the defaults for the remainder and then click 'Finish'.
Now double click your server so you can see the server configuration we just created. We need to change the
default timeout value on the server startup, because it is likely that starting the nuxeo server will exceed the
default value. You should configure a starting timeout value suitable for your computer.
Expand the 'Timeouts' section and change the default to 300 seconds for example. Don't forget to save your
changes.
You may also want to click the 'open launch configuration' link in the server settings view. On the arguments
tab you can change the amount of memory available to the VM to avoid PermGen out of memory errors:
-XX:MaxPermSize=512M
Now right click on the server and select 'Start' to start the server from within eclipse.
3.5.9.3. Server Logs
You can look at your server logs to look for any errors which may occur on server startup in the following
directory:
~/nuxeo/server/default/log/server.log
For example: One common error is when an instance of the server has failed to stop correctly and you try to
start the server again, you will get an error like:
Port 8083 already in use
In this case you will have to kill the java process from the command line before re-starting the server:
[nuxeo ~/nuxeo] ps aux | grep java

nuxeo 9919 2.4 10.5 777428 297292 ? Sl 15:44 3:37 /usr/lib/jvm/java-6-sun-1.6.0.16/bin/java -Dpro
[nuxeo ~/nuxeo] kill -9 9919
3.5.10. Viewing your changes via the UI
Nuxeo EP 5.3 10
Getting Started
3.5.10.1. Logging in
Now that your server is running, open up your web browser and go to the url:
http://localhost:8080/nuxeo/
Log in nuxeo with Administrator/Administrator.
3.5.10.2. Viewing your changes
In order to see what results our new jar plugin for the 'Book' document type has produced, we first need to
create a Workspace (Note: A Nuxeo workspace is different from an Eclipse workspace. To understand more
about the basic Nuxeo EP user concepts, see the Nuxeo User Guide). Once you have logged in, click on
'Workspaces' and select 'Create New Workspace'. Give it a title and click 'Create'.
Now click on the workspace you have created, and select 'New Document'. The list of available document types
should now contain 'Book' as one of its types. Select 'Book', and Enter a title, description and ISBN, and upload
a file if you want. Click 'create'.
Congratulations, you have successfully created a new Book type ! You should now see this in your Nuxeo
workspace.
3.5.11. Using Ant

Although we said above that we would use Eclipse purely for development, the sample project does come with
a build.xml file that can be conveniently used within the default installation of eclipse to perform the functions
of building and deploying the jar file. We have already accomplished these two tasks using Maven for the
build, and a unix cp for the deploy, however we will show you how this can also be automated from within
eclipse using Ant.
In order to take advantage of our Ant build.xml file, we first need to tell Ant where to find our server. We will
do this by creating a build.properties file which will be used by Ant to find it. The sample project comes with a
file called 'build.properties.sample' in the ~/workspace/nuxeo-sample-project root directory. We will copy this
file an rename it to 'build.properties' in the same directory:
$ cp build.properties.sample build.properties
Now edit the file and change the line which contains the property: jboss.dir to point to your jboss path. Note
that when using the Nuxeo EP installer, the JBOSS home directory is the same as the Nuxeo EP home
directory. You should use an absolute path for safety. For example if your home is /home/nuxeo and your
server is installed in ~/nuxeo:
jboss.dir=/home/nuxeo/nuxeo
Now within eclipse, select 'build.xml' in the left hand pane, then right click it and choose:
Run>External Tools>External Tools Configuration.
In the pop up window, right click on 'Ant Build' in the left hand pane, then select 'New'. This should result in
the nuxeo-project-sample build.xml task appearing in the configuration. If you click on the 'Targets' tab you'll
see all the tasks defined ('deploy' should be the default, which includes a 'build and copy to jboss' description).
We are going to copy this configuration to make a new configuration that lets us just run the copy task which
will copy our built jar file (which we've already built using Maven) into the nuxeo server plugins directory (ie.
this will automate our 'deploy' which we carried out manually above by using the unix cp command).
Right click on nuxeo-project-sample build.xml in the left hand pane and choose 'Duplicate'. In the "Name" field
type "nuxeo-project-sample build.xml copy jar file to plugins directory" and in the "Arguments" field, type
"copy". Click 'Apply':
Nuxeo EP 5.3 11
Getting Started
Now when you right click on build.xml and choose Run As> External tools configuration and select your new
'copy' configuration to Run (click the 'Run' Button), you should see the following output in your eclipse
console:
Buildfile: ~/workspace/nuxeo-sample-project/build.xml
copy:
[copy] Copying 1 file to ~/nuxeo/server/default/deploy/nuxeo.ear/plugins
BUILD SUCCESSFUL
Total time: 204 milliseconds
When developing, you will also find it useful not to have to restart jboss when performing changes in xhtml
pages. Since releases 5.1.5 and 5.2-M2, you can add the line facelets.REFRESH_PERIOD=2 to the
nuxeo.properties file in the nuxeo.ear/config folder in your server installation (eg.
~/nuxeo/server/default/deploy/nuxeo.ear/config): pages will be refreshed within 2 seconds.
For hot deploying web sample resources in this same manner from within Eclipse, you should create a new Ant
configuration like we did above for the 'copy' configuration, but use the ant target 'web' as the argument to your
ant task.
3.6. Understanding the sample code
3.6.1. Two types of changes

We can distinguish between 2 types of changes in the section that follow:
i. Configuration-only changes
ii. Configuration plus Java Code changes

Sometimes enhancing Nuxeo simply requires some configuration file changes or additions. In other words, you
can do a lot with Nuxeo by simply changing or adding some configuration. This is one of the nice things about
it. However there are other times we will also need to do a bit more work and add some Java Code to make
some enhancements.
It's just nice to know this from the outset.
3.6.2. The layout of our sample project

Here is the project source layout:
Nuxeo EP 5.3 12
Getting Started
nuxeo-project-sample
`-- src
|-- main
| |-- java ❶
| | `-- org
| | `-- nuxeo
| | `-- project
| | `-- sample
| `-- resources
| |-- META-INF -- MANIFEST.MF ❷
| |-- OSGI-INF ❸
| | `-- l10n
| |-- directories
| |-- nuxeo.war ❹
| | |-- icons
| | |-- img
| | `-- incl
| | `-- tabs
| |-- schemas
| |-- themes
| '-- workflows
|
`-- test ❺
|-- java
| `-- org
| `-- nuxeo
| `-- ecm
| `-- sample
`-- resources
`-- META-INF
`-- OSGI-INF
❷ The main entry point is the MANIFEST.MF file. It defines variables like Provide-Package,
Require-Bundle, Nuxeo-Require and Nuxeo-Component that tell the Nuxeo EP runtime where everything
is and what they depend on. They define where to load component definitions (our xml configuration
files) with their associated classes and resources. Essentially when the nuxeo runtime is loading up our
new jar file plugin, it looks here first to see where to find everything.
❸ Component definition (xml config) files are by convention located in the OSGI-INF folder. These Nuxeo
EP components mainly consist of extension point configuration (see: Section 3.6.3, “A bit about extension
points”). which add the functionality we want to Nuxeo.
Note
The sample project makes an architectural choice to keep multiple xml configuration files
rather than having all our configuration in a single xml file. We have chosen to group together
like functions (for eg. "UI configuration, "Document type configuration") into separate xml
config files. We could have chosen to put these all together in a single file. It's an
architectural choice for the user in the end.
❶ The extension points (configured in our xml files) may reference one or more of the sample project's
specific classes. They are all defined in the src/main/java folder.
❹ Any dedicated web templates or resources (such as icons etc) that our sample project needs to use, are
defined in the nuxeo.war folder.Note that these resources will be written into the nuxeo.war folder at
deployment time.
❺ Starting and stopping the Nuxeo EP server for testing the features our sample project implements is time
consuming. JUnit test classes can be found in the src/test folder.
3.6.3. A bit about extension points

In much of what follows we will be talking about extension points. A good discussion of extension points is to
be found in the Learning Nuxeo EP5 Guide. But it might help to just briefly qualify what we mean here when
we talk about 'extension points'.
An 'extension point' can be thought of as a point in a class where it asks for information (we also say that the
class 'exposes' extension point) which will allow it then to perform some function. In a sense, the class that is
exposing the extension point is a helper class that allows us to add new functionality just by giving it some
extra information.
A 'contribution' to an extension point is the information that is provided to that class' extension point, that then
Nuxeo EP 5.3 13
Getting Started
enables the class to do its work. Contributions are usually provided by us in an xml configuration file when we
want to get a Nuxeo class that exposes an extension point to do something for us with the information we give
it. Below is a diagram that may help you visualize extension points:
A Bundle is equivalent to a java package like "org.nuxeo.sample" and a Component which exposes an
extension point is like a Java Class (eg. "BookTitleService") or one which contributes to an extension point is
like an xml file "booktitle-contrib.xml" which defines the contribution. The best way to understand this is to
actually see an extension point in action. If you cant wait you can skip ahead to Section 3.6.8, “Enabling
drag&drop creation (plus creating our own extension points)” in which we show how to create a class with its
own extension point exposed, and then how to use it (provide a contribution to it). In any case, in every
example that follows, we will be providing contributions to existing nuxeo class' exposed extension points to
get them to do things for us.
3.6.4. Declaring the 'Book' document type
3.6.4.1. Objective
So away we go. To start with, we would like to declare a new Document type which represents a book (a book
you can buy in a bookshop, a library book etc), that you can select and manage via our 'New Document' button
on our UI:
When you click the 'New Document' button you should see our new 'Book' document type:
Nuxeo EP 5.3 14
Getting Started
This new document type wasn't there before (ie. it doesn't appear in the default out-of-the-box Nuxeo
installation). Our sample project created it. We can split the task of creating our new 'Book' type into 2 parts:
1. Declaring the 'Book' type and creating the schema for this type
2. Displaying it on the UI
In this section we will describe how to declare it and define the schema for it. In the next, we will show how to
display it on the UI. A good reference document for this section, is chapter 5 of the Nuxeo Book: Schemas and
Documents.
3.6.4.2. Creating the 'Book' document type
Declaring the book type and creating its schema, requires only configuration changes (ie. no Java code). The
changes we will need to make are:
1. Create our book schema (book.xsd file)
2. Declare our new 'Book' type in core-types-contrib.xml
3. Tell the container/Nuxeo runtime how to find it (MANIFEST.MF)
3.6.4.3. Declaring the 'Book' schema
We want our 'Book' to be composed of four fields isbn, rating, publicationDate and literals. This is the
schema which defines our 'Book' type. We will declare this schema in a file called
src/main/resources/books.xsd. Here is a snippet from it:
...
<xs:element name="isbn" type="xs:string"/>
<xs:element name="rating" type="xs:int"/>
<xs:element name="publicationDate" type="xs:date"/>
<xs:element name="keywords" type="bk:stringArray"/>
...
We should note however, that a Document in Nuxeo is generally a composite of many schemas. If you look at
the full source of the 'doctype' extension point contribution in the core-types-contrib.xml file of the next
section, you'll see that the book.xsd schema we defined above, is simply one of many schemas that contribute
to making up our new 'Book' document type. But we don't need to define fields like 'Title' or 'Author' in our
schema, because these fields are considered standard fields that have been already well defined in already
existing schemas that are available to us like the dublincore schema.
3.6.4.4. core-types-contrib.xml
Next we will create a file called src/main/resources/OSGI-INF/core-types-contrib.xml which will declare our
Nuxeo EP 5.3 15
Getting Started
new 'Book' type and then link it to the schema which we have just created for it. But more importantly, this
core-types-contrib.xml file provides an 'extension point contribution' to the Nuxeo
org.nuxeo.ecm.core.schema.TypeService. This core Nuxeo class (TypeService) exposes a number of extension
points which is like the Nuxeo class saying "You can add new customized functionality at this point, by
providing this Nuxeo class with the information it needs to add this functionality in for you". For example the
TypeService class exposes the following extension points, for which we can provide contributions:
org.nuxeo.ecm.core.schema.TypeService
|-- doctype (declare a new Document Type)
|-- schema (declare your new Document Type's schema)
|-- type (show your new Document Type on the UI)
|-- ...
|-- etc
|-- ...
Contributions to the doctype and schema extension points, only require the addition of the configuration files
we are defining here (core-types-contrib.xml and book.xsd). Once defined, the TypeService class knows how to
use them to create our new 'Book' type in Nuxeo. All we have to worry about is giving the TypeService the
information it needs.
Here is the corresponding XML snipset extracted from the core-types-contrib.xml file
...

<extension target="org.nuxeo.ecm.core.schema.TypeService"
point="schema">
<schema name="book" src="schemas/book.xsd" prefix="bk">
</extension>
...

point="doctype">
<doctype name="Book" extends="Document">
...
<schema name="book" >
...
</doctype>
</extension>
...
How do we know what information the TypeService needs ? Fortunately all this is documented here: Extension
Points Documentation (5.1) and here: Extension Points Documentation (5.2) . For example if you click on the
org.nuxeo.ecm.core.schema.TypeService link, you will see all the extension points that it exposes, and how to
configure these in your xml.
3.6.4.5. Adding a reference to our Manifest file
Adding a reference to our core-types-contrib.xml to our manifest tells the container and nuxeo where to find
our changes to add a new 'Book' document type. Here is the relevant snippet:
....
Nuxeo-Component: OSGI-INF/core-types-contrib.xml,
....
3.6.4.6. JUnit Tests
So far we have declared the 'Book' type and schema, but all that means is that Nuxeo knows about it. As it
stands, the user wont be able to see our new 'Book' type unless we explicitly add it to the UI (That's where the
next section comes in). However we can still test what we have done, and in fact it is important to do so. We do
this by writing some junit tests.
There are differences in the way Nuxeo version 5.1 and 5.2 handles new Document types, based on the fact that
changes were made in the repository between the 2 versions.
Nuxeo EP 5.3 16
Getting Started
The TestBookType.java test inherits from RepositoryOSGITestCase in 5.1 and SQLRepositoryTestCase in 5.2,
which both inherit from NXRuntimeTestCase which in turn eventually inherits from JUnitTestCase.
junit.framework.TestCase
|-- ....
|--NXRuntimeTestCase
|--RepositoryOSGITestCase (5.1)
|--SQLRepositoryTestCase (5.2)
The NXRuntimeTestCase is the "raw" testcase which does a lot of OSGI related test setup, and is primarily
concerned with the startup and shutdown of the nuxeo runtime in our tests. The RepositoryOSGITestCase is
used for 5.1, as it handles the JCR implementation of the repository, whereas the SQLRepositoryTestCase is
used for 5.2 as it handles the VCS implementation of the repository (See Nuxeo Book chapter xxxx)
The test for our declaration of the new 'Book' type and its associated schema, is inside the testBookCreation()
method within TestBookType.java, which has inline documentation to explain what each step does.
A useful thing to know is that the RepositoryOSGITestCase methods:

1. coreSession.saveDocument(DocumentModel): saves our Book document to the session in memory
2. coreSession.save(): saves all the session changes to the repository on disk

The session can be thought of as a series of changes that are written to it. Each change written to a session (like
the coreSession.saveDocument() one) is very cheap because it is done in memory. At the end, calling the
coreSession.save() writes all these changes to disk in one hit, which again helps with performance.
3.6.5. Displaying book documents
3.6.5.1. Objective
In this section we want to get our new Book document type to appear on the UI. Again, this involves only
configuration changes (ie. no java coding is necessary). We will end up adding or changing the following files:
1. ui-contrib.xml
2. book.png
3. layout-contrib.xml
4. deployment_fragment.xml
5. MANIFEST.MF
3.6.5.2. Label and Icon
Books are displayed on the screen using a specific icon and label. You can see in second figure in the
Section 3.6.4.1, “Objective” above, the little 16x16 image of a book, followed by the label "Book". This is
achieved by providing an extension point contribution to the TypeService's exposed extension point called
"type" which is responsible for displaying both of these on the UI (see section Section 3.6.4.4,
“core-types-contrib.xml” above for the listing of exposed extension points of TypeService). Note however, that
instead of adding our contribution to the core-types-contrib.xml file as we did when we were declaring our
Book document type, we will instead add this contribution to the ui-types-contrib.xml file. This is so that all the
contributions to do with UI changes can be grouped together separately. Here is the corresponding XML
snipset extracted from the ui-types-contrib.xml file
...
point="type">
...
<type id="Book" coretype="Book">
...
<label>Book</label>
Nuxeo EP 5.3 17
Getting Started
<icon>/icons/book.png</icon>
...
</type>
...
</extension>
...
The attribute id="Book" must match the "doctype name" declared in the core-types-contrib.xml declared above.
The coretype="Book" attribute is now optional in 5.2, but if it is present, its value must match the id attribute's
value.
Note
Test it: if you want to see the effect of the <label> value on the UI, change it from 'Book' to
something else and redeploy and restart your server (ie. run a $ mvn clean install to rebuild your jar
file and then copy it into the plugins directory and restart your server).
Also, we need to put our little 16x16 icon "book.png" in the src/main/resources/nuxeo/icons directory for it to
be deployed correctly to the server (where it will ultimately end up in the
~/nuxeo/server/default/deploy/nuxeo.ear/nuxeo.war/icons directory).
In order to ensure that it does indeed end up there, we need to make sure we have the following line in the
OSGI_INF/deployment_fragment.xml file:


<unzip from="${bundle.fileName}" to="/">
<include>nuxeo.war/**</include>
</unzip>
3.6.5.3. Adding a reference to our Manifest file
Adding a reference to our ui-contrib.xml to our manifest tells the container and nuxeo where to find our new
additions. Here is the relevant snippet:
....
....
OSGI-INF/ui-contrib.xml,
....
Note that the order of these components matters, because our ui-contrib.xml depends on the
core-types-contrib.xml.
3.6.5.4. How to display our Book's fields on our UI
Remember above ( Section 3.5.10.2, “Viewing your changes”) we had to create a new Nuxeo Workspace in
which to create our new Book document. The rules that determine where we can display our new Book
document on the UI are actually defined in our ui-types-contrib.xml file as well.
We will make a rule that Book documents can be displayed under Nuxeo folders or workspaces. These
containment rules are declared to the exposed extension point called "types" in the
org.nuxeo.ecm.platform.types.TypeService class. Note that this is a different "TypeService" class than the
one above (check the fully qualified path name !). Documentation for the extension points exposed by this class
can be found here: org.nuxeo.ecm.platform.types.TypeService
We will define this extension point contribution in the ui-types-contrib.xml file as well because our
contribution relates to UI changes. Here is the XML snipset extracted from the ui-types-contrib.xml that
defines them.
...
<extension target="org.nuxeo.ecm.platform.types.TypeService"
point="types">
Nuxeo EP 5.3 18
Getting Started
...
<type id="Folder" coretype="Folder">
<subtypes>
<type>Book</type>
</subtypes>
</type>
<type id="Workspace" coretype="Workspace">
<subtypes>
<type>Book</type>
</subtypes>
</type>
...
</extension>
...
Again, the "coretype" attribute must contain a value that relates to one of the Nuxeo Core Types or a Type that
we have created ourselves like 'Book'.
3.6.5.5. The Layout of our Book document UI
3.6.5.5.1. Defining which layout(s) to use

Aside from displaying the little book icon and "Book" label on the screen where our Book types are accessible,
we can now proceed to the more magnanimous task of defining how the UI for creating/editing or viewing a
Book document looks like. For eg: Creating a new Book:
Viewing an existing Book:
Nuxeo EP 5.3 19
Getting Started
We do this by defining the <layout> template(s) to use in our ui-contrib.xml file. This is an additional
contribution to the same "types" exposed extension point in the same
org.nuxeo.ecm.platform.types.TypeService class as above:
...
<extension target="org.nuxeo.ecm.platform.types.TypeService"
point="types">
...
<type id="Book" coretype="Book">
...
<layouts mode="any">
<layout>heading</layout>
<layout>book</layout>
<layout>file</layout>
</layouts>
...
</type>
...
</extension>
...
The "layouts" section defines what <layout> templates Nuxeo will use to display your Book document type on
the UI. The individual <layout>s (which we will see in the next section) define what fields are shown and how
they are shown. The snippet above shows that we are using 3 layouts which Nuxeo will combine in order from
top to bottom on the screen. For example in the first picture in Section 3.6.5.5, “The Layout of our Book
document UI” above, the "header" <layout> is responsible for displaying the fields in the top part of the UI.
You will note that these include "Title" and "Description" fields which are part of the dublincore schema of our
book. The "book" <layout>, displays our "ISBN" field from our book schema. Lastly the "file" <layout>
displays the "Content" section where the user can choose to upload a file.
Note
Test it: remove the two lines:
<layout>file</layout>
then rebuild your jar, redeploy to the plugins directory and restart your server.
Nuxeo EP 5.3 20
Getting Started
We will define the "book" <layout> in the next section, but the "header" and "file" <layout>s come standard
with Nuxeo.
3.6.5.5.2. Defining our custom "book" layout

In the section above we told Nuxeo that we would define a <layout> called "book" which would describe what
Book fields we wanted to see on the UI. In this section we will show you what that <layout> definition looks
like. We want the ISBN book field to be displayed onto our UI when the user is creating a new book or editing
or viewing it content. This is achieved by defining a layout in a new file we will create called
layouts-contrib.xml which will group together all our layouts. Indeed, all we are doing is contributing to the
"layouts" extension point of the WebLayoutManager class. Each particular layout is defined inside this
extension point. Here is the XML extracted from the layouts-contrib.xml file that registers our layout with
the WebLayoutManager:
<?xml version="1.0"?>
<component name="org.nuxeo.project.sample.layouts">
<extension target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager"
point="layouts">
<layout name="book">
<templates>
<template mode="any">/layouts/layout_default_template.xhtml</template>
</templates>
<rows>
<row>
<widget>isbn</widget>
</row>
</rows>
<widget name="isbn" type="text">
<labels>
<label mode="any">ISBN</label>
</labels>
<translated>false</translated>
<fields>
<field>bk:isbn</field>
</fields>
<widgetModes>
<mode value="create">edit</mode>
<mode value="any">view</mode>
</widgetModes>
</widget>
</layout>
</extension>
...
In a layout we define rows of widgets (elements that are seen on the UI). We have one row with the "isbn"
widget.
Each widget definition (in our case we only have one widget - the isbn widget) is then provided in the
<widget> section of our xml file. A widget definition contains:
A "type": (eg. "text") which defines how the widget is displayed on the UI (eg. a text entry box in edit mode or
a text string in view mode).
The <labels> section defines what labels you would like to appear next to the widget. You can define a
different label for each "mode". For eg. in 'edit' mode you could have 'Please enter an isbn number:' and in
'view' mode you could have 'ISBN number entered:'. In our case we have a "mode" of 'any' which means
display the same label in all modes.
The "fields" section describes which fields in our schema to map the widget to. In our case we are mapping to
our "book" schema's isbn field.
Lastly the "widgetMode" node tells us which modes our widget will appear in on our UI (in our case the 'edit'
and 'view' modes).
Nuxeo EP 5.3 21
Getting Started
3.6.5.6. MANIFEST.MF
Don't forget to add entries into your MANIFEST.MF file to reference the new files you have created:
....
OSGI-INF/ui-contrib.xml,
OSGI-INF/layouts-contrib.xml,
....
3.6.5.7. Unit Tests
It is possible to install Selenium to test our new UI changes as it is difficult to write JUnit tests to do so. For
now, we suggest just starting up the Nuxeo server and going in and verifying that your changes work by
creating a new Book document and seeing if you can view it.
3.6.5.8. Summary
In this section we described how to get the our Book document's fields to be displayed on the screen, and how
to display them.
3.6.6. Actions, tabs and behavior
3.6.6.1. Objective
We can add tabs to the different views a user has in the Nuxeo UI and associate different behaviors with each
tab.
In this section we will describe how to add 2 tabs:

1. A "Books" tab to the workspace view: When you click on a workspace, you will see a number of tabs.
We will insert a "Books" tab that lets you do certain book associated tasks, like viewing all the books in
the folder and searching for all books with a particular keyword (see: Section 3.6.7, “Making book
documents indexable and searchable” ).
Note
Searching on a keyword assumes these keywords have been setup somewhere and
somehow. We will just assume this in this section. We show you how to set up the
keywords in Section 3.6.11.5, “Directories and Vocabularies”
2. A "Book" tab to the book view: When you click on a book item that you have already created, you will
also see another tab called 'Book' which allows you to edit some of the Book's properties and attach
Keywords to the book (these are the keywords we can search on in the "Books" tab above).
Nuxeo EP 5.3 22
Getting Started
It is the first time also that we will be using some Java code in addition to configuration changes/additions. The
java code will help us implement some of the custom behavior we want. However we will not focus on this, as
it is important to understand that you can do a lot with just the configuration changes that we will explain.
A good reference for this section is Section 7.1, “Introduction”
3.6.6.2. Configuration
Our configuration happens in a file called actions-contrib.xml. In this file we provide a contribution to the
extension points called "actions" and "filters" on the ActionService class. Here is the actions-contrib.xml file:
<component name="org.nuxeo.project.sample.actions">
<extension target="org.nuxeo.ecm.platform.actions.ActionService" point="actions">
<action id="tab_book_view"
link="/incl/tabs/book_view.xhtml" enabled="true"
label="Book" icon="/icons/file.gif" order="9">
<category>VIEW_ACTION_LIST</category>
<filter id="book_filter">
</filter>
</action>
<action id="tab_folder_books_list"
link="/incl/tabs/folder_books_view.xhtml" enabled="true"
label="Books" icon="/icons/file.gif" order="15">
<filter id="workspace_books_filter">
<rule grant="true">
<type>Folder</type>
<type>Workspace</type>
</rule>
</filter>
</action>
</extension>
<extension target="org.nuxeo.ecm.platform.actions.ActionService" point="filters">
<filter id="book_filter" append="true">
<rule grant="true">
<type>Book</type>
</rule>
</filter>
</extension>
</component>
The first thing to note are the 2 extension point contributions "actions" and "filters".
The "filters" extension point: is where you can add a "filter". Filters are generally are used to change the access
rights to a tab. We name and create filters in this section when our filter is particularly complex (and we then
want to separate it, define it, and call it by name from the "actions" extension point), or when we just want to
re-use a particular filter, and therefore we can again reference it by its name.
Our example filter in actions-contrib.xml called "book_filter", is saying that if a Document is a child of the
"Book" type, then grant access (visibility) to this tab. This example shows how filters can be used to manage
access rights to tabs. It is convenient, as the user does not have to write Java code to deal with permissions.
The "actions" extension point: is used to configure what action to take when it is selected. The action id names
the action. If you hover your mouse over the "Book" tab in the Book view (select a book that you have already
Nuxeo EP 5.3 23
Getting Started
created and then hover your mouse over the "Book" tab on the next screen), you'll see that the url contains the
action id.
The "link" attribute identifies which action to call when your tab is selected. The link here specifies a JSF page
called book_view.xhtml. We will describe this JSF page in brief in a following section. For now, all we need to
know is that clicking the "Book" tab will request this action. The "enabled" attribute is also important, because
it defines whether or not a tab will be visible to the user or not. So we can turn the visibility of tabs on and off
with this attribute which is quite useful. The "label" is the text that will appear on the tab, and the "icon" is the
icon associated with the tab.
The "category" node defines a pre-defined place on the page on which to display your tab. Common values are:
1. VIEW_ACTION_LIST: used for tabs
2. USER_SERVICES: used to display actions in the top right corner of every page
3. SUBVIEW_UPPER_LIST: used to display actions just below a document tabs listing

See Section 7.2.2.2, “Manage category to display an action at the right place” for more information.
The "filter" node is also important. You can define either an inline filter (as has been done with the
"tab_folder_books_list" action), or you can just call a named filter (which is what the "tab_book_view" action
does). The "filter" nodes define what filters to associated with this action. For the "tab_book_view" action, our
filter allows the user access to the tab only if the document is a child of the Book type.
3.6.6.3. JSF/Java
The actions-contrib.xml file above, calls the book_view.xhtml and folder_books_view.xhtml jsf pages as its
actions. (Note that tab's templates are defined into the folder nuxeo.war/inc/tabs.) Without going into detail,
you can see from the snippet below that the jsf looks a lot like html, but with the use of jsf tags like
<h:outputLabel value="keywords"> instead of html.
Note also that these templates get their model using the BookManagerBean which implements book behaviours.
You'll see that anything with the "#{}" around it is a call to the BookManager.java class.
3.6.6.4. Summary
In this section we saw how to add tabs with access permissions and behaviors using contributions to the
"actions" and "filters" extension points on the ActionService class. Don't forget to add a line to your
MANIFEST.MF to include the actions-contrib.xml file. The next section includes details of how the
"Books" tab page is used.
3.6.7. Making book documents indexable and searchable
3.6.7.1. Objective
We want to allow our book to be searchable via the Nuxeo UI. There is a little 'search box' in the top left corner
of our Nuxeo UI. You don't need to do anything specific to have this search, search any of your book
documents.
However, in the section below, we will show how to do a customized search that you can set up
'programatically'. To do this we need to do 4 things:
1. Tell Nuxeo which fields from our Book schema to index. Indexing means that these fields can be
searched when a user does a search. Note however, that this first step is only necessary in Nuxeo 5.1. In
Nuxeo 5.2 you no longer have to tell Nuxeo which fields to index in your Document schema, because it
will index all fields by default.
2. We also need to tell Nuxeo how to search. For example, should we search with 'Starts With' or 'Contains'
and which fields should we search.
Nuxeo EP 5.3 24
Getting Started
3. Then we need to tell Nuxeo what Java class will be doing the searching for us.
4. Finally we will need a page on the UI to show our search options and display our search results.
A good reference for this section is Section 11.1, “Introduction”.
3.6.7.2. Indexing
Our first step is to tell Nuxeo which fields in our Book schema we want indexed. These indexed fields will be
the ones that can be searched. This step is only necessary in Nuxeo 5.1. In 5.2, all fields from our Book schema
will be searchable by default.
To tell Nuxeo which fields to index, we register an extension point contribution to the extension point called
"indexableDocType" on the SearchServiceImpl class. We do this in a file called the search-contrib.xml file.
Don't forget that we need a reference to this in our MANIFEST.MF as it is a new file. Here is the contents of
the search-contrib.xml:
<component name="org.nuxeo.project.sample.search">
<extension
target="org.nuxeo.ecm.core.search.service.SearchServiceImpl"
point="indexableDocType">
<indexableDocType indexAllSchemas="true" name="Book" />
</extension>
</component>
As you can see we are telling the SearchServiceImpl class to index all fields on all schemas that make up our
Book document. So all fields of our book will be searchable.
3.6.7.3. Query Model
Next we need to tell Nuxeo how we want to search. This is called our 'Query Model'. The query model lets us
define our search in an 'SQL-like' way so that we can specify our search parameters. An example in
pseudo-code might be:
"select all Book documents where the user's input string matches one of the book's keywords.".
To do this, we register a 'Query Model' with the "model" extension point of the QueryModelService. We can do
this by creating a new file called querymodel-contrib.xml and specifying the search "pattern":
<component name="org.nuxeo.project.sample.querymodels">
<extension
target="org.nuxeo.ecm.core.search.api.client.querymodel.QueryModelService"
point="model">
<queryModel name="BOOK">
<pattern>
SELECT * FROM Document WHERE ecm:primaryType = 'Book' AND ecm:path STARTSWITH ? AND
bk:keywords = ?
</pattern>
<sortable value="true" defaultSortColumn="dc:title"
defaultSortAscending="true" />
</queryModel>
</extension>
</component>
The query language that we use in the "pattern" attribute is called NXQL and more documentation about it can
be found here: Section 11.3.1, “Fields and literals” .
3.6.7.4. Tell nuxeo about our search class
After we have setup our query model, we need to register the Java Class that will be invoking this query model
Nuxeo EP 5.3 25
Getting Started
(and dealing with the results of the query), with the "model" extension point of the ResultsProviderService.
Again we do this in a new file called: resultsprovider-contrib.xml. Here are the contents of that file:
<component name="org.nuxeo.project.sample.resultsproviders">
<extension
target="org.nuxeo.ecm.webapp.pagination.ResultsProviderService"
point="model">
<resultsProvider name="BOOK" farm="bookResultsProviderFarm" />
</extension>
</component>
Notice that the "farm" attribute points to the src/main/java/BookResultsProvider.java class that we have written.
This class will be the class that retrieves the query model we setup above and uses it to perform our customized
search.
3.6.7.5. Displaying our Search Results
Finally having set up our search, we need a page to display the search options and show the results of our
search on the UI. We do both these things on the same page: Books are both searched for, and listed, in the
book's tab using the resultsProviderCache which we can access in the folder_books_view.xhtml JSF page we
setup above: Section 3.6.6.2, “Configuration”
...
<nxu:methodResult name="provider"
value="#{resultsProvidersCache.get('BOOK')}">
<h:form>
<ui:decorate template="/pagination/pageNavigationControls.xhtml">
<ui:param name="provider" value="#{provider}" />
</ui:decorate>
</h:form>
<h:dataTable var="bookinfo" value="#{provider.currentPage}"
...
</h:dataTable>
...
The following screen shot shows the results of our handiwork:
Note: you can setup your books to appear in this screen like this by selecting a book that you have already
created, going to the "Book" tab and entering in Keyword and Note for your book. Then clicking on a Keyword
searches for all the books that contain that keyword if it was entered against them on the "Book" tab.
3.6.8. Enabling drag&drop creation (plus creating our own extension points)
Nuxeo EP 5.3 26
Getting Started
3.6.8.1. Objective
Nuxeo makes it easy to enable drag and drop so that dragging a file onto a workspace will automatically create
a Book document. In this section we will show you how to enable drag and drop in Nuxeo.
Note
You will need to install the nuxeo drag and drop plugins for Firefox or Internet Explorer for drag
and drop to work. You can download these at:
• Firefox Extension
• Internet Explorer Extension
As by-product of explaining how to enable drag and drop in Nuxeo in this section, we will see how to create
our own Service and create an extension point on that service. So far we have been only providing
contributions to existing extension points in services within Nuxeo. But this section gives us the opportunity to
1. Create our own service with its own exposed extension point
2. Provide a contribution to our own exposed extension point
3.6.8.2. Notification for drag and drop events
But first, before we create our own service with its own extension point, let us again begin by providing an
extension point contribution to an existing Nuxeo service. By providing an extension point contribution to the
"plugins" extension point on the FileManagerService class, we can have this class notify us when a drag and
drop event occurs. We will put this contribution in the filemanager-contrib.xml file:
<component name="org.nuxeo.project.sample.filemanager">
<extension
target="org.nuxeo.ecm.platform.filemanager.service.FileManagerService"
point="plugins">
<plugin name="book_plugin"
class="org.nuxeo.project.sample.BookFileManagerPlugin">
<filter>image/gif</filter>
<filter>image/jpeg</filter>
</plugin>
</extension>
</component>
The BookFileManagerPlugin has requested that the FileManagerService call the BookFileManagerPlugin
class whenever a gif or jpeg upload (drag and drop) occurs. The notification takes the form of calling the
BookFileManagerPlugin's create() method.
3.6.8.3. Registering our own Service
Now we get to register our own service with its very own extension point exposed. This service is called by our
BookFileManagerPlugin when it has been notified by the Nuxeo FileManagerService that a ".gif" or ".jpeg"
has been dragged and dropped onto the UI. The BookFileManagerPlugin will use this Service to help it create a
new Book document from the uploaded file.
We will register the service in the booktitle-service-contrib.xml file as follows:
<component name="org.nuxeo.project.sample.BookTitleService">
<implementation class="org.nuxeo.project.sample.BookTitleServiceImpl" />
<service>
<provide interface="org.nuxeo.project.sample.BookTitleService" />
</service>
Nuxeo EP 5.3 27
Getting Started
<extension-point name="title">
<object class="org.nuxeo.project.sample.BookTitleDescriptor" />
</extension-point>
</component>
In creating this xml configuration, we are defining a new nuxeo <component> called
org.nuxeo.project.sample.BookTitleService which defines a new service called BookTitleService whose
<implementation> class is the org.nuxeo.project.sample.BookTitleServiceImpl class. Furthermore, we
define an <extension> point on our component called "title", which we will map to a java class called
BookTitleDescriptor.
Ok. Now when we define our extension point contribution, which we will do in the booktitle-contrib.xml
file, the fields in this xml file should map to the annotations in our BookTitleDescriptor. This is essentially
how you find out what information your extension point requires:
Table 3.1. Extension Point
booktitle-contrib.xml BookTitleDescriptor.java
<?xml version="1.0"?> package org.nuxeo.project.sample;

<component name="org.nuxeo.project.sample.booktitle">
<extension import org.nuxeo.common.xmap.annotation.XNode;
target="org.nuxeo.project.sample.BookTitleService"
import org.nuxeo.common.xmap.annotation.XObject;
point="title">
<configuration> @XObject("configuration")
<addInitialCapital>true</addInitialCapital> public class BookTitleDescriptor {
<removeExtension>true</removeExtension>
<addComment>(automatic)</addComment> @XNode("addInitialCapital")
</configuration> protected boolean addInitialCap;
</extension>
</component> @XNode("addComment")
private String addComment;
public String getAddComment() {
return addComment;
}
private boolean remove;
@XNode("removeExtension")
protected void setRemoveExtension(boolean remove) {
this.remove = remove;
}
public boolean getRemoveExtension() {
return remove;
}
}
So the flow of events when a ".gif" or ".jpeg" document is dragged onto the Nuxeo UI is as follows:
The FileManagerService notifies the BookFileManagerPlugin by calling its create() method. To do its work
of creating a new Book document, the BookFileManagerPlugin class calls the BookTitleService's
correctTitle(title) method, passing it the name of the file that was uploaded. The BookTitleService then
retrieves the values provided by the "title" extension point which are set in the booktitle-contrib.xml file,
and uses these to correct the title (ie. Change the first letter to a capital, removes the file extension - eg. ".gif"),
and adds a comment, before creating a new Book document with this title and saving it to the repository.
FileManagerService
|-- BookFileManagerPlugin.create()
|--BookTitleServiceImpl.correctTitle(title)
|-- BookTitleDescriptor (get values from booktitle-contrib.xml config)
|-- create the title base on the values
|-- create the new Book with this title in the repository
Nuxeo EP 5.3 28
Getting Started
The Sample Project contains a class called TestBookTitleService which tests whether our new configuration
and java changes for creating our new BookTitleService service works.
3.6.8.5. Differences between 5.1 and 5.2
If you look at the source code of the BookFileManagerPlugin in the 5.1 vs 5.2 branch, you will notice that in
5.1 it extends AbstractPlugin whereas in 5.2 it extends AbstractFileImporter. The AbstractPlugin is
deprecated in 5.2.
The BookManager and BookMangerBean classes have import(s) changed from 5.1 to 5.2:
import org.jboss.seam.annotations.WebRemote; (5.1)

import org.jboss.seam.annotations.remoting.WebRemote; (5.2)
and
import org.jboss.seam.core.FacesMessages; (5.1)

import org.jboss.seam.faces.FacesMessages; (5.2)
As these have changed packages between the jboss versions used between 5.1 (4.0.5) and 5.2 (4.2.3).
The BookManager interface has been changed to return a DocumentModelList instead of a ResultSet
public ResultSet getSearchResults() throws Exception; // (5.1)

public DocumentModelList getSearchResults() throws Exception; //(5.2)
and the BookManagerBean which implements the BookManager interface, has had its code updated accordingly,
and also been made Serializable. The reason is that SearchService is not used anymore. Now queries are
executed with the method query() from the CoreSession, and this new method returns a DocumentModelList
instead of a ResultSet.
The BookResultsProviderFarm has also been made Serializable in 5.2, and had its call to getResultsProvider()
updated.
3.6.9. Regulating book states
3.6.9.1. Objective
We want to make Books be regulated by the standard life cycle ( project, approved, obsolete, deleted
states). As defined in the Chapter 4 of the Nuxeo User's Guide "The evolution of a document, each time
contributors edit it, constitutes its life cycle ... To change the life cycle state of a document, you need to submit
it to a workflow.". You can find out more about life cycles and workflows from the user's perspective by
reading Chapter 4 of the Nuxeo User's Guide .
In this section we will show you just how to register a document to the default life cycle states. To get it to
actually transition between these states will be discussed in a separate section on Section 3.6.10, “Workflow” .
3.6.9.2. How to
We can get a Book to follow the Nuxeo standard lifecycle by declaring to the "types" extension point of the
LifeCycle Service that Books follow the "default" life cycle. Here is the lifecycle-contrib.xml file
<component name="org.nuxeo.project.sample.lifecycles">
<extension target="org.nuxeo.ecm.core.lifecycle.LifeCycleService"
point="types">
<types>
<type name="Book">default</type>
</types>
</extension>
Nuxeo EP 5.3 29
Getting Started
</component>
Getting your new Book document type to follow the standard Nuxeo lifecycle is as simple as that. Don't forget
that a reference to the lifecycle-contrib.xml file also needs to go in the MANIFEST.MF file.
We can also write a JUnit Test to test our life cycle contribution. If you look in the sample project's src/test/java
directory you'll see a test class called TestBookLifeCycle.java. It is self documented for you to follow the steps.
3.6.10. Workflow
3.6.10.1. Objective
3.6.10.2. Workflow in 5.1
TO DO (code not yet implemented in 5.1 branch either)
3.6.10.3. Workflow in 5.2
TO DO (code exists in 5.2 branch)
3.6.11. Listening for events
3.6.11.1. Objective
Event Listeners are java classes that get notified by nuxeo when a particular type of event (that they are
"listening" for) occurs. In this section we will show you how to create your own Event Listener java classes to
listen for particular events and then to do something useful when the event occurs.
3.6.11.2. Registering event listeners
Event Listeners are registered as contributions to the extension point "listener" on the EventServiceComponent
class (in 5.2) or on the CoreEventListenerService class (in 5.1). In the sample project we have registered these
event listeners in the event-listener-contrib.xml file. These contributions are basically registering a java
class that you will write (our "EventListener" classes), that will get notified when a particular event occurs. The
event or events that your customized class listens for can be specified by the <event> tag in the xml. Here is the
listing of event-listener-contrib.xml:
<component name="org.nuxeo.project.sample.event-listeners">
<extension target="org.nuxeo.ecm.core.event.EventServiceComponent"
point="listener">
<listener name="book_create" async="false" postCommit="false"
class="org.nuxeo.project.sample.BookEventListener">
<event>emptyDocumentModelCreated</event>
</listener>
<listener name="book_update_isbn" async="false" postCommit="false"
class="org.nuxeo.project.sample.BookISBNEventListener" order="157">
<event>documentCreated</event>
<event>documentModified</event>
</listener>
</extension>
</component>
As we can see above are 2 event listeners in the sample project:

1. BookEventListener: which listens for an 'emptyDocumentModelCreated' event
Nuxeo EP 5.3 30
Getting Started
2. BookISBNEventListener: which listens for both documentCreated and documentModified events
3.6.11.3. BookEventListener
Our BookEventListener class will get notified whenever a emptyDocumentModelCreated event occurs. In other
words, when the user clicks the 'New Document' button, it will get notified. The class itself is very simple. It
implements the EventListener interface, which means that we must implement a handleEvent(Event event)
method in our event listener, which is passed the event that has occurred:
public void handleEvent(Event event) throws ClientException {

EventContext ctx = event.getContext();
if (ctx instanceof DocumentEventContext) {
DocumentEventContext docCtx = (DocumentEventContext) ctx;
DocumentModel doc = docCtx.getSourceDocument();
if (doc != null) {
String type = doc.getType();
if ("Book".equals(type)) {
process(doc);
}
}
}
This method checks to see if our Document type is a 'Book' and if it is, it calls the process(doc) method (not
shown), passing it the Book document, which does all the work of creating some default values for the Book's
'Title' and 'Description' fields. The user sees these as 'Sample Book' and the '(Created on 2009-01-01)' in the
editable Title and Description fields respectively on the screen where a new Book is being created. The user
can overwrite these values if they wish.
3.6.11.4. BookISBNEventListener
The BookISBNEventListener class listens for documentCreated and documentModified events. When it is
notified that one of these events has occurred, once again its handleEvent() method is called. After checking
that the event applies only to Book document types, it calls its process() method do deal with these events.
It is at this point that we can see that it that we need to digress a little, to explain what is happening next. That is
because it starts doing things with a DirectoryService and a Vocabulary.
3.6.11.5. Directories and Vocabularies
The sample project defines an extension contribution to the SQLDirectoryFactory class called "directories" in
the file directories-contrib.xml whose contents are listed below:
<component name="org.nuxeo.project.sample.directories">
<extension target="org.nuxeo.ecm.directory.sql.SQLDirectoryFactory"
point="directories">
<directory name="book_keywords">
<schema>vocabulary</schema>
<idField>id</idField>
<dataSource>java:/nxsqldirectory</dataSource>
<table>book_keywords</table>

<createTablePolicy>on_missing_columns</createTablePolicy>
<dataFile>directories/book_keywords.csv</dataFile>
</directory>
</extension>
</component>
In Nuxeo, a Directory is a programmatic abstraction that let's us deal with any relational database, regardless of
the actual underlying implementation (some examples might be certain implementations of ldap, databases, csv
files etc). The chapter on Directories and Vocabularies in the nuxeo book, contains a convenient diagram in the
Introduction section which diagrams this abstraction. A The "directories" extension contribution contained in
the directories-contrib.xml file shown above, defines a new directory called "book_keywords". This
directory is based on the <vocabulary> schema, which is a core nuxeo schema and can be found in the
vocabulary.xsd file in the ~/nuxeo/server/default/data/NXRuntime/schemas/ directory under your server
installation. If you look at this schema you'll see it contains 4 fields: id, label, obsolete and ordering. The <id>
Nuxeo EP 5.3 31
Getting Started
xml node in the directories-contrib.xml defines which of these 4 fields is the key field.
The other xml nodes define the other aspects of the book_keywords directory that we are defining. The
<dataFile> node defines that we will keep the initial data that will populate this directory in the
book_keywords.csv file. If you browse to that file in the sample project you'll see its contents:
id, label, obsolete

"1","Novel",0
"2","Bestseller",0
"3","Academic",0
The <dataSource> node points to the actual implementation of our directory and where our data will be really
stored. In our case we are using the default nuxeo sql data source and naming the table that holds our data in
this dataSource <table>book_keywords</table>. Finally the <createTablePolicy> node, takes a value of
on_missing_columns, which means that nuxeo will load the contents of your book_keywords if your
book_keywords schema is updated. Thus when the server is first started, and no data exists in the table, the
book keywords will be loaded in. Then if the server is restarted, no changes will be made to the database unless
the schema has been changed.
So we have defined a Directory that will hold our book keywords that we get from our book_keywords.csv
file. What do we then do with this Directory ? We can see what happens when we look at the process() method
of BookISBNEventListener. Whenever a document is created or modified, our process() method gets a
DirectoryService to our "book_keywords" directory. It then matches the value of the ISBN field of our book
against the value of the id column of our book_keywords data (the call to dir.getEntry() will use the value of
the key field 'id' defined in our book_keywords directory to match against).
dir = dirService.open("book_keywords");
DocumentModel entry = dir.getEntry(isbn);
If there is no match (the entry returned is null), it will create a new entry in our directory with the isbn as the
"id" and the title as the "label". The mapping between our Book and our book_keywords fields is shown in the
table below:
Table 3.2. Book v Book Keywords mapping
Book (Document) field book_keywords (Directory) field

isbn id
title label
If you look at the rest of the code in the process() method of BookISBNEventListener, you'll see that if there is
a match between the isbn of the book and the id of the book_keywords, it will update the label of the matching
book_keyword entry with the title of the matching book.
So that explains what BookISBNEventListener does, and what all the Directory/Vocabulary code in the sample
project is about. The page that actually uses this code is the search facility of the 'Books' tab described in the
Section 3.6.6, “Actions, tabs and behavior ” section above.
TO DO
3.7. Starting a new project

The goal of the nuxeo-archetype-start template is to setup a Nuxeo EP plugin development environment. The
template provides: a maven layout for sources, tests and dependencies, an Ant target for deployment. It also
customizes the web application a litte bit.
Start the “new maven project” wizard from the menu File > New > Maven project. Enable your eclipse for
Nuxeo EP 5.3 32
Getting Started
using Nuxeo EP's by addind a remote archetypes catalog using the configure dialog. The URL to be used is as
follow http://maven.nuxeo.org/nuxeo-release/. Select the archetype type nuxeo-archetype-start and the nuxeo's
version you want your project based. Set the artifact parameters according to your organisation rules.
3.8. Using Documentation
• The Nuxeo Book is getting to be the most complete source of information around Nuxeo EP, both for
beginners and advanced developer. It is a good start.
• The extension point documentation is also very useful: although you may find it rough, it is the best way
to evaluate the Nuxeo extensibility potential, and one should always start with a quick look around all the
extension points, to "think Nuxeo" before starting a new project, and not reinventing the wheel.
• The wiki: we try to reference all the documentation from the wiki welcome page, and you will find
tricks, howtos, etc. If you want to have a writer account to help update the content, ask on the Nuxeo's
mailing list.
3.9. Other IDEs: IntelliJ IDEA and NetBeans
3.9.1. IDEA
IntelliJ IDEA from Jetbrains is a very lovable IDE for Java that has many fans in the Java developers
community. It is unfortunately not open source.
To start using IDEA for coding on the Nuxeo project, you just need to type mvn idea:idea from your top-level
source directory: Maven will download all the dependencies, then generate the configuration files needed by
IDEA and you will be able open nuxeo-ecm.ipr from IDEA.
Note
At the time of this writing, IDEA will report some (spurious) compilation failures and you won't be
able to compile the whole application from IDEA. You can still use IDEA with the current
configuration to write Java code ("with pleasure"), and use Ant and/or Maven to build/deploy the
application.
3.9.2. NetBeans
NetBeans is an open source IDE from Sun.
If you're using NetBeans 6 or later, you will be able to download a Maven 2 support plugin from NetBean's
"Update Center", and with it, start coding on Nuxeo EP very quickly.
Nuxeo EP 5.3 33
Chapter 4. General Overview
4.1. Introduction
4.1.1. Architecture Goals

When we started building Nuxeo EP, we defined several goals to achieve. Because these goals have a structural
impact on Nuxeo EP platform it is important to understand them: it helps understanding the logic behind the
platform.
4.1.1.1. Flexible deployment on multiple targets
An ECM platform like Nuxeo EP can be used in a lot of different cases.
The deployment of Nuxeo EP must be adapted to all these different cases:

• Standard ECM web application
This is the most standard use case. The web browser is used to navigate in content repositories.
• All services are deployed on an Application server
• In order to be easily hostable, the platform needs to be compatible with several application servers
• Complex edition or rich media manipulation
In this case having a rich client that seamlessly communicates with other desktop applications and offers
a rich GUI is more comfortable than a simple web browser.
• Interface is deployed on a rich client on the user desktop
• Services and storage are handled on the server
• Offline usage
In some cases, it is useful to be able to manipulate and contribute content without needing a network
connection.
• GUI and some services (like a local repository) need to be deployed on the client side
• Server hosts the collaborative services (like the workflow) and the central repository
• Distributed architecture
In order to be able to address the needs of large decentralized organizations, Nuxeo EP must provide a
way to be deployed on several servers on several locations
• Scale out on several servers
• Dedicate servers to some specific services
• Have one unique Web application accessing several decentralized repositories
• Use Nuxeo EP components from another application
When building a business application, it can be useful to integrate services from Nuxeo EP in order to
address all content oriented needs of the application.
• Provide web service API to access generic ECM services (including repository)
Nuxeo EP 5.3 34
General Overview
• Provide EJB3 remoting API to access generic ECM services (including repository)
• Provide POJO API to generic ECM services
There are certainly a lot of other use cases, but mainly the constraints are:
• Be able to choose the deployment platform: POJO vs Java EE
As first deployment targets we choose
• Eclipse RCP: a rich client solution that uses a POJO (OSGi) component model
• JBoss Application Server: a Java EE 5 compliant application server
• Be able to choose the deployment location of each component: client side vs server side
The idea is to be able to deploy a component on the server side or on the client side without having to
change its code or its packaging
4.1.1.2. Leverage CPS experience
Before building Nuxeo EP we worked during several years on the Zope platform with the CPS solution. CPS
was deployed for a lot different use cases and we learned a lot of good practices and design patterns. Although
Nuxeo EP is a full rewrite of our ECM platform, we wanted to keep as many of the good CPS concepts as
possible.
• Concept of schemas and documents
Inside CPS most of the data manipulated was represented by a document object with a structure based on
schemas.
This concept is very interesting:
• Schemas enforce structure constraints and data integrity but also permit some flexibility.
When defining a schema you can specify what fields are compulsory, their data types etc, but you can
also define some flexible parts of the schema.
• Share API and UI components for Documents, Users, Records ...
Because the Document/Schema model is very flexible it can be used to manipulate different types of
data: like Users, Records and standards documents.
From the developer's perspective this permits using the same API and be able to reuse some UI
components
From the users' perspective it gives the application some consistency: because the same features and
GUI can be used for all the data they manipulate.
• Actions and Views
Because CPS was very pluggable, it was possible to easily define different views for each document type
and also to let additional components contribute new actions or views on existing documents.
Nuxeo EP has a similar concept of views and actions, even if technically speaking the technologies are
different.
• Lazy fetching and caching
Because ECM applications make a very intensive use of the repository and often need to fetch a lot of
different documents to construct each page, the way the document retrieval is handled if very important
Nuxeo EP 5.3 35
General Overview
to have a scalable application.
With CPS we worked a lot on caching and lazy fetching.
With Nuxeo EP we incorporated this requirement from the beginning:
• Distributed caching
• Lazy fetching on schemas and fields
4.1.1.3. Extensible platform based on components
CPS was constructed as a set of pluggable components relying on a common platform. This modularity has
been maintained in the new platform. Deploying a new feature or component on the new platform is as simple
as it was on the old one.
This requirement has a huge impact on the platform because the Java packaging model and the Java EE
constraints are not directly compatible with it.
Adding a new component should be as simple as dropping a file or an archive in some directory without having
to rebuild nor repackage the application.
This is important from the administrator point of view: be able to easily deploy new features.
This is also very important from the support point of view: to be able to deploy customized components without
taking the risk of forking the platform, and maintaining the possibility to upgrade the standard components.
4.1.1.4. Easily accessible development framework
The CPS framework was powerful but we know it was very complex to use. Not only because of the unusual
CMF/Zope/Python programming model, but also because there was a lot of different concepts and you had to
understand them all to be able to leverage the platform when building a new application on top of it.
Nuxeo EP aims at simplifying the task of the developer

• Clearly separate each layer
The idea is to clearly separate presentation, processing and storage so that developers can concentrate on
their task.
• Offer plugin API and SPI
Nuxeo EP is constructed as a set of plugins so you can modify the behavior of the application by just
contributing a new plugin. This is simpler because for common tasks we will offer a simple plugin API
and the developer just has to implement the given interface without having to understand each part of the
platform.
• Rely on JAVA standards
We try to follow as much as possible all the Java standards when they are applicable. This will allow
experienced Java developers to quickly contribute to the Nuxeo EP platform.
4.1.1.5. Leverage Java open source community
We know what it's like to have to build and maintain an entire framework starting from the application server.
With the switch to the Java technology, we will use as many existing open source components as possible and
focus on integrating them seamlessly into the ECM platform. Nuxeo EP is a complete integrated solution for
building an ECM application, but Nuxeo won't write all infrastructure components. This approach will also
make the platform more standards compliant.
Nuxeo EP 5.3 36
General Overview
Thus developers can optimize their Java/JEE and open source experience to use Nuxeo EP.
4.1.1.6. Make the platform ready for SI integration
Because ECM applications often need to be deeply integrated into the existing SI, Nuxeo EP will be easily
integrable
• API for each reusable service or component
Depending on the components, this API could be POJO, EJB3, or WebService, and in most cases it will
be available in the three formats.
• Pluggable hooks into Nuxeo EP
This mainly means synchronous or asynchronous events listener that are a great place to handle
communication and synchronization between applications.
4.1.1.7. Future-proof design
The Nuxeo EP platform was rewritten from the ground up with the switch to Java. But we don't plan to do this
kind of work every couple of years, it won't be efficient neither for us, nor for the users of the platform. For that
reason, we choose innovative Java technologies like OSGi, EJB3, JSF, Seam ....
4.1.2. Main concepts and design

All the design goals explained just before have a huge impact on the Nuxeo EP architecture. Before going into
more details, here are the main concepts of Nuxeo EP architecture.
4.1.2.1. Layered architecture
Nuxeo EP is built of several layers, following at least the 3 tiers standard architecture
• Presentation layer
Handles GUI interactions (in HTML, SWT ...)
• Service layer
Service stack that offers all generic ECM services like workflow, relations, annotations, record
management...
• Storage layer
Handles all storage-oriented services like document storage, versioning, life cycle ....
Depending on the components, their complexity and the needed pluggability, there can be more than 3 layers.
This layering of all the components brings Nuxeo EP the following advantages
• The ability to choose the deployment target for each part of a component
By separating clearly the different parts of a feature, you can choose what part to deploy on the client and
what part to deploy on a server.
• Clear API separation
Each layer will provide its own API stack
• Components are easier to reuse
Nuxeo EP 5.3 37
General Overview
Because the service and storage layers are not bound to a GUI, they are more generic and then more
reusable
Thanks to this separation in component families you can easily extract from Nuxeo EP the components you
need for your application.
If you need to include Document storage facilities into your application you can just use Nuxeo EP Core: It will
offer you all the needed features to store, version and retrieve documents (or any structured but flexible
dataset). If you also need process management and workflow you can also use Nuxeo EP Workflow service.
And finally, if you want to have a Web application to browse and manage your data, you can reuse the Nuxeo
EP Web layer.
4.1.2.2. Deployment services
The targeted platform does not provide the same mechanism to handle all the deployment tasks:
• Packaging (Java EE vs OSGi)
• Dependency management
• Extension management
Because of these differences, Nuxeo EP provides a unified deployment service that hides the specificity of the
target platform. This is also a way to add a pluggable component deployment system to some platforms that
don't handle this (like Java EE).
This is one of the motivating factors for the Nuxeo Runtime that will be briefly introduced later in this
document.
4.1.2.3. Extensible component model
In Nuxeo EP, an ECM application is seen as an assembly of components.
This assembly will include:

• Existing generic Nuxeo EP Components
• Extensions or configurations contributing to generic Nuxeo EP components
• Specific components and configuration
Inside Nuxeo EP each feature is implemented by one or several reusable components and services. A feature
may be implemented completely at storage level, or may require a dedicated service and a dedicated GUI.
Nuxeo EP Web application is a default distribution of a set of ECM components. This can be used "as is" or
can be the base for making a business ECM application.
• If you need to remove a feature
Just remove the component or deploy a configuration for disabling it.
• If you need to change the default behavior of one component
You can deploy a new configuration for the component .
• Declare a new Schema or define a document type
• Configure the versioning policy
• Deploy new workflow
Nuxeo EP 5.3 38
General Overview
• ...
This configuration may use an extension point to contribute to the new behavior (see Section 4.3.2,
“Extensible component model”, Section 4.3.2.2, “Extension points” and the chapter on extension points
in the Learning Nuxeo EP5 Guide. ) .
• Contribute a new security policy
• Contribute a new event handler
• Deploy a new View on a document
• ...
• If you need to add a completely new feature you can make your own component.
First check that there is no generic Nuxeo EP component available that could help you in your task (all
components are not deployed in the default webapp).
4.1.2.4. Use of innovative Java EE technology
Here is a quick list of the Java technology we use inside Nuxeo EP platform:
• Java 5
• Java EE 5: JSF and EJB3
• OSGi component model
• A lot a innovative open source projects
• JBoss Seam, Trinidad and Ajax4JSF on the web layer
• jBPM for the default workflow engine implementation
• Lucene for the default search engine implementation
• Jackrabbit JSR-170 repository for the default storage back end implementation
• JenaRDF for the relation framework
• ...
4.2. Nuxeo 5 Architecture Overview

The figure below shows a high level overview of the Nuxeo 5 Architecture that will be discussed in the sections
below. The sections that follow will discuss:
i. The Nuxeo Runtime (Section 4.3, “Nuxeo Runtime: the Nuxeo EP component model”)
ii. The Nuxeo Core Layer (Section 4.5, “Core Layer overview”)
iii. The Nuxeo Service/Platform Layer (Section 4.6, “Service Layer overview”)
iv. The Web Presentation Layer ( Section 4.7, “Web presentation layer overview”) - shown in the figure as
either a web interface or rich client interface implementation
Nuxeo EP 5.3 39
General Overview
4.3. Nuxeo Runtime: the Nuxeo EP component model
4.3.1. The motivations for the runtime layer

Building the Nuxeo Runtime was one of the first tasks we started. This is one of the main infrastructure
components of the Nuxeo EP architecture.
This section will give you a quick overview of the Nuxeo Runtime. A more detailed technical presentation can
be found in Section 29.1, “Overview” of this book.
4.3.1.1. Host platform transparency
Because most Nuxeo EP components are shared by Nuxeo RCP (OSGI/RCP) and Nuxeo EP (Java EE), an
abstraction layer is required so the components can transparently use the components services independently
from the underlying infrastructure.
Nuxeo Runtime provides an abstraction layer on top of the target host platform. Depending on the target host
platform, this Runtime layer may be very thin.
Nuxeo Runtime already supports Equinox (Eclipse RCP OSGi layer) and JBoss 4.x (JMX). The port of Nuxeo
Runtime to other Java EE application servers is in progress, we already have a part of Nuxeo EP components
that can be deployed on top of SUN Glassfish application server. Technically speaking, the port of Nuxeo
Runtime could be done on any JEE5 compliant platform and will be almost straightforward for any platform
that supports natively the OSGi component model.
4.3.1.2. Overcome Java EE model limitations
Java EE is a great standard, but it was not designed for a component based framework: it is not modular at all.
Nuxeo EP 5.3 40
General Overview
• Java EE deployment model limitations
• Most Java EE deployment descriptors are monolithic
For example, the web.xml descriptor is a unique XML file. If you want to deploy an additional
component that needs to declare a new Java module you are stuck. You have to make one version of
the web.xml for your custom configuration. For the Nuxeo EP platform, this constraint is not possible:
• Components don't know each other
Because there are a lot of optional components, we can't have a fixed configuration that fits all.
• We can make a version of the web.xml for each possible distribution
There are too many optional components to build one static web.xml for each possible combination.
This problem with the web.xml is of course also true for a lot of standard descriptors (application.xml,
faces-config.xml, persistence.xml, ejb-jar.xml ....)
• One archive for one web application
We have here the exact same problem as with the web.xml. additional components can contribute new
web pages, new web components ... We can have a monolithic web archive.
• No dependency declaration
Inside Java EE there is no standard way to declare the dependency between components.
Because Nuxeo EP is extensible and has a plugin model, we need that feature. A contribution is
dependent on the component it contributes to:
• Contribution is only activated if/when the target component is activated
• The contribution must be deployed after the target component as it may override some configuration
• Java EE component model limitations
• Unable to deploy a new component without rebuilding the whole package
If you take a .ear archive and want to add a new component, you have to rebuild a new ear.
• No support for versioned components
Nuxeo Runtime provides an extensible component model that supports all these features. It also handles the
deployment of these components on the target host platform.
4.3.2. Extensible component model

Nuxeo Runtime provides the component model for the platform.
This component model is heavily based on OSGi and provides the following features:
• Platform diagnostic component model
Can be deployed on POJO and Java EE platforms
• Supports dependencies management
Components explicitly declare their requirements and are deployed and activated by respecting the
inferred dependency chain.
• Includes a plugin model
Nuxeo EP 5.3 41
General Overview
To let you easily configure and contribute to deployed components
• A POJO test environment
Nuxeo Runtime components can be unit tested using JUnit without the need of a specific container.
4.3.2.1. The OSGi component model
OSGi (Open Services Gateway initiative) is a great standard for components based Java architecture.
OSGi provides out of the box the following features:

• Dependencies declaration and management
A component gets activated only when the needed requirements are fulfilled
• Modular deployment system
• Manage bundles
• Manage fragments (sub parts of a master bundle)
• an OSGi bundle can define one or several services
• A system to identify and lookup a component
For Nuxeo EP, the OSGi standard provides a lot of the needed features. This is the reason why Nuxeo Runtime
is based on OSGi. In fact Nuxeo Runtime component model is a subset of the OSGi specification.
To ensure platform transparency, Nuxeo Runtime provides adapters for each target platform to help it support
OSGi components.
• This adapter layer is very thin on Equinox (Eclipse RCP) since the underlying platform is already OSGi
compliant.
• This adapter may be more complex for platforms that are not aware of OSGi (JBoss 4.x or Glassfish)
In this case, the runtime adapter will handle all OSGi logic and deploy the components as native platform
components. For example, on JBoss 4.x, Runtime components are deployed as JMX MBeans.
4.3.2.2. Extension points
OSGi does not define a plugin model, but the Eclipse implementation (Equinox) does provide an extension
point system.
Because we found many benefits in the Eclipse Extension Point system, Nuxeo Runtime also includes an
Extension Point system. In other words, the underlying mechanism which allows extension points to be
implemented in Nuxeo EP, has been built into the Nuxeo EP runtime and core.
An extension point is a way to declare that your component can be customized from the outside:
• Contribute configuration
Activate or deactivate a component. Define resources for a given service.
• Contribute code and behavior
Extension points also give you the possibility to register plugins
Nuxeo EP 5.3 42
General Overview
Basically every Nuxeo Component can:

• declare its dependencies
The component will also be activated after all needed components have been activated
• declare exposed extension points
Each component can define extension points that other components can use to contribute configuration
or code.
• declare contribution to other components
Extension points and contributions to extension points are defined using a XML descriptor that has to be
referenced in the MANIFEST.MF. For a more detailed understanding of extension points in Nuxeo EP, we
recommend reading the Learning Nuxeo EP5 guide.
4.3.2.2.1. Some examples of extension point usage

Inside Nuxeo 5, extension points are used each time a behavior or a component needs to be configurable or
pluggable.
Here are some examples of extension points used inside the Nuxeo 5 platform.
• Schemas and document types
Inside Nuxeo 5 a document structure is defined by a set of XSD schemas. Schemas and Document Types
are defined using an extension point.
• Storage repository
Nuxeo core stores documents according to their type but independently of the low level storage
back-end. The default back-end is Jackrabbit JCR implementation. Nuxeo Core exposes an extension
point to define the storage back-end. We are working on another repository implementation that will be
purely SQL based.
• Security Management
Nuxeo include a security manager that checks access rights on each single operation. The extension point
system allow to have different implementation of the security manager depending on the project
requirements:
• Enforce data integrity: store security descriptors directly inside the document
• Performance: store security descriptors in an externalized index
• Corporate security policy: implement a specific security manager that will enforce business rules
• Event handlers
Nuxeo platform lets you define custom Event handler for a very large variety of events related to content
or processes. The event handler extension mechanism gives a powerful way to add new behavior to an
existing application
• You can modify the behavior of the application without changing its code
• The development model is easy because you have a very simple Interface to implement and you can
use Nuxeo Core API to manipulate the data
• Event handlers can be synchronous or asynchronous
Nuxeo 5 itself uses the Event Handler system for a lot of generic and configurable services
Nuxeo EP 5.3 43
General Overview
• Automatic versioning: create a new version when a document is modified according to business rules
• Meta-data automatic update: update contributor lists, last modification date ...
• Meta-data extraction / synchronization: extract Meta-Data from MS-Office file, Picture ....
4.3.2.2.2. Nuxeo 5 Platform development model

Nuxeo 5 development model is heavily based on the usage of extension points. When a project requires specific
features we try as much of possible to include it as an extension of the existing framework rather than writing
separated specific component. This means make existing services more generic and more configurable and
implement the project specific needs as a configuration or a plugin of a generic component using Extension
Points.
4.3.3. Flexible deployment system

Nuxeo Runtime also provides deployment services to manage how components are deployed and contribute to
each other
• Dependencies management
The dependencies are declared in the MANIFEST.MF and can also be defined in XML descriptors that hold
contributions.
The Nuxeo Runtime orders the component deployment in order to be sure the dependencies are
respected. Components that have unresolved dependencies are simply not deployed
• Extension point contributions
XML descriptors are referenced in the MANIFEST.MF. These descriptors make contributions to existing
extension points or declare new extension points.
• Each component has its own deployment-fragment
The deployment fragment defines
• Contribution to configuration files
For example contribute a navigation rule to faces-config.xml or a module declaration to web.xml.
Nuxeo Runtime lets you declare template files (like web.xml, persistence.xml) and lets other
components contribute to these files.
• Installation instructions
Some resources contributions (like i18n files or web pages) need more complex installation
instructions because they need archives and file manipulations. Nuxeo Runtime provide basic
commands to define how your components should be deployed
Here is a simple example of a deployment-fragment.

<fragment>
<extension target="application#MODULE">
<module> <ejb>${bundle.fileName}</ejb> </module>
</extension>
<extension target="faces-config#VALIDATOR">
<validator>
<validator-id>dueDateValidator</validator-id>
<validator-class>org.nuxeo.ecm.platform.workflow.web.ui.jsf.DueDateValidator</validator-class>
</validator>
</extension>
<install>

<unzip from="${bundle.fileName}" to="/">
<include>nuxeo.war/**</include>
Nuxeo EP 5.3 44
General Overview
</unzip>


<delete path="nxworkflow-client.tmp" />
<mkdir path="nxworkflow-client.tmp" />
<unzip from="${bundle.fileName}" to="nxworkflow-client.tmp">
<include>OSGI-INF/l10n/**</include>
</unzip>
<append from="nxworkflow-client.tmp/OSGI-INF/l10n/messages.properties"
to="nuxeo.war/WEB-INF/classes/messages.properties" addNewLine="true" />
<append from="nxworkflow-client.tmp/OSGI-INF/l10n/messages_en.properties"
to="nuxeo.war/WEB-INF/classes/messages_en.properties" addNewLine="true" />
<append from="nxworkflow-client.tmp/OSGI-INF/l10n/messages_fr.properties"
to="nuxeo.war/WEB-INF/classes/messages_fr.properties" addNewLine="true" />
<append from="nxworkflow-client.tmp/OSGI-INF/l10n/messages_de.properties"
to="nuxeo.war/WEB-INF/classes/messages_de.properties" addNewLine="true" />
<append from="nxworkflow-client.tmp/OSGI-INF/l10n/messages_it.properties"
to="nuxeo.war/WEB-INF/classes/messages_it.properties" addNewLine="true" />
<delete path="nxworkflow-client.tmp" />
</install>
</fragment>
4.4. Nuxeo EP layered architecture
4.4.1. Layers in Nuxeo EP

Nuxeo EP components are separated in 3 main layers: Core / Service / UI
From the logical point of view each layer is a group of components that provide the same nature of service:
• Storage oriented services: Nuxeo Core
Nuxeo core provides all the storage services for managing documents
• Repository service
• Versioning service
• Security service
• Lifecycle service
• Records storage (directories)
• ...
• Content and process oriented services: Nuxeo Platform
Nuxeo provides a stack of generic services that handle documents and provide content and process
management features. Depending on the project requirement only a part of the existing services can be
deployed.
Typical Nuxeo EP platform services are:
• Workflow management service
• Relation management service
• Archive management service
• Notification service
• ...
• Presentation service: UI Layer
The UI layer is responsible for providing presentation services like
Nuxeo EP 5.3 45
General Overview
• Displaying a view of a document
• Displaying available actions according to context
• Managing page flow on a process driven operation
These services can be very generic (like the action manager) but can also be directly tied to a type of
client (like the View generation can be bound to JSF/facelets for the web implementation)
The layer organization can also be seen as a deployment strategy
Thanks to the Nuxeo Runtime remoting features it is very easy to split the components on several JVMs. But
splitting some services can have a very bad effect on the global system performance.
Because of this, all the storage oriented services are inside the core. All components that have extensive usage
of the repository and need multiple synchronous interaction with it are located in the core. This is especially
true for all synchronous event handlers.
The services layer can itself be split in multiple deployment units on multiple JVMs.
On the UI side all the services are logically deployed inside the same JVM. At least each JVM must have the
minimum set of services to handle user interaction for the given application.
The components are also grouped by layers according to their dependencies.
Core Modules can depend on Core Internal API.
Generic ECM services can depend on Core external API and can depend on external optional library (like
jBPM, Jena, OpenOffice.org ...).
UI services can rely on a client side API (like Servlet API) and share a common state associated to the user
session.
Layers are also organized according to deployment target.
The Core layer is a POJO Layer with an optional EJB facade. The core can be embedded in a client application.
The services are mostly implemented as POJO services so that they can be used as an embedded library. But
some of them can depend on typical Application Server infrastructure (like JMS or EJB).
Inside the UI Layer most services are dedicated to a target platform: web (JSF/Seam), Eclipse RCP or other.
Because the layer organization has several constraints, the implementation of a unique feature is spread across
several layers.
Typically a lot of these "transverse services" are split into several sub-components in each layer in order to
comply with deployment constraints and also to provide better reusability. For example, the Audit service is
made of 3 main parts which are split across 3 layers:
• Core Event <=> JMS bridge (Core Layer)
Forwards core events to JMS Bridge according to configuration.
• JMS Listener and JPA Logger (Service Layer)
Message driven bean that writes logs in DB via JPA.
• Audit View (UI Layer)
Nuxeo EP 5.3 46
General Overview
Generates HTML fragment that displays all events that occurred on a document.
4.4.2. API and Packaging impacts

The layer organization can also be seen in the API.
4.4.2.1. Core API
Most of the components forming the core are exposed via the DocumentManager / CoreSession interface. The
interfaces and dependencies needed to access the Core services are packaged in an API package: even if there
are several Core components, you have only one dependency and API package.
The idea is that for accessing the core, you will only need to use the DocumentManager to manipulate
DocumentModels (the document object artifact). Some core services can be directly accessed via the
DocumentModel (like the life cycle or security data).
4.4.2.2. Service Stack API
Each service exposes its own API and then has its own API package. Service related data (like process data,
relation data) are not directly hosted by the DocumentModel object but can be associated to it via adapters and
facets.
4.4.2.3. UI API
The web layer can be very specific to the target application. Nuxeo EP provides a default web application and a
set of base classes, utility classes and pluggable services to handle web navigation inside the content repository.
4.4.2.4. Packaging
Most features are made of several Java projects and generate several Maven 2 artifacts.
Nuxeo packaging and deployment system (Nuxeo Runtime, Platform API, Maven ...) leverage this separation
to help you distributing the needed deployment unit according to your target physical platform.
4.5. Core Layer overview
Nuxeo EP 5.3 47
General Overview
4.5.1. Features of Nuxeo Core

Nuxeo core provides all the storage services for managing documents.
• Schema service
Lets you register XSD schemas and document types based on schemas.
• Repository service
Lets you define one or more repository for storing your documents.
• Versioning service
Nuxeo EP 5.3 48
General Overview
Lets you configure how to store versions.
• Security service
Manages data level security checks
• Lifecycle service
Manages life cycle state of each document
4.5.2. Nuxeo Core main modules
4.5.2.1. Nuxeo Repository Service
The repository service lets you define new document repositories. Defining separate repositories for your
documents is pretty much like defining separate Databases for your records.
Because Nuxeo Core defines an SPI on repository, you can configure how you want the repository to be
implemented. For now, the default implementation uses JSR-170 (Java Content Repository) reference
implementation: Apache Jack Rabbit. In the future, we may provide other implementations of the Repository
SPI (like native SQL DB or Object Oriented DB).
Even if for now there is only one Repository implementation available, using JCR implementation, you can
configure how your data will be persisted: filesystem, xml or SQL Database. Please see "How to"s about
repository configuration (Chapter 44, RDBMS Storage and Database Configuration).
When defining a new repository, you can configure:

• The name.
• The configuration file
For JCR, it lets you define persistence manager.
• The security manager
Defines how security descriptors are stored in the repository (for now:
org.nuxeo.ecm.core.repository.jcr.JCRSecurityManager)
• The repository factory
Defines how the repository is created (for now:

org.nuxeo.ecm.core.repository.jcr.JCRRepositoryFactory)
4.5.3. Schemas and document types

The repository enforces data integrity and consistency based on Document types definition.
Each document type is defined by:

• A name.
• An optional super document type (inheritance)
• A list of XSD schemas
Defines storage structure
Nuxeo EP 5.3 49
General Overview
• A list of facets
Simple markers used to define document behavior.
Here is a simple DocumentType declaration:

point="doctype">
<documentation>The core document types</documentation>
<doctype name="Folder" extends="Document">
<schema name="common" />
<schema name="dublincore" />
<facet name="Folderish" />
</doctype>
</extension>
For further explanation on Schemas and Document types, please see Chapter 5, Schemas and Documents.
4.5.4. The life cycle associated with documents

Inside the Nuxeo repository each document may be associated with a life-cycle. The life-cycle defines the
states a document may have and the possible transitions between these states. Here we are not talking about
workflow or process, rather we are just defining the possible states of a document inside the system.
The Nuxeo Core contains a LifeCycleManager service that exposes several extension points:
• one for contribution to the Life-Cycle management engine
(the default one is called JCRLifeCycleManager and stores life-cycle related information directly inside
the JSR 170 repository)
• one for contributing life-cycle definition
This includes states and transitions. On 5.2, since 5.2.0, it is possible to define additional initial states to
the default state, by adding a keyword to the state definition, for instance: <state name="approved"
description="Content has been validated" initial="true">. The desired initial state can be passed in the
document model context data used for creation: document.putContextData("initialLifecycleState",
"approved").
• one for binding life-cycle to document-types
Here is an example
<lifecycle name="default" lifecyclemanager="jcrlifecyclemanager"
initial="project">
<transitions>
<transition name="approve" destinationState="approved">
<description>Approve the content</description>
</transition>
<transition name="obsolete" destinationState="obsolete">
<description>Content becomes obsolete</description>
</transition>
<transition name="delete" destinationState="deleted">
<description>Move document to trash (temporary delete)</description>
</transition>
<transition name="undelete" destinationState="project">
<description>Recover the document from trash</description>
</transition>
<transition name="backToProject" destinationState="project">
<description>Recover the document from trash</description>
</transition>
</transitions>
<states>
<state name="project" description="Default state">
<transitions>
<transition>approve</transition>
<transition>obsolete</transition>
<transition>delete</transition>
</transitions>
</state>
<state name="approved" description="Content has been validated">
<transitions>
<transition>backToProject</transition>
Nuxeo EP 5.3 50
General Overview
</transitions>
</state>
<state name="obsolete" description="Content is obsolete">
<transitions>
<transition>backToProject</transition>
</transitions>
</state>
<state name="deleted" description="Document is deleted">
<transitions>
<transition>undelete</transition>
</transitions>
</state>
</states>
</lifecycle>
Life-Cycle service is detailed later in this document (Section 30.4.5, “Life Cycle” and Section 30.5.2,
“LifeCycle Managers”).
4.5.5. Security model

Note: You may also want to read the chapter on "Access Control and Security" in the Learning Nuxeo EP5
Guide.
Inside the Nuxeo Repository security is always checked when accessing a document.
The Nuxeo security model includes :

• Permissions
(Read, Write, AddChildren, ...).
Permissions management is hierarchical (there are groups of permissions)
• ACE: Access Control Entry
An ACE grants or denies a permission to a user or a group of users.
• ACL: Access Control List
An ACL is a list of ACEs.
• ACP: Access Control Policy
An ACP is a stack of ACLs. We use ACP because security can be bound to multiples rules: there can be
a static ACL, an ACL that is driven by the workflow, and another one that is driven by business rules.
Separating ACLs allows us to easily reset the ACP when a process or a rules does not apply any more.
Inside the repository each single document can have an ACP. By default security descriptors are inherited from
their parent, but inheritance can be blocked when needed.
The security engine also lets you contribute custom policy services so that security management can include
business rules.
The security model and policy service are described in detail later in this document.
4.5.6. Core events system

When an event occurs inside the repository (document creation, document modification, etc...), an event is sent
to the event service that dispatches the notification to its listeners. Listeners can perform any number of actions
when receiving an event, which may include modifying the document on the fly.
Nuxeo EP 5.3 51
General Overview
As an example, part of the dublincore management logic is implemented as a CoreEvent listener: whenever a
document is created or modified, the "creation date", "modification date", "author" and "contributors" fields are
automatically updated by a CoreEvent Listener.
The Core Events system is explained in more detail later in this document (see Chapter 32, Nuxeo Event
Service and Chapter 9, Event Listeners and Scheduling) and in the Learning Nuxeo EP5 guide.
4.5.7. Query system

The Repository supports a Query API to extract Documents using SQL like queries.
NXQL (the associated Query Language) is presented later in this document (see Example 11.2, “Sample NXQL
queries”).
4.5.8. Versioning system

The documents in the repository can be versioned.
Nuxeo Core provides:

• A pluggable version storage manager
This lets you define how versions are stored and what operations can be done on versions
• A pluggable versioning policy
This lets you define rules and logic that drive when new versions must be created and how version
numbers are incremented.
The versioning system is explained in details later in this document (see Chapter 16, Document Versioning).
4.5.9. Repository and SPI Model

Nuxeo Core exposes a repository API on top of Jackrabbit JSR170 repository.
Nuxeo repository is implemented using an SPI and extension point model: this basically means that a non JCR
based repository plugin can be contributed. In fact, we have already started a native SQL repository
implementation (that is not yet finished because we have no direct requirement for such a repository).
Nuxeo core can server several repository: it provides a extension point to declare an additional repository: this
means a single web application can use several document repositories.
4.5.10. DocumentModel
Inside Nuxeo EP and especially inside the Core API the main data object is a Document.
Inside Nuxeo Core API, the object artifact used to represent a Document is called a DocumentModel.
The DocumentModel artifact encapsulates several useful features:

• Data Access over the network
the DocumentModel encapsulates all access to a Document's internal fields, and the DocumentModel can
be sent over the network
• DocumentModel supports lazy loading
When fetched from the Core, a DocumentModel does not carry all document related information. Some
data (called prefetch data) are always present, other data will be loaded (locally or remotely) from the
Nuxeo EP 5.3 52
General Overview
core when needed.
This feature is very important to reduce network and disk I/O when manipulating a Document that
contains a lot of big blob files (like video, music, images ...) .
• DocumentModel uses Core Streaming Service
For files above 1 MB the DocumentModel uses the Core Streaming service.
• DocumentModel carries the security descriptors
ACE/ACL/ACP are embedded inside the DocumentModel
• DocumentModels support an adapter service
In addition to the data oriented interface, a DocumentModel can be associated with one or more Adapters
that will expose a business oriented interface.
• DocumentModels embed lifecycle service access
• DocumentModels can have facets
Facets are used to declare a behavior (Versionnable, HiddenInNavigation, Commentable...)
A DocumentModel can be located inside the repository using a DocumentRef. DocumentRef can be an IdRef
(UUID in the case of the JCR Repository Implementation) or PathRef (absolute path).
DocumentModels also hold information about the Type of the Document and a set of flags to define some
useful characteristics of the Document:
• isFolder
Defines if the targeted document is a container
• isVersion
Defines if the targeted document is an historic version
• isProxy
Defines if the targeted document is a Proxy (see below)
4.5.11. Proxies
A Proxy is a DocumentModel that points to a another one: very much like a symbolic link between 2 files.
Proxies are used when the same document must be accessible from several locations (paths) in the repository.
This is typically the case when doing publishing: the same document can be visible in several sections (note:
'section' here has a special meaning as defined in the Nuxeo User Guide). In order to avoid duplicating the data,
we use proxies that point to same document.
A proxy can point to a checked out document (not yet associated to a version label) or to a versioned version
(typical use-case of publishing).
The proxy does not store document data: all data access are forwarded to the source document. But the Proxy
does holds:
• its own security descriptors
• its own DocumentRef
Nuxeo EP 5.3 53
General Overview
4.5.12. Core API

TO DO
4.6. Service Layer overview
4.6.1. Role of services in Nuxeo EP architecture

The service layer is an ECM services stack on top of the Nuxeo Repository. In a sense, the Repository itself is
very much like any service of this layer, it just plays a central role.
This service layer is used for :

• adding new generic ECM services (Workflow, Relations, Audit ...)
• adding connectors to existing external services
• adding dedicated project-specific components when the requirements can not be integrated into a generic
component
This service layer provides the API used by client applications (Webapp or RCP based applications) to do their
work.
This means that in this layer, services don't care about UI, navigation or pageflows: they simply explore an API
to achieve document oriented tasks.
4.6.2. Services implementation patterns

Nuxeo platform provides a lot of different services, but they all fellow the same implementation pattern. This
basically means that once you understand how works one service, you almost know how they all work.
As with everything in the Nuxeo Platform the services use the Nuxeo Runtime component model.
A generic service will be composed of the following packages :

• An API package (usually called nuxeo-platform-XXX-api)
Contains all interfaces and remotable objects.
This package is required to be able to call the service from the same JVM or from a remote JVM.
You can view these in your Nuxeo server installation directory if you are curious
(/nuxeo/server/default/deploy/nuxeo.ear/system/ - assuming you have your server installed in /nuxeo).
• A POJO Runtime component (usually called nuxeo-platform-XXX-core)
The Runtime component will implement the service business logic (ie: implement the API) and also
expose Extensions Points.
All the extensibility and pluggability is handled at runtime component level. This for example means that
the API can be partially implemented via plugins.
• A EJB3 Facade (usually called nuxeo-platform-XXX-facade)
The facade exposes the same API as the POJO component.
The target of this facade is to:
• provide EJB3 remoting access to the API
Nuxeo EP 5.3 54
General Overview
• integrate the service into JEE managed environment (JTA and JAAS)
• leverage some additional features of the application server like JMS and Message Driven Bean
• provide state management via Stateful Session Beans when needed
Typically, the POJO module will be a Nuxeo Runtime Component that inherits from DefaultComponent,
provides extension points and implements a Service Interface.
public class RelationService extends DefaultComponent
implements RelationManager { ...}
The deployment descriptor associated with the component will register the component, declare it as service
provider and it may also declare extension points
<component name="org.nuxeo.ecm.platform.relations.services.RelationService">
<implementation class="org.nuxeo.ecm.platform.relations.services.RelationService" />
<service>
<provide interface="org.nuxeo.ecm.platform.relations.api.RelationManager" />
</service>

</component>
The facade will declare an EJB that implements the same service interface. In simple cases, the implementation
simply delegates calls to the POJO component.
The facade package will also contain a contribution to the Runtime Service management to declare the service
implementation.
<?xml version="1.0" encoding="UTF-8"?>
<component name="org.nuxeo.ecm.platform.relation.service.binding.contrib">
<extension target="org.nuxeo.runtime.api.ServiceManagement" point="services">
<documentation> Define the Relation bean as a platform service. </documentation>
<service class="org.nuxeo.ecm.platform.relations.api.RelationManager" group="platform/relations">
<locator>%RelationManagerBean</locator>
</service>
</extension>
</component>
Thanks to this declaration the POJO and the EJB Facade can now be used for providing the same interface
based on a configuration of the framework and not on the client code.
This configuration is used when deploying Nuxeo components on several servers: platform configuration
provides a way to define service groups and to bind them together on physical servers.
4.6.3. Platform API

Each service provides its own API composed of a main interface and of the other interfaces and types that can
be accessed.
The API package is unique for a given service, and access to a remote EJB3 based service is the same as
accessing the POJO service.
From the client point of view, accessing a service is very simple and independent from service location and
implementation: this means a manual JNDI call is not required. Everything that is needed is encapsulated in the
Framework.getService runtime API.
RelationManager rm = Framework.getService(RelationManager.class);
The framework.getService will return the interface of the required service:
Nuxeo EP 5.3 55
General Overview
• This can be the POJO service (ie: Runtime Component based Service)
• This can be the local interface of the EJB3 service (using call by ref in JBoss)
• This can be the remote interface of the EJB3 service (using full network marshalling)
The choice of the implementation to return is left to the Nuxeo Runtime that will take the decision based on the
platform configuration.
The client can explicitly ask for the POJO service via the Framework.getLocalService() API: this is typically
used in the EJB Facade to delegate calls to the POJO implementation.
4.6.4. Adapters
DocumentModel adapters are a way to adapt the DocumentModel interface (that is purely data oriented) to a
more business logic oriented interface.
In the pure Service logic, adding a comment to a document would look like this:
CommentManager cm = Framework.getService(CommentManager.class);
cm.createComment(doc,"my comment");
List<DocumentModel> comments = cm.getComments(doc);
DocumentModel adapters give the possibility to have a more object oriented API:
CommentableDoc cDoc = doc.getAdapter(CommentableDoc);
cDoc.addComment("my comment");
List<DocumentModel> comments = cDoc.getComments();
The difference may seem small, but DocumentModel adapter can be very handy
• to have cleaner and clearer code
• to handle caching at the DocumentModel level
• to implement behavior and logic associating a Document with a Service
DocumenModelAdapters are declared using an extension point that defines the interface provided by the
adapter and the factory class. DocumentModelAdapters can be associated to a Facet of the DocumentModel.
4.6.5. Some examples of Nuxeo EP services

TO DO
4.7. Web presentation layer overview
4.7.1. Technology choices
4.7.1.1. Requirements
The requirements for the Nuxeo Web Framework are :

• A Powerful templating system that supports composition
• A modern MVC model that provides Widgets, Validators and Controllers
Nuxeo EP 5.3 56
General Overview
• A standard framework
• A set of Widget libraries that allow reusing existing components
• Support for AJAX integration
4.7.1.2. The JSF/Facelets/Seam choice
Nuxeo Web Layer uses JSF (SUN RI 1.2) and Facelets as presentation layer: JSF is standard and very
pluggable, Facelets is much more flexible and adapted to JSF than JSP.
NXThemes provides a flexible Theme and composition engine based on JSF and Facelets.
In the 5.1 version of the platform, Nuxeo Web Layer uses Apache Tomahawk and trinidad as a components
library and AJAX4JSF for Ajax integration. In the 5.2 version we will move to Rich Faces.
Nuxeo Web Layer also uses Seam Web Framework to handle all the ActionListeners.
Using Seam provides :

• Simplification and help with JSF usage
• A context management framework
• Dependency injection
• Remoting to access ActionsListeners from JavaScript
• A built-in event system
4.7.2. Componentized web application
4.7.2.1. Requirements
Nuxeo Web Layer comes on top of a set of pluggable services.
Because this stack of services is very modular, the web layer must also be modular.
This basically means that depending on the set of deployed services and on the configuration, the web
framework must provide a way
• to add, remove or customize views
for example, if you don't need relations, you may want to remove the relations tab that is available on
document by default
• to add or remove an action button or link
the typical use case is removing actions that are bound to non-deployed services or to add new actions
that are specific to your project
• to override an action listener
you may want to change how some actions are handled by just overriding Nuxeo defaults
• to add or customize forms
Adding fields or customizing forms used to display documents is very useful
Nuxeo EP 5.3 57
General Overview
In order to fullfill these requirements, the key points of Nuxeo Web Frame fulfill:
• Context management to let components share some state
• Event system and dependency injection to let loosely coupled components collaborate
• A deployment system to let several components make one unique WebApp
• A set of pluggable services to configure the web application
4.7.2.2. Context management
Inside the web framework, each component will need to know at least
• the current navigation context
This includes current document, current container, current Workspace, current Domain.
This information is necessary because most of the services will display a view on the current document,
and can fetch some configuration from the content hierarchy.
• the current user
This includes not only identity and roles, but also its preferences and the set of documents they choose to
work on
In some cases, this context information may be huge, and it's time consuming to recompute all this information
for each request.
Inside Nuxeo Web Framework, Seam context management is used to store this data. Depending on the lifecycle
of the data, Session, Conversation or Event context are used.
4.7.2.3. Loosely coupled component
At some point the components of the web framework need to interact with each other. But because components
can be present or not depending on the deployment scenario, they can't call each other directly.
For that matter, the Nuxeo Web Framework uses a lot of Seam features:
• Seam's context is used to share some state between the components
• Seam's event system is used to let components notify each other
• Seam's dependency injection and Factory system is used to let components pull some data from each
other without having to know each other
In order to facilitate Nuxeo Services integration into the web framework, we use the Seam Unwrap pattern to
wrap a Nuxeo Service into Seam Components that can be injected and manipulated as a standard Seam
component.
4.7.2.4. Deployment
The Web Layer is composed of several components.
The main components are webapp-core (default webapp base) and ui-web (web framework). On top of these
base components, dedicated web components are deployed for each specific service.
For example, the workflow-service has its own web components package, so do relation-service, audit-service,
comment-service and so on.
Each package contains a set of views, actions, and ActionsListeners that are dedicated to one service and
Nuxeo EP 5.3 58
General Overview
integrate this service into the base webapp.
Because JEE standards require the webapp to be monolithic (ie. it cannot be split up), we use the Nuxeo
Runtime deployment service to assemble the target webapp at deployment time.
This deployment framework let you: override resources, contribute XML descriptors like web.xml from several
components and manage deployment order.
4.7.2.5. Key web framework services
TO DO
Nuxeo EP 5.3 59
Chapter 5. Schemas and Documents
5.1. Introduction
This chapter presents the concepts of schemas and document types, which are used to define new documents in
Nuxeo EP 5.
5.1.1. Concepts
In Nuxeo EP 5, a fundamental entity is the document. A file, a note, a vacation request, an expense report, but
also a folder, a forum, can all be thought of as documents. Objects that contain documents, like a folder or a
workspace, are also themselves documents.
Any given document has a document type. The document type is specified at creation time, and does not change
during the lifetime of the document. When referring to the document type, a short string is often used, for
instance “Note” or “Folder”.
A document type is the grouping of several schemas. A schema represents the names and structure (types) of a
set of fields in a document. For instance, a commonly-used schema is the Dublin Core schema, which specifies
a standard set of fields used for document metadata like the title, description, modification date, etc.
To create a new document type, we start by creating one ore more schemas that the document type will use.
The schema is defined in a .xsd file (which obeys the standard XML Schema syntax) and is registered by a
contribution to a schema extension point.
The document type is registered through a contribution to another doctype extension point, and will specify
which schemas it uses. We also register the document type as a high-level type used by the EJB and rendering
layers.
“Core” document types and “ECM” component types should not be confused. The former live in the core
Nuxeo EP packages, the latter belong to the high level components. Apart from their definition, most of the uses
of "document types" refer to the “ECM” kind.
5.2. Schemas
A schema describes the names and types of some fields. The name is a simple string, like "title", and the type
describes what kind of information it stores, like a string, an integer or a date.
First, we create a schema in the resources/schemas/sample.xsd file:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://project.nuxeo.org/sample/schemas/sample/">
<xs:element name="sample1" type="xs:string"/>
<xs:element name="sample2" type="xs:string"/>
</xs:schema>
This schema defines two things:

• an XML namespace that will be associated with the schema,
• two elements and their type.
The two elements are sample1 and sample2. They are both of type xs:string, which is a standard type defined
by the XML Schema specification.
This schema has to be referenced by a configuration file so that the system knows it has to be read. The
configuration file will be placed in OSGI-INF/core-types-contrib.xml (the name is just a convention):
Nuxeo EP 5.3 60
Schemas and Documents
<component name="org.nuxeo.project.sample.coreTypes">
<extension target="org.nuxeo.ecm.core.schema.TypeService" point="schema">
<schema name="sample" src="schemas/sample.xsd"/>
</extension>
</component>
We name our schema sample, and the .xsd schema was placed under resources/ which means that at runtime,
it will be available directly from the Jar, therefore we reference it through the path schemas/sample.xsd. The
schema is registered through an extension point of the Nuxeo component
org.nuxeo.ecm.core.schema.TypeService named schema. Our own extension component is given a name,
org.nuxeo.project.sample.coreTypes, which is not very important as we only contribute to existing
extension points and don't define new ones.
Finally, we tell the system that the OSGI-INF/core-types-contrib.xml file has to be read, by mentioning it in
the Nuxeo-Component part of the META-INF/MANIFEST.MF file of our bundle:
Manifest-Version: 1.0
Bundle-ManifestVersion: 1
Bundle-Name: NXSample project
Bundle-SymbolicName: org.nuxeo.project.sample;singleton:=true
Bundle-Version: 1.0.0
Bundle-Vendor: Nuxeo
Require-Bundle: org.nuxeo.runtime,
org.nuxeo.ecm.core.api,
org.nuxeo.ecm.core
Provide-Package: org.nuxeo.project.sample
Nuxeo-Component: OSGI-INF/core-types-contrib.xml
5.3. Core Document Types

By itself, the schemas is not very useful. We associate it with a new “core” document type that we will be
creating. In the same OSGI-INF/core-types-contrib.xml as above, we add the following:
<component name="org.nuxeo.project.sample.coreTypes">
<schema name="sample" src="schemas/sample.xsd" prefix="smp"/>
</extension>
<extension target="org.nuxeo.ecm.core.schema.TypeService" point="doctype">
<doctype name="Sample" extends="Document">
<schema name="common"/>
<schema name="dublincore"/>
<schema name="sample"/>
</doctype>
</extension>
</component>
The document type is defined through a contribution to an other extension point, doctypes, of the same
extension component as before, org.nuxeo.ecm.core.schema.TypeService. We specify that our document
type, Sample, will be an extension of the standard system type Document, and that it will be composed of three
schemas, two standard ones and our specific one.
The Dublin Core schema that we use already contains standard metadata fields, like a title, a description, the
modification date, the document contributors, etc. Adding it to our document type ensures that a minimal level
of functionality will be present.
5.4. ECM Document Types

After the “core” document type, we need to create the “ECM” document type. This is done through a
contribution to another extension point, that we place in the OSGI-INF/ecm-types-contrib.xml, the basic
structure of this file is:
<component name="org.nuxeo.project.sample.ecm.types">
<extension target="org.nuxeo.ecm.platform.types.TypeService" point="types">
<type id="Sample" coretype="Sample">
...
Nuxeo EP 5.3 61
</type>
</extension>
</component>
As of this writing, the document type id has to be the same as the underlying core type; this restriction may be
lifted in the future. The type element will contain all the information for this type, this is described below.
This extension file is added to META-INF/MANIFEST.MF so that it will be taken into account by the deployment
mechanism:
OSGI-INF/ecm-types-contrib.xml
Inside the type element, we provide various information, described below.
5.4.1. Label and Icon

<label>Sample document</label>
<icon>/icons/file.gif</icon>
The label and icon are used by the user interface, for instance in the creation page when a list of possible types
is displayed. The icon is also used whenever a list of document wants to associate an icon with each.
5.4.2. Default view

<default-view>view_documents</default-view>
The default view specifies the name of the Facelet to use for this document if nothing is specified. This
corresponds to a file that lives in the webapp, in this case view_documents.xhtml is a standard view defined in
the base Nuxeo bundle, that takes care of displaying available tabs, and the document body according to the
currently selected type. Changing it is not advised unless extremely nonstandard rendering is needed.
5.4.3. Layout
5.4.3.1. Configuration
Here is the new layout configuration:

<layout>note</layout>
</layouts>
Layouts are defined in a given mode (default modes are "create", "edit" and "view") ; layouts in the "any" mode
will be merged with layouts defined for specific modes.
The layout names refer to layouts defined on another extension point. Please see the layouts section for more
information.
5.4.3.2. Deprecated configuration
Here is the old layout configuration that has been replaced by the above. If present, it is used instead of the new
configuration for compatibility purposes.
<layout>
<widget jsfcomponent="h:inputText"
schemaname="dublincore" fieldname="title"
required="true" />
<widget jsfcomponent="h:inputTextarea"
schemaname="dublincore" fieldname="description" />
Nuxeo EP 5.3 62
schemaname="sample" fieldname="sample1" />
</layout>
This section defines a series of widgets, that describe what the standard layout of this document type will be. A
layout is a series of widgets, which make the association between the field of a schema with a JSF component.
The layout is used by the standard Nuxeo modification and summary views, to automatically display the
document according to the layout rules. Note that the layout system is still young and is subject to minor
changes in the future. Here we define four widgets, displayed as simple input fields or as a text area.
5.4.4. Containment rules

<subtypes>
<type>Sample</type>
</subtypes>
</type>
<subtypes>
<type>Sample</type>
</subtypes>
</type>
This contributes a rule to an already existing type, Folder. The subtypes element specifies which types can be
created inside the type in which the element is embedded.
Here, we specify that our Sample type can be created in a Folder and a Workspace.
5.4.5. Hidden cases

The goal is to contribute a way to define hidden cases for the subtypes definition. A syntax like the following
can be used:
<type id="Workspace">
<subtypes>
<type hidden="create">Folder</type>
<type>File</type>
<type>Note</type>
</subtypes>
</type>
If more than one hidden cases needs to be defined, then a syntax like the following can be used:
<type id="Workspace">
<subtypes>
<type hidden="create, paste">Folder</type>
<type>File</type>
<type>Note</type>
</subtypes>
</type>
The hidden cases are stored in a list ([create, paste] for the above example), so if a check is needed for a hidden
case, then the hidden cases list ought to be verified if contains that particular case.
5.4.6. Summary
The final OSGI-INF/ecm-types-contrib.xml looks like:
<component name="org.nuxeo.project.sample.ecm.types">
<type id="Sample" coretype="Sample">
<label>Sample document</label>
Nuxeo EP 5.3 63
<icon>/icons/file.gif</icon>
<layout>
schemaname="dublincore" fieldname="title"
required="true" />
<widget jsfcomponent="h:inputTextarea"
schemaname="dublincore" fieldname="description" />
</layout>
</type>
<subtypes>
<type>Sample</type>
</subtypes>
</type>
<subtypes>
<type>Sample</type>
</subtypes>
</type>
</extension>
</component>
Nuxeo EP 5.3 64
Part II. Platform Services
Nuxeo EP 5.3 65
Chapter 6. Exception Handling
6.1. Introduction
The ExceptionHandlingService handles the exceptions that bubbled outside of Nuxeo. It allows to define
handlers to forward to an error page with adequate messages and logs.
It is composed of 3 extension points: the errorHandlers configures the handlers, the requestdump configures the
way the request will be written to error log and listener allows to set a listener to the process so state can be
restore in case of error.
This service is only available in Nuxeo 5.2
6.2. Extension Points
6.2.1. requestdump
The request dump extension point allows to contribute a RequestDumper class. It takes a request as parameter
and output the string that will be written to error log. The default contribution is:
<extension
target="org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService"
point="requestdump">
<requestdump
class="org.nuxeo.ecm.platform.web.common.exceptionhandling.service.DefaultRequestDumper" />
</extension>
It writes the attributes of the request.
6.2.2. listener
The listener extension point allows to contribute a listener that will be called during the different phase of the
exception handling. The default contribution does nothing (this is use by WebEngine):
<extension
point="listener">
<listener
class="org.nuxeo.ecm.platform.web.common.exceptionhandling.service.NullExceptionHandlingListener" />
</extension>
This contribution is over written in the module nuxeo-platform-webapp-core with:
<extension
point="listener">
<listener
class="org.nuxeo.ecm.webapp.shield.SeamExceptionHandlingListener" />
</extension>
This listener restore the faces/seam context before to write the attributes (use by NuxeoEP).
6.2.3. errorhandlers
The errorhandlers extension point allows to configure the different handler. General attribute are:
errorhandlers attributes
Nuxeo EP 5.3 66
Exception Handling
bundle
The message bundle to use. The default bundle used in Nuxeo is messages.
loggerName
The name of the logger to use. Default is nuxeo-error-log. If you change this value, you need to update
your logging configuration.
defaultpage
The page to which you will be forwarded if no page is defined in the handler configuration.
The attributes for each handler are:

error
A regular expression, if matched the Exception we are handling, this handler will be used. The last handler
should use ".*" as a Regular Expression.
message
The key, in the message bundle defined in the general attribute, of the message that will be output to the
user.
page
The error page we should forward to. If not defined we will forward to the default error page as defined in
the general attribute.
code
The status code set to the response. If none the default code will be set.
The default configuration is:
<extension
point="errorhandlers">
<errorHandlers bundle="messages" loggerName="nuxeo-error-log" defaultpage="nuxeo_error.jsp">
<handlers>
<handler error=".*NoSuchDocumentException" message="Error.Document.Not.Found" code="404"/>
<handler error="javax.jcr.ItemNotFoundException" message="Error.Document.NotFound" code="404"/>
<handler error=".*NoSuchPropertyException" message="Error.Document.NoSuchProperty"/>
<handler error=".*SecurityException" message="Error.Insuffisant.Rights"/>
<handler error=".*" message="Error.Unknown"/>
</handlers>
</errorHandlers>
</extension>
Nuxeo EP 5.3 67
Chapter 7. Actions, Views, Navigation URLs and JSF
tags
7.1. Introduction
The User Interface framework uses different kinds of concepts to make the interface configurable in the same
way that the application itself is.
Links and pages that appear on the site can be the result of a "static" template written in the XHTML language,
but can also be the result of a configuration change, taken into account thanks to more "generic" XHTML
pages.
The following chapters will explain how configuration and templating combine to achieve the UI of the site.
7.2. Actions
7.2.1. Concepts
In this chapter, an action will stand for any kind of command that can be triggered via user interface interaction.
In other words, it will describe a link and other information that may be used to manage its display (the link
label, an icon, security information for instance).
7.2.2. Manage actions

Custom actions can be contributed to the actions service, using its extension point. Their description is then
available through this service to control where and how they will be displayed.
7.2.2.1. Register a new action
An action can be registered using the following example extension:
Example 7.1. Example of an action registration
<extension target="org.nuxeo.ecm.platform.actions.ActionService"
point="actions">
<action id="logout" link="#{loginLogoutAction.logout}"
label="command.logout">
<category>USER_SERVICES</category>
</action>
</extension>
The above action will be used to display a "logout" link on the site. Here are its properties:
• id: string identifying the action. In the example, the action id is "logout".
• label: the action name that will be used when displaying the link. In the example, the label is
"command.logout". This label is a message that will be translated at display.
• link: string representing the command the action will trigger. This string may represent a different
action given the template that will display the action. In the example, a JSF command link will be used,
so it represents an action method expression. The seam component called "loginLogoutAction" holds a
method named "logout" that will perform the logout and return a string for navigation.
• category: a string useful to group actions that will be rendered in the same area of a page. An action can
Nuxeo EP 5.3 68
Actions, Views, Navigation URLs and JSF tags
define several categories. Here, the only category defined is "USER_SERVICES". It is designed to group
all the actions that will be displayed on the right top corner of any page of the site.
Other properties can be used to define an action. They are listed here but you can have a look at the main
actions contributions file for more examples:
nuxeo-platform-webapp-core/srs/main/resources/OSGI-INF/actions-contrib.xml.
• filter-ids: id of a filter that will be used to control the action visibility. An action can have several
filters: it is visible if all its filters grant the access.
• filter: a filter definition can be done directly within the action definition. It is a filter like others and
can be referred by other actions.
• icon: the optional icon path for this action.
• confirm: an optional Javascript confirmation string that can be triggered when executing the command.
• order: an optional integer used to sort actions within the same category. This attribute may be
deprecated in the future.
• enabled: boolean indicating whether the action is currently active. This can be used to hide existing
actions when customizing the site behavior.
Actions extension point provides merging features: you can change an existing action definition in your custom
extension point provided you use the same identifier. Properties holding single values (label, link for instance)
will be replaced using the new value. Properties holding multiple values (categories, filters) will be merged
with existing values.
7.2.2.2. Manage category to display an action at the right place
Actions in the same category are supposed to be displayed in the same area of a page. Here are listed the main
default categories if you want to add an action there:
• USER_SERVICES: used to display actions in the top right corner of every page. The link attribute should
look like a JSF action command link. See the example above.
• VIEW_ACTION_LIST: used for tabs displayed on every document. As each tab is not displayed in a
different page, but just includes a specific template content in the middle of the page, the link attribute
has to be a template path. For instance:
<action id="TAB_VIEW" link="/incl/tabs/document_view.xhtml" enabled="true"
order="0" label="action.view.summary">
<filter-id>view</filter-id>
</action>
<action id="TAB_CONTENT" link="/incl/tabs/document_content.xhtml" order="10"
enabled="true" label="action.view.content">
<filter-id>view_content</filter-id>
</action>
• SUBVIEW_UPPER_LIST: used to display actions just below a document tabs listing. As USER_SERVICES,
these actions will be displayed using a command link, so the link attribute has to be an action method
expression. For instance:
<action id="newSection" link="#{documentActions.createDocument('Section')}"
enabled="true" label="command.create.section"
icon="/icons/action_add.gif">
<category>SUBVIEW_UPPER_LIST</category>
<filter id="newSection">
<rule grant="true">
<permission>AddChildren</permission>
<type>SectionRoot</type>
</rule>
</filter>
</action>
<action id="newDocument" link="select_document_type" enabled="true"
label="action.new.document" icon="/icons/action_add.gif">
Nuxeo EP 5.3 69
<filter-id>create</filter-id>
</action>
7.2.2.3. Manage filters to control an action visibility
An action visibility can be controlled using filters. An action filter is a set of rules that will apply - or not -
given an action and a context.
Filters can be registered using their own extension point, or registered implicitly when defining them inside of
an action definition:
Example 7.2. Example of a filter registration
<filter id="view_content">
<rule grant="true">
<permission>ReadChildren</permission>
<facet>Folderish</facet>
</rule>
<rule grant="false">
<type>Root</type>
</rule>
</filter>
Example 7.3. Example of a filter registration inside an action registration
<action id="newSection" link="#{documentActions.createDocument('Section')}"

enabled="true" label="command.create.section"
icon="/icons/action_add.gif">
<filter id="newSection">
<rule grant="true">
<permission>AddChildren</permission>
<type>SectionRoot</type>
</rule>
</filter>
</action>
A filter can accept any number of rules. It will grant access to an action if, among its rules, no denying rule
(grant=false) is found and at least one granting rule (grant=true) is found. A general rule to remember is
that if you would like to add a filter to an action that already has one or more filters, it has to hold constraining
rules: a granting filter will be ignored if another filter is already too constraining.
If no rule is set, the filter will grant access by default.
The default filter implementation uses filter rules with the following properties:
• grant: boolean indicating whether this is a granting rule or a denying rule.
• permission: permission like "Write" that will be checked on the context for the given user. A rule can
hold several permissions: it applies if user holds at least one of them.
• facet: facet like "Folderish" that can be set on the document type
(org.nuxeo.ecm.core.schema.types.Type) to describe the document type general behavior. A rule can
hold several facets: it applies if current document in context has at least one of them.
• condition: EL expression that can be evaluated against the context. The Seam context is made available
for conditions evaluation. A rule can hold several conditions: it applies if at least one of the conditions is
verified.
• type: document type to check against current document in context. A rule can hold several types: it
Nuxeo EP 5.3 70
applies if current document is one of them. The fake 'Server' type is used to check the server context.
• schema: document schema to check against current document in context. A rule can hold several
schemas: it applies if current document has one of them.
• group: group like "members" to check against current user in context. A rule can hold several groups: it
applies if current user is in one of them.
Filters do not support merging, so if you define a filter with an id that is already used in another contribution,
only the first contribution will be taken into account.
7.2.2.4. Adapt templates to display an action
It is important to understand that an action does *not* define the way it will be rendered: This is left to pages,
templates and other components displaying it. Most of the time, actions will be rendered as command links or
command buttons.
For instance, actions using the USER_SERVICES category will be rendered as action links:
<nxu:methodResult name="actions"
value="#{webActions.getActionsList('USER_SERVICES')}">
<nxu:dataList layout="simple" var="action" value="#{actions}"
rowIndexVar="row" rowCountVar="rowCount">
<h:outputText value=" | " rendered="#{row!=(rowCount-1)}" />
<nxh:commandLink action="#{action.getLink()}">
<t:htmlTag value="br" rendered="#{row==(rowCount-1)}" />
<h:outputText value="#{messages[action.label]}" />
</nxh:commandLink>
</nxu:dataList>
</nxu:methodResult>
The nxu:methodResult tag is only used to retrieve the list of actions declared for the USER_SERVICES category.
The nxh:commandLink is used instead of a simple h:commandLink so that it executes commands that where
described as action expression methods.
Another use case is the document tabs: actions using the VIEW_ACTION_LIST category will be rendered as action
links too, but actions are managed by a specific seam component that will hold the information about the
selected tab. When clicking on an action, this selected tab will be changed and the link it points to will be
displayed.
7.3. Views
7.3.1. UI Views
First of all, we have to make the difference between a view in a standard JSF way (navigation case view id,
navigation case output) and views in Nuxeo 5 (document type view, creation view)
7.3.2. Manage views
7.3.2.1. Standard JSF navigation concepts
A standard JSF navigation rule can be defined in the OSGI-INF/deployment-fragment.xml files, inside the
faces-config#NAVIGATION directive.
Example 7.4. Example of a navigation rule case definitions
<extension target="faces-config#NAVIGATION">
<navigation-case>
<from-outcome>create_document</from-outcome>
<to-view-id>/create_document.xhtml</to-view-id>
Nuxeo EP 5.3 71
<redirect />
</navigation-case>
<navigation-case>
<from-outcome>view_documents</from-outcome>
<to-view-id>/view_documents.xhtml</to-view-id>
<redirect />
</navigation-case>
</extension>
7.3.2.2. Nuxeo 5 views
A certain Nuxeo document type, can have defined a default view (used to view/edit the document) and a create
view (used to create the document). These views are specified in the OSGI-INF/ecm-types-contrib.xml file,
as in the following example.
Example 7.5. Example of view definitions for a document type

<label>Workspace</label>
<icon>/icons/workspace.gif</icon>
<icon-expanded>/icons/workspace_open.gif</icon-expanded>
<create-view>create_workspace</create-view>
</type>
</extension>
The default view of a document is rendered as a list of tabs. As mentioned before, the document tabs are
defined as actions in the OSGI-INF/actions-contrib file, having as category VIEW_ACTION_LIST. A tab can be
added to a document default view as shown in the following example.
Example 7.6. Example of tab definition for a default view of a document type
<extension target="org.nuxeo.ecm.platform.actions.ActionService" point="actions">

<action id="TAB_EDIT" link="/incl/tabs/document_edit.xhtml" enabled="true"
order="20" label="action.view.edit" icon="/icons/file.gif">
<filter-id>edit</filter-id>
<filter-id>mutable_document</filter-id>
</action>
</extension>
7.4. Navigation URLs

There are two services that help building GET URLs to restore a Nuxeo context. The default configuration
handle restoring the current document, the view, current tab and current sub tab.
7.4.1. Document view codec service

The service handling document views allows registration of codecs. Codecs manage coding of a document view
(holding a document reference, repository name as well as key-named string parameters) in to a URL, and
decoding of this URL into a document view.
Example 7.7. Example of a document view codec registration
<extension
Nuxeo EP 5.3 72
target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService"
point="codecs">
<documentViewCodec name="docid" enabled="true" default="true" prefix="nxdoc"
class="org.nuxeo.ecm.platform.url.codec.DocumentIdCodec" />
<documentViewCodec name="docpath" enabled="true" default="false" prefix="nxpath"
class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" />
</extension>
In this example, the docid codec uses the document uid to resolve the context. Urls are of the form
http://site/nuxeo/nxdoc/demo/docuid/view. The docpath codec uses the document path to resolve the context.
Urls are of the form http://site/nuxeo/nxpath/demo/path/to/my/doc@view.
Additional parameters are coded/decoded as usual request parameters.
Note that when building a document view, the url service will require a view id. The other information
(document location and parameters) are optional, as long as they're not required for your context to be
initialized correctly.
7.4.2. URL policy service

The service handling URLs allows registration of patterns. These patterns help saving the document context
and restoring it thanks to information provided by codecs. The URL service will iterate through its patterns, and
use the first one that returns an answer (proving decoding was possible).
Example 7.8. Example of a url pattern registration
<extension target="org.nuxeo.ecm.platform.ui.web.rest.URLService"
point="urlpatterns">
<urlPattern name="default" enabled="true">
<defaultURLPolicy>true</defaultURLPolicy>
<needBaseURL>true</needBaseURL>
<needRedirectFilter>true</needRedirectFilter>
<needFilterPreprocessing>true</needFilterPreprocessing>
<codecName>docid</codecName>
<actionBinding>#{restHelper.initContextFromRestRequest}</actionBinding>
<documentViewBinding>#{restHelper.documentView}</documentViewBinding>
<newDocumentViewBinding>#{restHelper.newDocumentView}</newDocumentViewBinding>
<bindings>
<binding name="tabId">#{webActions.currentTabId}</binding>
<binding name="subTabId">#{webActions.currentSubTabId}</binding>
</bindings>
</urlPattern>
</extension>
In this example, the "default" pattern uses the above "docid" codec. Its is set as the default URL policy, so that
it's used by default when caller does not specify a pattern to use. It needs the base URL: the docid codec only
handles the second part if the URL. It needs redirect filter: it will be used to provide the context information to
store. It needs filter preprocessing: it will be used to provide the context information to restore. It's using the
docid codec.
The action binding method handles restoring of the context in the Seam context. It takes a document view as
parameter. It requires special attention: if you're using conversations (as Nuxeo does by default), you need to
annotate this method with a "@Begin" tag so that it uses the conversation identifier passed as a parameter if it's
still valid, or initiates a new conversation in other cases. The method also needs to make sure it initializes all
the seam components it needs (documentManager for instance) if they have not be in intialized yet.
The additional document view bindings are used to pass document view information through requests. The
document view binding maps to corresponding getters and setters. The new document view binding is used to
redirect to build GET URL in case request is a POST: it won't have the information in the URL so it needs to
rebuild it.
Nuxeo EP 5.3 73
Other bindings handle additional request parameters. In this example, they're used to store and restore tab and
sub tab information (getters and setters have to be defined accordingly).
7.4.3. Additional configuration

The URL patterns used need to be registered on the authentication service so that they're considered as valid
urls. Valid urls will be stored in the request, so that if authentication is required, user is redirected to the url
after login.
Example 7.9. Example of a start url pattern registration
<extension
target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService"
point="startURL">
<startURLPattern>
<patterns>
<pattern>nxdoc/</pattern>
</patterns>
</startURLPattern>
</extension>
Just the start of the url is required in this configuration. Contributions are merged: it is not possible to remove
an existing start pattern.
The URL patterns used also need to be handled by the default nuxeo authentication service so that login
mechanism (even for anonymous) applies for them.
Example 7.10. Example authentication filter configuration
<extension target="web#STD-AUTH-FILTER">
<filter-mapping>
<filter-name>NuxeoAuthenticationFilter</filter-name>
<url-pattern>/nxdoc/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
</extension>
This is a standard filter mapping configuration.
7.4.4. URL JSF tags

There are some JSF tags and functions helping you to define what kind of GET URL should be displayed on
the interface.
Example 7.11. Example of nxd:restDocumentLink use
<nxd:restDocumentLink document="#{doc}">
<nxh:outputText value="#{nxd:titleOrId(doc)}" />
</nxd:restDocumentLink>
In this example, the tag will print a simple link, using the default pattern, and build the document view using
given document model, using its default view.
Please refer to the tag library documentation available at

http://doc.nuxeo.org/5.1/tlddoc/nxd/restDocumentLink.html for additional parameters: it's possible to set the
Nuxeo EP 5.3 74
tab, sub tab, and use a specific URL pattern.
Note that you can also use JSF functions to build the GET URL. This is what's done for file links: the function
queries the URL policy service to build the URL.
Example 7.12. Example of a jsf function use
<nxh:outputLink rendered="#{doc.hasSchema('file') and !empty doc.file.content}"

value="#{nxd:fileUrl('downloadFile', doc, 'file:content', doc.file.filename)}">
<nxh:graphicImage value="/icons/download.png" style="vertical-align:middle"
title="#{doc.file.filename}" />
</nxh:outputLink>
Example 7.13. fileUrl method code
public static String fileUrl(String patternName, DocumentModel doc,

String blobPropertyName, String filename) {
try {
DocumentLocation docLoc = new DocumentLocationImpl(doc);
Map<String, String> params = new HashMap<String, String>();
params.put(DocumentFileCodec.FILE_PROPERTY_PATH_KEY,
blobPropertyName);
params.put(DocumentFileCodec.FILENAME_KEY, filename);
DocumentView docView = new DocumentViewImpl(docLoc, null, params);
// generate url
URLPolicyService service = Framework.getService(URLPolicyService.class);
if (patternName == null) {
patternName = service.getDefaultPatternName();
}
return service.getUrlFromDocumentView(patternName, docView,
BaseURL.getBaseURL());
} catch (Exception e) {
log.error("Could not generate url for document file", e);
}
return null;
}
Similar methods exist for more complex urls, when handling files in list for instance. Please refer to the list at
http://doc.nuxeo.org/5.1/tlddoc/nxd/tld-summary.html.
7.5. Nuxeo Document Lists Manager

The Document List Manager provides a service to manage lists of Nuxeo documents.
These lists of documents can have properties such as:

• a name, defined by name attribute.
• a scope (session or conversation), defined by <isSession/> tag - it defines if the memory storage occurs
in the Seam session context or in the Seam conversation context.
• a persistence (SQL directory or not present), defined by <persistent/> tag - the service persists only the
list of the document references, not the real documents; the lists of document references is persisted in a
SQL directory, which is generic and does not need any configuration.
The lists of documents can be invalidated when Seam events are raised. This is usefull, for example, for
resetting CURRENT_SELECTION lists when the user change the current folder or when a new search is performed.
Documents lists can be defined like in the following example (OSGI-INF/documentslists-contrib.xml):
Nuxeo EP 5.3 75
Example 7.14. Example of documents lists definition
<extension target="org.nuxeo.ecm.webapp.documentsLists.DocumentsListsService" point="list">

<documentsList name="CLIPBOARD">
<category>CLIPBOARD</category>
<imageURL>/img/clipboard.gif</imageURL>
<title>workingList.clipboard</title>
<defaultInCategory>false</defaultInCategory>
<supportAppends>false</supportAppends>
</documentsList>
<documentsList name="CURRENT_SELECTION">
<events>
<event>folderishDocumentSelectionChanged</event>
<event>searchPerformed</event>
</events>
<isSession>false</isSession>
</documentsList>
</extension>
7.6. Nuxeo File Manager

The File Manager provides a service which exposes a simple API in order to create a Nuxeo document model
from a passed blob file. Also, this service exposes as extension point which can be used to define plugins.
When the File Manager service is called, it will detect the mime-type of the passed blob, and will try to find a
plugin to hadle the creation of a Nuxeo document model based on the detected mime-type.
Typical usages:
• txt/html/xml files - a Note document is created.
• image files - a Picture document is created (if nuxeo-platform-imaging addon is deployed).
• folder - a Folder document is created.
• other files - a File document is created.
Pugins can be defined like in the following example (OSGI-INF/nxfilemanager-plugins-contrib.xml):
Example 7.15. Example of File Manager plugins definition
<extension target="org.nuxeo.ecm.platform.filemanager.service.FileManagerService" point="plugins">

<plugin name="Noteplugin"
class="org.nuxeo.ecm.platform.filemanager.service.extension.NotePlugin">
<filter>text/plain</filter>
<filter>text/html</filter>
<filter>application/xhtml+xml</filter>
<filter>application/xml</filter>
<filter>text/xml</filter>
</plugin>
</extension>
As a client of the File Manager service can be used the browser plugins (for Firefox and Internet Explorer)
which can be be downloaded through the links from the default Nuxeo 5 login page. These plugins enable the
user to create Nuxeo documents just by dragging & dropping folders/files to the browser. The plugins use a
restlet (HTTP API) to send files/folders to the Nuxeo 5 Platform. The restlets use the File Manager serivce in
order to create a Nuxeo document from the passed file.
7.7. Nuxeo JSF tags
Nuxeo EP 5.3 76
Please refer to the tag library documentation available at http://doc.nuxeo.org/5.1/tlddoc/.
Nuxeo EP 5.3 77
Chapter 8. Layouts
Let our artists go wild on imaginative page layouts.
-- Grant Morrison
8.1. Introduction
Layouts are used to generate pages rendering from an xml configuration.
In a document oriented perspective, layouts are mostly used to display a document metadata in different use
cases: present a form to set its schemas fields when creating or editing the document, and present these fields
values when simply displaying the document. A single layout definition can be used to address these use cases
as it will be rendered for a given document and in a given mode.
In this chapter we will see how to define a layout, link it to a document type, and use it in XHTML pages.
8.1.1. Layouts
A layout is a group of widgets that specifies how widgets are assembled and displayed. It manages widget rows
and has global control on the rendering of each of its widgets.
8.1.2. Widgets
It's all the same machine, right? The Pentagon, multinational corporations, the police! You do one little job, you
build a widget in Saskatoon and the next thing you know it's two miles under the desert, the essential
component of a death machine!
-- Holloway, Cube
A widget defines how one or several fields from a schema will be presented on a page. It can be displayed in
several modes and holds additional information like for instance the field label. When it takes user entries, it
can perform conversion and validation like usual JSF components.
8.1.3. Widget types

A widget definition includes the mention of its type. Widget types make the association between a widget
definition and the jsf component tree that will be used to render it in a given mode.
8.1.4. Modes
The layout modes can be anything although some default modes are included in the application: create, edit,
view, listing and search.
The widget modes are more restricted and widget types will usually only handle two modes: edit and view. The
widget mode is computed from the layout mode following this rule: if the layout is in mode create, edit or
search, the widget will be in edit mode. Otherwise the widget will be in view mode.
It is possible to override this behavior in the widget definition, and state that, for instance, whatever the layout
mode, the widget will be in view mode so that it only displays read-only values. The pseudo-mode "hidden"
can also be used in a widget definition to exclude this widget from the layout in a given mode.
The pseudo mode "any" is only used in layouts and widgets definitions to set up default values.
8.2. Manage layouts
Nuxeo EP 5.3 78
Layouts
Custom layouts can be contributed to the web layout service, using its extension point. The layout definition is
then available through the service to control how it will be displayed in a given mode.
Some jsf tags have been added to the Nuxeo ECM layout tag library to make then easily available from an
xhtml page.
8.2.1. Layout registration

Layouts are registered using a regular extension point on the Nuxeo ECM layout service. Here is a sample
contribution.
Example 8.1. Sample layout contribution to the layout service.
<component name="org.nuxeo.ecm.platform.forms.layouts.webapp">
point="layouts">
<layout name="heading">
<templates>
</templates>
<rows>
<row>
<widget>title</widget>
</row>
<row>
<widget>description</widget>
</row>
</rows>
<widget name="title" type="text">
<labels>
<label mode="any">label.dublincore.title</label>
</labels>
<translated>true</translated>
<fields>
<field>dc:title</field>
</fields>
<properties widgetMode="edit">
<property name="required">true</property>
</properties>
</widget>
<widget name="description" type="textarea">
<labels>
<label mode="any">label.dublincore.description</label>
</labels>
<fields>
<field>dc:description</field>
</fields>
</widget>
</layout>
</extension>
</component>
8.2.2. Layout definition

The above layout definition is used to display the title and the description of a document. Here are its
properties:
• name: string used as an identifier. In the example, the layout name is "heading".
• templates: list of templates to use for this layout global rendering. In the example, the layout template in
any mode is the xhtml file at "/layouts/layout_default_template.xhtml". Please refer to section about
custom layout templates for more information.
Nuxeo EP 5.3 79
Layouts
• rows: definition about what widgets will have to be displayed on this row. Each row can hold several
widgets, and an empty widget tag can be used to control the alignment. The widget has to match a widget
name given in this layout definition. In the example, two rows have been defined, the first one will hold
the "title" widget, and the second one will hold the "description" widget.
• widget: a layout definition can hold any number of widget definitions. If the widget is not referenced in
the rows definition, it will be ignored. Since 5.1.7 and 5.2.0, it will be searched in the global widget
registry before being ignored. This new feature is a convenient way to share widget definitions between
layouts. Please refer the widget definition section.
8.2.3. Widget definition

Two widget definitions are presented on the above example. Let's look into the "title" widget and present its
properties:
• name: string used as an identifier in the layout context. In the example, the widget name is "title".
• type: the widget type that will manage the rendering of this widget. In this example, the widget type is
"text". This widget type is a standard widget types, more information about widget types is available
here.
• labels: list of labels to use for this widget in a given mode. If no label is defined in a specific mode, the
label defined in the "any" mode will be taken as default. In the example, a single label is defined for any
mode to the "label.dublicore.title" message. If no label is defined at all, a default label will be used
following the convention: "label.widget.[layoutName].[widgetName]".
• translated: string representing a boolean value ("true" or "false") and defaulting to "false". When set as
translated, the widget labels will be treated as messages and displayed translated. In the example, the
"label.dublincore.title" message will be translated at rendering time. Default is true.
• fields: list of fields that will be managed by this widget. In the example, we handle the field "dc:title"
where "dc" is the prefix for the "dublincore" schema. If the schema you would like to use does not have a
prefix, use the schema name instead. Note that most of standard widget types only handle one field. Side
note: when dealing with an attribute from the document that is not a metadata, you can use the property
name as it will be resolved like a value expression of the form #{document.attribute}.
• properties: list of properties that will apply to the widget in a given mode. Properties listed in the "any"
mode will be merged with properties for the specific mode. Depending on the widget type, these
properties can be used to control what jsf component will be used and/or what attributes will be set on
these components. In standard widget types, only one component is used given the mode, and properties
will be set as attributes on the component. For instance, when using the "text" widget type, every
property accepted by the "<h:inputText />" tag can be set as properties on "edit" and "create" modes, and
every property accepted by the "<h:outputText />" tag can be set as properties. Properties can also be
added in a given widget mode.
Additional properties can be set on a widget:

• helpLabels: list that follows the same pattern as labels, but used to set help labels.
• widgetModes: list of local modes used to override the local mode (from the layout).
• subWidgets: list of widget definitions, as the widget list, used to describe sub widgets use to help the
configuration of some complex widget types.
Here is a more complex layout contribution that shows the syntax to use for these additional properties:
Example 8.2. Sample complex layout contribution to the layout service.
Nuxeo EP 5.3 80
Layouts
<component name="org.nuxeo.ecm.platform.forms.layouts.webapp">

point="widgets">

<widget name="description" type="textarea">
<labels>
<label mode="any">description</label>
</labels>
<fields>
<field>dc:description</field>
</fields>
<property name="styleClass">dataInputText</property>
</properties>
</widget>
</extension>
point="layouts">
<layout name="complex">
<templates>
</templates>
<rows>
<row>
<widget>identifier</widget>
</row>
<row>

<widget>description</widget>
</row>
</rows>
<widget name="identifier" type="text">
<labels>
<label mode="any">label.dublincore.title</label>
</labels>
<fields>
<field>uid:uid</field>
</fields>
<widgetModes>

<mode value="create">hidden</mode>
</widgetModes>

</properties>
<properties mode="view">

<property name="styleClass">cssClass</property>
</properties>
</widget>
</layout>
</extension>
</component>
8.2.4. Listing layout definition

Layouts can also be used to render table rows, as long as their mode (or their widgets mode) do not depend on
the iteration variable, as the layout is built when building the JSF tree (too early in the JSF construction
mechanism for most iteration variables).
For this usage, columns/column aliases have been defined because they are more intuitive when describing a
row in the layout. The layout layout_listing_template.xhtml makes it possible to define new properties to take
care of when rendering the table header or columns.
Nuxeo EP 5.3 81
Layouts
Example 8.3. Sample complex layout contribution to the layout service.
<component name="org.nuxeo.ecm.platform.forms.layouts.webapp.listing">
point="widgets">
<widget name="listing_selection_box_with_current_document"
type="listing_selection_box_with_current_document">
<labels>
<label mode="any"></label>
</labels>
<fields>
<field>selected</field>
<field>data.ref</field>
</fields>
</widget>
<widget name="listing_icon_type" type="listing_icon_type">
<labels>
</labels>
<fields>
<field>data</field>
<field>data.type</field>
<field>data.folder</field>
</fields>
</widget>
<widget name="listing_title_link" type="listing_title_link">
<labels>
<label mode="any">label.content.header.title</label>
</labels>
<fields>
<field>data</field>
<field>data.dc.description</field>
<field>data.file.content</field>
<field>data.file.filename</field>
</fields>
<properties mode="any">
<property name="file_property_name">file:content</property>
<property name="file_schema">file</property>
</properties>
</widget>
<widget name="listing_modification_date" type="datetime">
<labels>
<label mode="any">label.content.header.modified</label>
</labels>
<fields>
<field>data.dc.modified</field>
</fields>
<properties widgetMode="any">
<property name="pattern">#{nxu:basicDateAndTimeFormater()}</property>
</properties>
</widget>
</extension>
point="layouts">
<layout name="document_listing_sample">
<templates>
<template mode="any">/layouts/layout_listing_template.xhtml</template>
</templates>
<property name="showListingHeader">true</property>
<property name="showRowEvenOddClass">true</property>
</properties>
<columns>
<column>
<property name="isListingSelectionBoxWithCurrentDocument">
true
</property>
<property name="useFirstWidgetLabelAsColumnHeader">false</property>
<property name="columnStyleClass">iconColumn</property>
</properties>
<widget>listing_selection_box_with_current_document</widget>
</column>
<column>
<property name="useFirstWidgetLabelAsColumnHeader">false</property>
Nuxeo EP 5.3 82
Layouts
<property name="columnStyleClass">iconColumn</property>
</properties>
<widget>listing_icon_type</widget>
</column>
<column>
<property name="useFirstWidgetLabelAsColumnHeader">true</property>
<property name="sortPropertyName">dc:title</property>
</properties>
<widget>listing_title_link</widget>
</column>
<column>
<property name="useFirstWidgetLabelAsColumnHeader">true</property>
<property name="sortPropertyName">dc:modified</property>
</properties>
<widget>listing_modification_date</widget>
</column>
</columns>
</layout>
</extension>
</component>
Here widgets have been defined globally, as well as their types. New widget types, or simply widget templates,
can be made taking example on the existing ones, see
http://hg.nuxeo.org/nuxeo/nuxeo-jsf/file/5.3/nuxeo-platform-webapp-base/src/main/resources/OSGI-INF/layouts-listing-con
More information about how to write a listing layout template can be read below.
8.2.5. EL expressions in layouts and widgets

Some variables are made available to the EL context when using layout or widget templates.
• Inside the layout context, the following global variables are available: value (and equivalent
document) + levels and changing "value" context
• layoutValue: represents the value (evaluated) passed in a "nxl:layout" or "nxl:documentLayout" tag

attributes.
• layoutMode: represents the mode (evaluated) passed in a "nxl:layout" or "nxl:documentLayout" tag

attributes.
• value: represents the current value as manipulated by the tag: in a "nxl:layout" tag, it will represent the
value resolved from the "value" tag attribute ; in a "nxl:widget" tag, it will represent the value resolved
from the "value" tag attribute. This value will work with field information passed in the widget
definition to resolve fields and subfields. The variable "document" is available as an alias, although it
does not always represent a document model (as layouts can aplly to any kind of object).
• value_n: represents the current value as manipulated by the tag, as above, excepts it includes the
widget level (value_0, value_1, etc...). This is useful when needing to use the value as defined in a
parent widget, for instance.
• Inside a layout template, the variable "layout" is available, it make its possible to
access the generated layout object.
• Inside a "nxl:layoutRow", or equivalent "nxl:layoutColumn" tag, the variables

"layoutRow" and "layoutRowIndex" are available to access the generated layout row, and
its index within the iteration over rows. The equivalent "layoutColumn" and
"layoutColumnIndex" variables are also available.
• Inside a "nxl:layoutRowWidget", or equivalent "nxl:layoutColumn" widget, the variables "widget" and

"widgetIndex" are available to access the generated current widget, and its index in the row or column.
The variables added the level information are also available: widget_0, widget_1, ... and widgetIndex_0,
widgetIndex_1... This is useful when needed to use the widget as defined in a higher level.
Nuxeo EP 5.3 83
Layouts
• Inside a widget template, some "field_n" variables are available: "field_0" represents the resolved first
field value, "field_1" the second value, etc... Since 5.3.1, the variable "field" is available as an alias to
"field_0". Since 5.3.2, the widget properties are also exposed for easier resolution of EL expressions: for
instance, the variable "widgetProperty_onchange" represents the resolved property with name
"onchange".
The complete reference is available at http://doc.nuxeo.org/current/tlddoc/nxl/tld-summary.html.
8.3. Document layouts

Layouts can be linked to a document type definition by specifying the layout names:
<layout>note</layout>
</layouts>
Layouts are defined in a given mode; layouts in the "any" mode will be used as default when no layouts are
given in specific modes.
Since 5.2.GA, it is possible to merge layouts when redefining the document type, adding a property
append="true":
<layouts mode="any" append="true">
<layout>newLayout</layout>
</layouts>
Since 5.3.1, a new mode "listing" can used for folderish documents. Their default content will use the given
layouts to make it possible to switch between the different presentations.
Some default listing layouts have been defined, the one used by default when no layout is given in this mode is
"document_listing". To remove the layouts defined by default on a document type, override it without listing
any modes.
<layouts mode="listing">
</layouts>
<layouts mode="listing">
<layout>document_listing</layout>
<layout>document_listing_compact_2_columns</layout>
<layout>document_icon_2_columns</layout>
</layouts>
Layouts with a name that ends with "2_columns" will be displayed on two columns by default. The layout
name will be used as a message key for the selector label.
8.4. Layout display

Layouts can be displayed thanks to a series a JSF tags that will query the web layout service to get the layout
definition and build it for a given mode.
For instance, we can use the documentLayout tag to display the layouts of a document:
<div xmlns="http://www.w3.org/1999/xhtml"
xmlns:nxl="http://nuxeo.org/nxforms/layout">
<nxl:documentLayout mode="view" value="#{currentDocument}" />
</div>
We can also display a specific layout for a document, even if it is not specified in the document type definition:
Nuxeo EP 5.3 84
Layouts
<div xmlns="http://www.w3.org/1999/xhtml"
xmlns:nxl="http://nuxeo.org/nxforms/layout">
<nxl:layout name="heading" mode="view" value="#{currentDocument}" />
</div>
Warning
You can include a layout in a dataTable tag, but cannot make its mode depend on the iteration
variable. If you need to do so, recommendation is to use nxu:repeat tag and handle all the <table>
works by yourself.
Please refer to the tag library documentation available at

http://doc.nuxeo.org/current/tlddoc/nxl/tld-summary.html.
8.5. Standard widget types

A series of widget types has been defined for the most generic uses cases.
Please refer to the tag library documentation available at http://doc.nuxeo.org/5.1/tlddoc/ for nuxeo jsf tags.
8.5.1. text
The text widget displays an input text in create or edit mode, with additional message tag for errors, and a
regular text output in any other mode. Widgets using this type can provide properties accepted on a
<h:inputText /> tag in create or edit mode, and properties accepted on a <h:outputText /> tag in other
modes.
8.5.2. int
The int widget displays an input text in create or edit mode, with additional message tag for errors, and a
regular text output in any other mode. It uses a number converter. Widgets using this type can provide
properties accepted on a <h:inputText /> tag in create or edit mode, and properties accepted on a
<h:outputText /> tag in other modes.
8.5.3. secret
The secret widget displays an input secret text in create or edit mode, with additional message tag for errors,
and nothing in any other mode. Widgets using this type can provide properties accepted on a <h:inputSecret
/> tag in create or edit mode.
8.5.4. textarea
The textarea widget displays a textarea in create or edit mode, with additional message tag for errors, and a
regular text output in any other mode. Widgets using this type can provide properties accepted on a
<h:inputTextarea /> tag in create or edit mode, and properties accepted on a <h:outputText /> tag in other
modes.
8.5.5. datetime
The datetime widget displays a javascript calendar in create or edit mode, with additional message tag for
errors, and a regular text output in any other mode. It uses a date time converter. Widgets using this type can
provide properties accepted on a <nxu:inputDatetime /> tag in create or edit mode, and properties accepted
on a <h:outputText /> tag in other modes. The converter will also be given these properties.
Nuxeo EP 5.3 85
Layouts
8.5.6. template
The template widget displays a template content whatever the mode. Widgets using this type must provide the
path to this template; this template can check the mode to adapt the rendering.
Information about how to write a template is given in the custom widget template section.
8.5.7. file
The file widget displays a file uploader/editor in create or edit mode, with additional message tag for errors, and
a link to the file in other modes. Widgets using this type can provide properties accepted on a <nxu:inputFile
/> tag in create or edit mode, and properties accepted on a <nxu:outputFile /> tag in other modes.
8.5.8. htmltext
The htmltext widget displays an html text editor in create or edit mode, with additional message tag for errors,
and a regular text output in other modes (without escaping the text). Widgets using this type can provide
properties accepted on a <nxu:editor /> tag in create or edit mode, and properties accepted on a
<nxu:outputText /> tag in other modes.
8.5.9. selectOneDirectory
The selectOneDirectory widget displays a selection of directory entries in create or edit mode, with additional
message tag for errors, and the directory entry label in other modes. Widgets using this type can provide
properties accepted on a <nxd:selectOneListbox /> tag in create or edit mode, and properties accepted on a
<nxd:directoryEntryOutput /> tag in other modes.
8.5.10. selectManyDirectory
The selectManyDirectory widget displays a multi selection of directory entries in create or edit mode, with
additional message tag for errors, and the directory entries labels in other modes. Widgets using this type can
provide properties accepted on a <nxd:selectManyListbox /> tag in create or edit mode, and properties
accepted on a <nxd:directoryEntryOutput /> tag in other modes.
8.5.11. list
The list widget displays an editable list of items in create or edit mode, with additional message tag for errors,
and the same list of items in other modes. Items are defined using sub widgets configuration. This actually a
template widget type whose template uses a <nxu:inputList /> tag in edit or create mode, and a table iterating
over items in other modes.
8.5.12. checkbox
The checkbox widget displays a checkbox in create, edit and any other mode, with additional message tag for
errors. Widgets using this type can provide properties accepted on a <h:selectBooleanCheckbox /> tag in
create, edit mode, and other modes.
8.6. Custom templates

Some templating feature have been made available to make it easier to control the layouts and widgets
rendering.
8.6.1. Custom layout template
Nuxeo EP 5.3 86
Layouts
A layout can define an xhtml template to be used in a given mode. Let's take a look at the default template
structure.
Example 8.4. Default layout template
<f:subview
xmlns:c="http://java.sun.com/jstl/core"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:h="http://java.sun.com/jsf/html"
xmlns:nxl="http://nuxeo.org/nxforms/layout"
xmlns:nxu="http://nuxeo.org/nxweb/util"
xmlns:nxd="http://nuxeo.org/nxweb/document"
id="#{layout.id}">
<c:if test="#{layout.mode != 'edit' and layout.mode != 'create'}">
<table class="dataInput">
<tbody>
<nxl:layoutRow>
<tr>
<nxl:layoutRowWidget>
<td class="labelColumn">
<c:choose>
<c:when test="#{widget.translated}">
<h:outputText value="#{messages[widget.label]}" />
<c:if test="#{!empty widget.helpLabel}">
<h:outputText value=" " />
<h:graphicImage value="/icons/info.gif"
title="#{messages[widget.helpLabel]}"
alt="#{messages[widget.helpLabel]}" />
</c:if>
</c:when>
<c:otherwise>
<h:outputText value="#{widget.label}" />
title="#{widget.helpLabel}"
alt="#{widget.helpLabel}" />
</c:if>
</c:otherwise>
</c:choose>
</td>
<td class="fieldColumn" colspan="#{nxu:test(layoutRow.size==1, 2*layout.columns-1, 1)}">
<nxl:widget widget="#{widget}" value="#{value}" />
</td>
</nxl:layoutRowWidget>
</tr>
</nxl:layoutRow>
</tbody>
</table>
</c:if>
<c:if test="#{layout.mode == 'edit' or layout.mode == 'create'}">
<table class="dataInput">
<tbody>
<nxl:layoutRow>
<tr>
<nxl:layoutRowWidget>
<td class="labelColumn">
<c:choose>
<c:when test="#{widget.translated}">
<h:outputText value="#{messages[widget.label]}"
styleClass="#{nxu:test(widget.required, 'required', '')}" />
title="#{messages[widget.helpLabel]}"
alt="#{messages[widget.helpLabel]}" />
</c:if>
</c:when>
<c:otherwise>
<h:outputText value="#{widget.label}"
styleClass="#{nxu:test(widget.required, 'required', '')}" />
title="#{widget.helpLabel}"
alt="#{widget.helpLabel}" />
</c:if>
</c:otherwise>
</c:choose>
</td>
Nuxeo EP 5.3 87
Layouts
<td class="fieldColumn" colspan="#{nxu:test(layoutRow.size==1, 2*layout.columns-1, 1)}">

</td>
</nxl:layoutRowWidget>
</tr>
</nxl:layoutRow>
</tbody>
</table>
</c:if>
</f:subview>
This template is intended to be unused in any mode, so the layout mode is checked to provide a different
rendering in "edit" or "create" modes and other modes.
When this template is included in the page, several variables are made available:
• layout: the computed layout value ; its mode and number of columns can be checked on it.
• value or document: the document model (or whatever item used as value).
The layout system integration using facelets features requires that iterations are performed on the layout rows
and widgets. The <nxl:layoutRow> and <nxl:layoutRowWidget /> trigger these iterations. Inside the
layoutRow tag, two more variables are made available: layoutRow and layoutRowIndex. Inside the
layoutRowWidget, two more variables are made available: widget and widgetIndex.
These variables can be used to control the layout rendering. For instance, the default template is the one
applying the "required" style on widget labels, and translating these labels if the widget must be translated. It
also makes sure widgets on the same rows are presented in the same table row.
8.6.2. Listing template

This layout intends to render columns within a table: each line will be filled thanks to a layout configuration. It
is only used in view mode. Let's take a look at the default listing template structure.
Example 8.5. Listing layout template
<f:subview
xmlns:c="http://java.sun.com/jstl/core"
xmlns:nxl="http://nuxeo.org/nxforms/layout"
xmlns:nxd="http://nuxeo.org/nxweb/document"
id="#{layout.id}">
<c:if test="false">
Layout template applying to an item instance of SelectDataModel named "documents"
Other needed parameters are:
- provider: instance of a ResultProvider to handle sort
- layoutListingStatus: iteration status, used to print table header
matching widget label.
</c:if>
<c:if test="#{showListingHeader and layout.properties.showListingHeader}">
<thead>
<tr>
<nxl:layoutColumn>
<th>
<c:choose>
<c:when test="#{layoutColumn.properties.isListingSelectionBox}">
<h:selectBooleanCheckbox id="#{layoutColumn.widgets[0].name}_header"
onclick="selectDataTablePageForDocument('#{documents.name}', '#{provider.name}', this.checked, '
title="#{messages['tooltip.content.select.all']}" />
</c:when>
<c:when test="#{layoutColumn.properties.isListingSelectionBoxWithCurrentDocument}">
<h:selectBooleanCheckbox id="#{layoutColumn.widgets[0].name}_header"
Nuxeo EP 5.3 88
Layouts
onclick="selectDataTablePage('#{documents.name}', '#{provider.name}', this.checked, '#{listName}

title="#{messages['tooltip.content.select.all']}" />
</c:when>
<c:when test="#{layoutColumn.properties.useFirstWidgetLabelAsColumnHeader}">
<c:choose>
<c:when test="#{provider.sortable and !empty layoutColumn.properties.sortPropertyName}">
<h:commandLink immediate="true" action="#{sortActions.repeatSearch}"
id="#{layoutColumn.widgets[0].name}_header_sort">
<f:param name="providerName" value="#{provider.name}" />
<f:param name="sortColumn" value="#{layoutColumn.properties.sortPropertyName}" />
<h:outputText value="#{layoutColumn.widgets[0].label}"
rendered="#{!layoutColumn.widgets[0].translated}" />
<h:outputText value="#{messages[layoutColumn.widgets[0].label]}"
rendered="#{layoutColumn.widgets[0].translated}" />
<c:if test="#{provider.sortInfo.sortColumn == layoutColumn.properties.sortPropertyName}" >
<h:graphicImage value="/icons/arrow_down.gif"
rendered="#{provider.sortInfo.sortAscending}" />
<h:graphicImage value="/icons/arrow_up.gif"
rendered="#{!provider.sortInfo.sortAscending}" />
</c:if>
</h:commandLink>
</c:when>
<c:otherwise>
<h:outputText value="#{layoutColumn.widgets[0].label}"
rendered="#{!layoutColumn.widgets[0].translated}" />
<h:outputText value="#{messages[layoutColumn.widgets[0].label]}"
rendered="#{layoutColumn.widgets[0].translated}" />
</c:otherwise>
</c:choose>
</c:when>
</c:choose>
</th>
</nxl:layoutColumn>
</tr>
</thead>
</c:if>
<c:set var="trStyleClass" value="#{nxu:test(layoutListingStatus.index%2 ==0, 'dataRowEven', 'dataRowOdd')}" />
<tr class="#{nxu:test(layout.properties.showRowEvenOddClass, trStyleClass, '')}">
<nxl:layoutColumn>
<td class="#{layoutColumn.properties.columnStyleClass}">
<nxl:layoutColumnWidget>
<c:if test="#{layoutColumn.size > 1 and layoutColumn.size > widgetIndex + 1 and widgetIndex > 0}">
<br />
</c:if>
</nxl:layoutColumnWidget>
</td>
</nxl:layoutColumn>
</tr>
</f:subview>
As you can see, this layout make it possible to use the first defined widget in a given column to print a label,
and maybe translate it. It also relies on properties defined in the layout or layout column properties to handle
selectio, column style class, sorting on the provider,...
Any custom template can be defined following this example to handle additional properties to disxplay on the
final table header and columns.
8.6.3. Custom widget template

The template widget type makes it possible to set a template to use as an include.
Let's have a look at a sample template used to present contributors to a document.
Example 8.6. Sample template for a widget
<div xmlns:f="http://java.sun.com/jsf/core"
xmlns:a4j="https://ajax4jsf.dev.java.net/ajax"
xmlns:t="http://myfaces.apache.org/tomahawk"
xmlns:nxdir="http://nuxeo.org/nxdirectory">
<t:dataList id="#{widget.id}" var="listItem" value="#{field_0}"
layout="simple" styleClass="standardList">
Nuxeo EP 5.3 89
Layouts
<h:graphicImage value="/icons/html.png" />

<h:commandLink value="#{listItem}" immediate="true"
action="#{userManagerActions.viewUser}">
<f:param name="usernameParam" value="#{listItem}" />
</h:commandLink>
<br />
</t:dataList>
</div>
This widget presents the contributors of a document with specific links on each on these user identifier
information.
Having a widget type just to perform this kind of rendering would be overkill, so using a widget with type
"template" can be useful here.
When this template is included in the page, the widget variable is made available:
Some rules must be followed when writing xhtml to be included in templates:
• Use the widget id as identifier: the widget id is computed to be unique within the page, so it should be
used instead of fixed id attributes so that another widget using the same template will not introduce
duplicated ids in the jsf component tree.
• Use the variable with name following the field_n pattern to reference field values. For instance, binding
a jsf component value attribute to #{field_0} means binding it to the first field definition.
8.6.4. Builtin templates to handle complex properties
8.6.4.1. List widget template
The standard widget type "list" is actually a widget of type "template" using a static template path:
/widgets/list_widget_template.xhtml. If this default behavior does not suit your needs, you can simply copy this
template, make your changes, and use a widget of type "template" with the new template path.
This template assumes that each element of the list will be displayed using subwidgets definitions.
For instance, to handle a list of String elements, you can use the definition:
<widget name="contributors" type="list">
<fields>
<field>dc:contributors</field>
</fields>
<subWidgets>
<widget name="contributor" type="text">
<fields>
<field></field>
</fields>
</widget>
</subWidgets>
</widget>
The empty field definition in the subwidget is used to specify that each element of the list is itself the element
to display.
With nuxeo version <= 5.3.0, to handle a list of complex properties (each entry of the list is a map with keys
'name' and 'email' for instance), you can use the definition:
<widget name="employees" type="list">
<fields>
<field>company:employees</field>
</fields>
<subWidgets>
<widget name="employee" type="template">
Nuxeo EP 5.3 90
Layouts
<labels>
</labels>
<fields>
<field></field>
</fields>
<property name="template">
/widgets/complex_widget_template.xhtml
</property>
</properties>

<subWidgets>
<widget name="name" type="text">
<fields>
<field>name</field>
</fields>
</widget>
<widget name="email" type="text">
<fields>
<field>email</field>
</fields>
</widget>
</subWidgets>
</widget>
</subWidgets>
</widget>
With nuxeo version > 5.3.0, to handle a list of complex properties (each entry of the list is a map with keys
'name' and 'email' for instance), you can use the definition:
<fields>
</fields>
<subWidgets>
<labels>
</labels>
/widgets/complex_list_item_widget_template.xhtml
</property>
</properties>
<subWidgets>
<fields>
<field>name</field>
</fields>
</widget>
<fields>
</fields>
</widget>
</subWidgets>
</widget>
</subWidgets>
</widget>
8.6.4.2. Complex widget template
A builtin template has been added to handle complex properties. It is available at

/widgets/complex_widget_template.xhtml. It assumes that each element of the complex property will be
displayed using subwidgets definitions.
To handle a complex property (the value is a map with keys 'name' and 'email' for instance, you can use the
definition:
<widget name="manager" type="template">
<fields>
<field>company:manager</field>
</fields>
/widgets/complex_widget_template.xhtml
</property>
</properties>
<subWidgets>
Nuxeo EP 5.3 91
Layouts

<fields>
<field>name</field>
</fields>
</widget>
<fields>
</fields>
</widget>
</subWidgets>
</widget>
8.6.4.3. Lists of lists
A builtin template has been added to handle sublists: the original "list" widget is equivalent to a widget of type
"template" using the file "/widgets/list_widget_template.xhtml". To handle the sublist, this template needs to be
changed. The file "list_subwidget_template.xhtml" is available for it since nuxeo version 5.2 GA.
To handle a sublist property, you can use take example on this definition:
<fields>
</fields>
<subWidgets>
<labels>
</labels>
/widgets/complex_list_item_widget_template.xhtml
</property>
</properties>
<subWidgets>
<widget name="phoneNumbers" type="template">
<fields>
<field>phoneNumbers</field>
</fields>
/widgets/list_subwidget_template.xhtml
</property>
</properties>
<subWidgets>
<widget name="phoneNumber" type="text">
<fields>
<field></field>
</fields>
</widget>
</subWidgets>
</widget>
</subWidgets>
</widget>
</subWidgets>
</widget>
8.7. Custom widget types

Custom widget types can be added to the standard list thanks to another extension point on the web layout
service.
Here is a sample widget type registration:
Example 8.7. Sample widget type contribution to the layout service.
<component name="org.nuxeo.ecm.platform.forms.layout.MyContribution">
Nuxeo EP 5.3 92
Layouts
point="widgettypes">
<widgetType name="customtype">
<handler-class>
org.myproject.MyCustomWidgetTypeHandler
</handler-class>
<property name="foo">bar</property>
</widgetType>
</extension>
</component>
The custom widget type class must follow the

org.nuxeo.ecm.platform.forms.layout.facelets.WidgetTypeHandler interface.
Additional properties can be added to the type registration so that the same class can be reused with a different
behavior given the property value.
The widget type handler is used to generate facelet tag handlers dynamically taking into account the mode, and
any other properties that can be found on a widget.
The best thing to do before writing a custom widget type handler is to go see how standard widget type
handlers are implemented, as some helper methods can be reused to ease implementation of specific behaviors.
8.8. Generic layout usage

Layouts can be used with other kind of objects than documents.
The field definition has to match a document property for which setters and getters will be available, or the
"value" property must be passed explicitely for the binding to happen. Depending on the widget, other kinds of
bindings can be done.
Nuxeo EP 5.3 93
Chapter 9. Event Listeners and Scheduling
9.1. Introduction
Events and event listeners have been introduced at the Nuxeo core level to allow pluggable behaviors when
managing documents (or any kinds of objects of the site).
Whenever an event happens (document creation, document modification, relation creation, etc...), an event is
sent to the event service that dispatches the notification to its listeners. Listeners can perform whatever action
when receiving an event.
9.2. Concepts
A core event has a source which is usually the document model currently being manipulated. It can also store
the event identifier, that gives information about the kind of event that is happening, as well as the principal
connected when performing the operation, an attached comment, the event category, etc..
Events sent to the event service have to follow the org.nuxeo.ecm.core.api.event.CoreEvent interface.
A core event listener has a name, an order, and may have a set of event identifiers it is supposed to react to. Its
definition also contains the operations it has to execute when receiving an interesting event.
Event listeners have to follow the org.nuxeo.ecm.core.listener.EventListener interface.
Several event listeners exist by default in the nuxeo platform, for instance:
• DublincoreListener: it listens to document creation/modification events and sets some dublincore
metadata accordingly (date of creation, date of last modification, document contributors...)
• DocUidGeneratorListener: it listens to document creation events and adds an identifier to the document
if an uid pattern has been defined for this document type.
• DocVersioningListener: it listens to document versioning change events and changes the document
version numbers accordingly.
9.3. Adding an event listener

Event listeners can be plugged using extension points. Here are some examples of event listeners registration.
Example 9.1. DublincoreListener registration sample
<component name="DublinCoreStorageService" version="1.0.0">
<extension target="org.nuxeo.ecm.core.listener.CoreEventListenerService"
point="listener">
<listener name="dclistener"
class="org.nuxeo.ecm.platform.dublincore.listener.DublinCoreListener"
order="120" />
</extension>
</component>
Example 9.2. UIDGenerator listener registration sample with event filtering
Nuxeo EP 5.3 94
Event Listeners and Scheduling
<component name="org.nuxeo.ecm.platform.uidgen.service.UIDGeneratorService">
<extension target="org.nuxeo.ecm.core.listener.CoreEventListenerService"
point="listener">
<listener name="uidlistener"
class="org.nuxeo.ecm.platform.uidgen.corelistener.DocUIDGeneratorListener"
order="10">
<event>documentCreated</event>
</listener>
</extension>
</component>
The only thing needed to add an event listener is to declare its name and its class. Sometimes the order in which
listeners are called matters so an integer order can be set to control it. A filtering on event ids can be done when
registering it too, though the notification method could handle it too.
For instance, the UIDgenerator service will only be notified when the event service receives a document
creation event.
9.4. Upgrading an event listener

Since release of Nuxeo EP version 5.0 M3, events involving documents send the document model as source of
the event. They used to send the document itself, which was wrong and has been changed in a compatible way.
Old school event listeners should still work ok for now, but should be migrated soon as the compatibility may
introduce bugs and will be removed shortly.
To migrate your event listener, make it implement the empty interface

org.nuxeo.ecm.core.listener.DocumentModelEventListener, and make it deal with a DocumentModel
instead of a Document as event source.
If your event listener does not care about the source, or the event it deals with is not a document, you do not
have to do anything.
9.5. Adding an event

To add an event, you have to create it and then notify listeners passing the even to the listener service. Here is a
sample code on how to do it:
CoreEvent coreEvent = new CoreEventImpl(eventId, source, options,
getPrincipal(), category, comment);
CoreEventListenerService service = NXCore.getCoreEventListenerService();
if (service != null) {
service.notifyEventListeners(coreEvent);
} else {
throw new ClientException("Can't get Event Listener Service");
}
9.6. From CoreEvents to JMS Messages

Events that are fired at the core level are forwarded to a JMS topic called NXPMessage.
This forwarding is done by a dedicated CoreEventListener (called JMSEventListener contributed by the

nuxeo-platform-events-core bundle).
In order to be sure that when an JMS event is received the associated DocumentModel is available, all
document oriented messages that may occur at core level are forwarded to the JMS topic when the session
repository is saved (ie: when data is committed).
Nuxeo EP 5.3 95
In some cases, depending on own the Core API is used, some messages can be duplicated within the same
transaction (like modifying several times the same document), the JMSEventListener marks all duplicated
messages before sending them to JMS, its JMS messages receiver to choose to process or not the duplicated
messages.
During the forwarding on the JMS Topic, the coreEvents are converted to EventMessage. The main difference
is that the EventMessage does not contains the DocumentData (ie: all schemas and fields are unloaded), this is
done in order to avoid overloading JMS.
9.7. Adding a JMS message listener

The simplest way to add a JMS message listener is simply to define a Message Driven Bean that is bound to the
NXPMessage Topic.
Here is a simple example a the definition of such a MDB :

@MessageDriven(activationConfig = {
@ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Topic"),
@ActivationConfigProperty(propertyName = "destination", propertyValue = "topic/NXPMessages"),
@ActivationConfigProperty(propertyName = "providerAdapterJNDI",
propertyValue = "java:/NXCoreEventsProvider"),
@ActivationConfigProperty(propertyName = "acknowledgeMode", propertyValue = "Auto-acknowledge") })
@TransactionManagement(TransactionManagementType.CONTAINER)
public class NXAuditMessageListener implements MessageListener {
private static final Log log = LogFactory.getLog(NXAuditMessageListener.class);
@TransactionAttribute(TransactionAttributeType.REQUIRED)
public void onMessage(Message message) {
try {
final Serializable obj = ((ObjectMessage) message).getObject();
if (!(obj instanceof DocumentMessage)) {
log.debug("Not a DocumentMessage instance embedded ignoring.");
return;
}
DocumentMessage docMessage = (DocumentMessage) obj;
String eventId = docMessage.getEventId();
log.debug("Received a message with eventId: " + eventId);
...
The DocumentMessage is a subclass of the DocumentModel.
An important point to remember is that the MDB is executed asynchronously in a dedicated thread:
• there is no JAAS Session established: you can not access the repository without this
• the DocumentMessage is not bound to an existing CoreSession: you can not use the DocumenMessage to
do lazy loading (ie: DocumentMessage.getProperty())
So, in order to extract some document oriented properties of the document associated to the event, you must:
• Establish a JAAS Session
• get a connected DocumentModel using the DocumentRef provided by the DocumentMessage
Here is a code sample for this:

LoginContext lc;
CoreSession session;
String repositoryName = docMessage.getRepositoryName();
try {
log.debug("trying to connect to ECM platform");
lc = Framework.login();
session = Framework.getService(RepositoryManager.class).getRepository(repositoryName).open();
DocumentModel connectedDoc = session.getDocument(docMessage.getRef());
...
} finally {
if (session != null)
CoreInstance.getInstance().close(session.getSessionId())
if (lc != null)
Nuxeo EP 5.3 96
lc.logout();
}
9.8. Scheduling
XXX TODO: FG
Nuxeo EP 5.3 97
Chapter 10. User Notification Service
10.1. Introduction
The notification framework provides a way to notify the users regarding different events as they happen in the
system.
10.2. Notification concept

A notification is an alert that is sent to some users when an event takes place in the system (e.g. a document is
created or deleted, a document is modified or published, a comment was entered, etc.).
A notification is defined by following attributes:

• name: must be unique
• channel: email, SMS, Jabber, etc.
• events: a series of events to which it responds
• template: is a file in which is stored the text that is sent to an user - it may be dynamic
In order to define a notification, one must declare all these attributes in a contribution file.
10.3. Notification channels

The channel is the communication channel used by the notification service to send alerts(notifications) to users.
In order to define a new channel (by default only email channel is used) the ChannelNotificator interface
must be implemented.
It has 2 methods:
• isInterestedInNotification(Notification docMessage) usually checks if the channel is right.
• sendNotification(DocumentMessage docMessage) sends the actual notification. For now only email
notification channel is implemented.
10.4. E-mail notifications

A notification must be defined in a xml file like the default notification-contrib.xml that is used by default.
Default defined notification may be disabled by setting enabled="false".
In order to define a new notification one must place a definition like this one in his contribution file :
<notification name="Modification" channel="email" enabled="true"
availableIn="workspace" autoSubscribed="false"
template="modif" subject="Document modified"
subjectTemplate="subjectModif"
label="label.nuxeo.notifications.modif">
<event name="documentModified"/>
<event name="contentSubdocumentModified"/>
</notification>
As you may see above a notification must declare a list of events to which it reacts. In our case
documentModified contentSubdocumentModified.
Nuxeo EP 5.3 98
User Notification Service
Also a notification must have a name that must be unique within the application. A label must also be specified
for i18n.
The attribute enabled is used to enable / disable specific notifications.
The attribute autoSubscribed is set to true when we want that a notification is sent to all concerned users. In
this case within the eventInfo map there must be loaded also the users that are concerned. For example if we
want that some users (ex: administrators or workflow manager) to get a notification each time a task is assigned
to them, we must use autoSubscribed="true" and put the usernames of all users in the eventInfo of the event
under the key recipients.
The attribute availableIn is used in order to restrict the scope of a notification. For example if we want to
define a notification that is triggered each time the document is modified, then it would not be used inside a
section, because sections contain documents that cannot be modified, only published. So in order to hide this
notification inside a section, we specify availableIn="workspace". The accepted values are workspace,
section and all.
The template attribute specifies the name of a template that will be used for generating the body of the
email(notification). This name is associated with a file using another extension point like this: <template
name="modif" src="templates/modif.ftl" />.
Inside a *.ftl file there may be inserted some dynamic parts like the document name, the user triggering the
event, etc. Any data that one wishes to put inside the body of the email, or its subject, he must put that data in
the eventInfo map under a unique key. Then inside the template file that data will be displayed using ${key}.
For the email notification a subject is used. This subject is a string but is also dynamic following the same rules
as the body inside the template files. For those who wants more parameterizable subject, you can use the
subjectTemplate attribute : it specifies the name of the template used for generating the subject and into which
you can write dynamic content. As for the template attribute, the association between the name and the file is
done using an extension point like <template name="subjectModif"
src="templates/subjectModificationTemplate.ftl" />.
If both subject and subjectTemplate attributes are filled, the subjectTemplate attribute will be used to generate
the subject.
Note that if you are writing an HTML based template it will be advised to use HTML encoded letters when
there is accentuated letters (in French for example "é" will be "é"). The htmlEscape method is provided
while writing templates to transform accentuated characters in data from the eventInfo map.
<p> Your comment here : ${htmlEscape(key)} </p>
Nuxeo EP 5.3 99
Chapter 11. Indexing & Searching
This chapter presents the architecture of the indexing and search service in Nuxeo EP 5.
11.1. Introduction
This chapter is under construction. XXX TODO: GR+JA
11.2. Configuration
For obvious performance and volume considerations, the search service doesn't index all the content of the
application, nor does it provide the full content in search results. This must be specified in the configuration,
along with what to do with the data.
The search service configuration is done by the standard Nuxeo Runtime extension point system. The target is
org.nuxeo.ecm.core.search.service For a complete example, check the default configuration file:
nuxeo-platform-search-core/OSGI_INF/nxsearch-contrib.xml (from Nuxeo EP sources).
11.2.1. Concepts
The main concepts are Resource and Field. A Resource holds several fields. It has a name and a prefix, which
is used, e.g, in queries. Resources are supposed to be unsplittable, but they are usually aggregated. It's up to the
backend to decide how to handle that aggregation; this goes beyond the scope of the present documentation.
At this point the search service handles documents only, so it's safe to say that documents correspond to
aggregates of resources, and resources correspond to schemas. In the future, there'll be more types of resources.
11.2.2. The indexableDocType extension point

The core types of documents to index have to be registered against this extension point, in which the schemas
to index are bound to each document type.
Here's an example demonstrating the available patterns:

<extension target="org.nuxeo.ecm.core.search.service.SearchServiceImpl"
point="indexableDocType">
(...)
<indexableDocType name="DocType1" indexAllSchemas="true"/>
<indexableDocType name="DocType2" indexAllSchemas="true">
<exclude>unwanted_schema</exclude>
</indexableDocType>
<indexableDocType name="DocType3">
<resource>indexed_schema</resource>
</indexableDocType>
</extension>
In this example, the Search service will index all schemas for documents of type DocType1, all schemas except
unwanted_schema for type DocType2 and only indexed_schema for type DocType3.
Each ot these indexable schemas will be processed according to the corresponding indexable schema resource
if available in the configuration, or to the default one .
In particular, the behavior of data from a given schema is homogeneous across all document types.
11.2.3. The resource extension point

This extension point is used to declare an indexable resource. In 5.1M2, the only provided indexable resource
type is the schema resource type. but the logic will stay the same for future types. Recall that resources are
made of fields. Here's an example of schema indexing resource, without fields details.
Nuxeo EP 5.3 100

Indexing & Searching
<extension target="org.nuxeo.ecm.core.search.service.SearchServiceImpl"
point="resource" type="schema">
<resource name="dublincore" prefix="dc" indexAllFields="true">
<excludedField>issued</excludedField>
<field name="title" (...) />
</resource>
<resource name="book" prefix="bk" type="schema">
<field name="barcode" (...) />
</resource>
</extension>
The type specified that the resource is a docuemnt schema resource.
The name and prefix attributes are mandatory. They should match the ones from the schema extension point of
org.nuxeo.ecm.core.schema.TypeService as in, e.g.:
<schema name="dublincore" prefix="dc" src="schema/dublincore.xsd"/>

<schema name="common" src="schema/common.xsd" />
A missing prefix in the core configuration as in the common schema declaration in the example above will
default to the schema name.
The prefix is important, since all subsequent references to the fields (in queries and raw search results) take the
prefix:fieldName form.
11.2.4. Field configuration

Fields behavior is designed to be uniform across the different kinds of resources.
11.2.4.1. The type attribute
The field type tells the search engine how to process the field. This is a mandatory, case-insensitive, attribute.
The following table summarizes the available types. The listed Java classes are guaranteed to work. The
backend might implement more converting facilities.
Type Java classes Comment

Keyword String
Meant for technical non binary
strings such as vocabulary keys,
user identifiers etc. Equality
matches are guaranteed to be exact.
Text String
Upon indexation, these fields are
tokenized and analyzed to support
fulltext queries.
Path org.nuxeo.common.utils.Path,
String Dedicated to STARTSWITH queries.
Equality queries are not
guaranteed.
Date java.util.Calendar For date and time indexing
Int int
Builtin Reserved for internal use
11.2.5. Text fields and analyzers
Nuxeo EP 5.3 101

At indexing time, the contents of text fields goes through the process of tokenization and analysis, whose main
goal is to provide fulltext search capabilities, usually at the expense of exact matches.
Tokenization means converting the textual content in a stream of words (tokens). During the analysis step, this
raw stream is altered to better suit the needs of fulltext searches. It is for example common practice to strip the
stream of so-called stop words (most commons words in the language) and to degrade accented characters. One
can apply further linguistical processing, such as stemming or synonym analysis.
The name of analyzer to use on a given text field is specified through the analyzer attribute. The Search
Service acts as a pure forwarder, sending the raw text to the backend, along with the specified analyzer name.
The default value for the analyzer attribute is default. The attribute is simply ignored for other field types.
11.2.6. Boolean attributes

• To enable queries on a given field, one must set the indexed attribute to true.
• To make it possible to provide the full field value in search results, one must set the stored attribute to
true. One must keep in mind that the purpose is to present the user a limited yet sufficient set of
information along with search results, i.e, in a swifter way than having to fetch it from the core, and not
to duplicate the content in the search databases.
• Multivalued fields have to be flagged by setting the multiple attribute to true.
• Depending on field types and on the processing that's been done by the backend, the possibility to use the
field value as a sort key might require some additional resources. To force the backend to give this extra
effort, set the sortable attribute to true.
• The binary attribute is used to mark binary fields, e.g, to trigger conversions (not used in 5.1M2).
11.2.7. Schema resources and fields without configuration
11.2.8. Schema resources

For a schema resource that isn't explicitely declared and nevertheless used, for instance because of an
indexAllSchemas statement, a default configuration is inferred, with the prefix read from the Core
configuration, and fields as below, i.e., as if there was an indexAllFields="true" attribute.
11.2.9. Automatic fields configuration
• auto-configured fields are unstored
• If there is only one relevant type from the table above, it is applied.
• The multiple attribute is properly set.
• auto-configured String fields get the keyword type.
Example 11.1. Relying on automatic field configuration on all fields but one
<resource name="dublincore" prefix="dc" indexAllFields="true" type="schema">

<field name="title" analyzer="default"
stored="true" indexed="true" type="Text"
binary="false" sortable="true"/>
</resource>
Nuxeo EP 5.3 102

11.3. Programmatic Searching

The search service exposes the searchQuery method as a unique entry point. The method takes as input an
instance of ComposedNXQuery, which encapsulates the parsed NXQL query and a SearchPrincipal instance
that will be checked against the security indexes, and paging information for the results.
Although the input of searchQuery is an already parsed NXQL statement, we'll use NXQL query strings in the
sequel for clarity. NXQL query strings are parsed by the method parse of the static
org.nuxeo.ecm.core.query.sql.SQLQueryParser class.
11.3.1. Fields and literals

Within NXQL requests, references to fields values have to follow the "prefix:fieldName" scheme, where prefix
and fieldName have been specified through the configuration extension points (recall that for automatically
indexed schema resources, the prefix defaults to the one defined in the schema definition).
Literals (constants) follow the JCR specifications. Notably:

• String literals have to be enclosed in single quotes
• Lists have to be enclosed in parenthesizes
Example 11.2. Sample NXQL queries
Recall that "dc" is the prefix for the "dublincore" schema.

SELECT * FROM Document WHERE dc:title='Nuxeo book' ORDER BY dc:created DESC
11.3.2. WHERE statements

Most WHERE statements behave as described in the JCR specification, which is itself based on general SQL.
Instead of covering every aspect of NXQL, in the current state of this documentation, we'll focus on differences
and behaviors that might appear to be counter intuitive.
11.3.2.1. Text fields
Although the Search Service is meant to provide an unified abstraction on the tasks of indexing and querying,
text fields have to be somewhat an exception. Indeed, search engines have very different capabilities,
depending on provided analyzers. They are nonetheless all expected to provide a direct syntax for full text
searches, that an end user can use from, e.g., an input box on a web page. Given the very special kind of
constraint that indexing a text field represents, it's not guaranteed that exact matches are supported.
See Section 11.4.4, “Text fields behavior” from the documentation of the Compass backend to get a more
concrete view on this (with examples).
11.3.2.1.1. Conclusions
• The backend uses the closest thing to exact matches it supports to treat = predicates.
• The syntax of LIKE predicates is backend dependent. It follows the backend's full text query syntax
• The CONTAINS from JCR is not supported. Use a LIKE statement on the main full-text field (see
Section 11.3.2.3, “Pseudo fields”).
Nuxeo EP 5.3 103

11.3.2.2. Multi-valued fields
On a multi-valued field, the = operator is true if the right operand belongs to the set of field values. The IN
operator is true if the intersection between the set of field values and the right operand is non empty.
Example 11.3. Finding documents on which user sally contributed
SELECT * FROM Document WHERE dc:contributors = 'sally'
Example 11.4. Finding documents on which user sally or harry contributed
SELECT * FROM Document WHERE dc:contributors IN ('sally', 'harry')
This behavior is in conformance with the JCR specification, which states it the following more general terms:
In the WHERE clause the comparison operators function the same way they do in XPath when
applied to multi-value properties: if the predicate is true of at least one value of a multi-value
property then it is true for the property as whole.
11.3.2.3. Pseudo fields
The following fields are available on all document resources. They don't correspond to document fields and
aren't configurable, that's why they're called pseudo-fields.
The names of these fields are synchronized with constants from the class BuiltinDocumentFields. Any use
from java code should rely on these.
Constant Field name Description

FIELD_FULLTEXT ecm:fulltext The default full-text aggregator
(string)
FIELD_DOC_PATH ecm:path The document path (string)
FIELD_DOC_NAME ecm:name The document name (last
component of the path, string)
FIELD_DOC_URL ecm:url The document URL (string)
FIELD_DOC_REF ecm:id The DocumentRef as fetched from
the core
FIELD_DOC_PARENT_REF ecm:parentId The parent DocumentRef
FIELD_DOC_TYPE ecm:primaryType The Core type (string)
FIELD_DOC_FACETS ecm:mixinType The facets (multiple)
FIELD_DOC_LIFE_CYCLE ecm:currentLifeCycleState The document life cycle (string)
FIELD_DOC_VERSION_LABEL ecm:versionLabel The version label (string)
FIELD_DOC_IS_CHECKED_IN_VERSION
ecm:isCheckedInVersion A boolean (0 or 1) that states if
document is a frozen version (not
live nor proxy)
Nuxeo EP 5.3 104

FIELD_DOC_IS_PROXY ecm:isProxy A boolean (0 or 1) that states if

document is a proxy (targetting
other documents)
FIELD_DOC_REPOSITORY_NAME
ecm:repositoryName The document repository name
(string)
11.4. The Compass plugin

Compass is a popular wrapper around Apache Lucene. This plugin allows to use it as a backend for the Search
Service.
11.4.1. Configuring Compass

Compass configuration is split in a master XML configuration file and one or several mapping files. The latter
specifies the treatments that resources and fields (properties in Compass terminology), while the former is to be
used to tune JTA transactions, data sources, and to register configuration of analyzers and converters.
The contents of these files are covered in great details in the Compass 1.1 documentation. In the present
documentation, we'll focus on integration matters with the Nuxeo Search Service.
11.4.1.1. Configuration files location
All Compass specific configuration files are relative to the classpath of the compass plugin. A default
configuration is provided for Nuxeo EP 5 WebApp. To customize it, one sadly has to put the configuration at
the right place within the backend's JAR.
Here is an ant fragment to perform this in a JBoss context, assuming that the Search Service has already been
installed in the application server and that the server's deployment directory is stored in the deploy.dir
property.
<copy todir="${deploy.dir}/nuxeo.ear/system/nuxeo-platform-search-compass-plugin-1.0.0-SNAPSHOT.jar"
overwrite="true" failonerror="false">
<fileset dir="src/main/resources">
<include name="myfile.xml" />
</fileset>
</copy>
The backend's JAR is included as a directory in nuxeo.ear during the Maven build of nuxeo-platform-ear for
this single purpose. This is prone to change in the future.
11.4.1.2. Specifying the master configuration XML file name
The Compass backend itself is registered against the Search Service through the searchEngineBackend
extension point of org.nuxeo.ecm.core.search.service.SearchServiceImpl. Your component can use the
configurationFileName element to specify a path to the master configuration file, like this:
<searchEngineBackend name="compass" default="true"

class="org.nuxeo.ecm.core.search.backend.compass.CompassBackend">
<configurationFileName>/mycompass.cfg.xml</configurationFileName>
</searchEngineBackend>
The default path is /compass.cfg.xml.
11.4.2. Global configuration
11.4.2.1. Storage
Nuxeo EP 5.3 105

Compass supports several storage possibilities, called connections in Compass configuration objects. The
configuration is done trough a Nuxeo Runtime extension point and possibly within the Compass master
configuration file. The extension point always takes precedence over the Compass file, but can be used to fall
back to Compass file, that offers currently more possibilities.
The target is org.nuxeo.ecm.core.search.backend.compass.CompassBackend, and the point is connection.

Contributions are made of a single XML element; the latest one wins.
To set the connection to a file system Lucene store, put a file element in the contribution, and set the path
attribute to the target location. If the path doesn't start with /, it will be interpreted as being relative to Nuxeo
Runtime's home directory, e.g, /opt/jboss/server/default/data/NXRuntime in the default Nuxeo EP
installation on JBoss.
Other connection types, notably JDBC, are defined by the Compass configuration file, one has to put the
default XML element in the contribution, like this:
<extension target="org.nuxeo.ecm.core.search.backend.compass.CompassBackend"
point="connection">
<default/>
</extension>
The default connection is a relative file system one, hosted in the nxsearch-compass sub directory of Nuxeo
Runtime's home.
11.4.2.2. Analyzers
The master configuration file holds the definition and configuration of analyzers: a lookup name gets associated
to an analyzer type and options. The Compass backend makes Compass use directly the name declared in the
Search Service as the lookup name, configuration, therefore one has to ensure here that all of these do exist in
the Compass configuration.
Together with the registration itself comes the configuration of analyzers. For instance, an analyzer discarding
stop words might be given the full list of stop words.
Compass comes with a two predefined analyzers: default and search. You can reconfigure them as well.
See the relevant part in Compass documentation for details and sample configurations.
11.4.2.3. Converters
Lucene only knows about character strings. Therefore, typed data such as dates and integers must be converted
in strings to get into Lucene and back. Compass provides helpers for this and the Compass backend uses them
directly.
In the master configuration file, one register available converters in the form of a lookup name and a Java class.
Lots of converters are already registered by default, covering most basic types. The compass.cfg.xml file
shipping with the Compass backend redefines one (the date converter).
11.4.3. Mappings for Nuxeo

For the time being, a part of the Search Service configuration has to be duplicated in the Compass mappings
XML file.
11.4.3.1. What to describe and syntax
Currently, the Compass backend can't force Compass to use a given converter and/or analyzer on a given field.
It must therefore be specified in the mappings file, which is itself loaded from the master configuration file. The
default name for this file is nxdocument.cpm.xml.
Here's a sample, inspired from the mappings file provided with the backend.
Nuxeo EP 5.3 106

<!DOCTYPE compass-core-mapping PUBLIC
"-//Compass/Compass Core Mapping DTD 1.0//EN"
"http://www.opensymphony.com/compass/dtd/compass-core-mapping.dtd">
<compass-core-mapping>
<resource alias="nxdoc"
sub-index="nxdocs"
analyzer="default"
all="false">
<resource-id name="nxdoc_id"/>
<resource-property name="dc:created" converter="date"
store="yes" index="un_tokenized" />
<resource-property name="dc:title" analyzer="french" />
</resource>
</compass-core-mapping>
In Compass' terminology, fields are called properties. The name of the Compass property corresponding to a
Nuxeo indexed field coincides with the field's prefixed name.
Some important remarks:

• Start from the current mappings file shipping with your version of the compass backend and keep it up to
date afterwards
• Don't change anything besides resource-property elements.
• An exception to the above rules: you may experiment with the sub-index attribute, according to your
performance needs.
11.4.3.2. Installing the mappings file
Follow the instructions from Section 11.4.1.1, “Configuration files location”
11.4.4. Text fields behavior

Everything in this part applies to fields that have explicitly been declared with a "text" type through the
extension point. Anything that's meant for text fields in the mappings configuration files will be ignored if the
field has another type.
11.4.4.1. Indexing
At indexing time, the text field is analyzed using the analyzer from the Compass configuration file regardless
what has been configured through the Search Service extension point.
11.4.4.2. Searching
Equality statements in WHERE clauses are transformed into the closest thing that Lucene can provide on an
analyzed field, namely a phrase query.
On the other hand, LIKE clauses are directly fed to Lucene's QueryParser. To search documents whose title
starts with "nux", one may write
SELECT * FROM Document WHERE dc:title LIKE 'nux*'
The following two statements are equivalent. The second one is the QueryParser syntax for phrase queries.
... WHERE dc:title='Nuxeo Book'
... WHERE dc:title LIKE '"Nuxeo Book"'
Lucene's QueryParser syntax is really powerful, you can specify how close two words can be, apply fine
grained boosts for the relevance ordering, and more. The only restriction you have on LIKE statements for text
Nuxeo EP 5.3 107

fields within the Compass backend is the choice of field. In other words, the colon character is escaped.
You would need to query date fields, like creation, modification or expiration date, that are provided by Nuxeo
Platform. In these cases, it would be interesting to use BETWEEN clauses, associated with DATE keyword,
which allows to convert strings as date values.
Example 11.5. Date queries
Documents created in the first term of 2008:

... WHERE dc:created BETWEEN DATE '2008-01-01' AND DATE '2008-03-31'
Documents modified in may 2007:

... WHERE dc:modified BETWEEN DATE '2007-05-01' AND DATE '2007-05-31'
You should be aware of the following trap in Lucene queries: purely negative queries don't match anything,
even if they are themselves nested in a boolean query that has positive statements. The Compass backend uses
the standard way to circumvent this limitation, provided that the negative aspect can be seen from the NXQL
structure, i.e., not enclosed in a Lucene QueryParser literal.
Example 11.6. Negative queries
Queries that won't return anything:

... WHERE dc:title LIKE '-book'
... WHERE dc:title LIKE 'nuxeo' AND dc:title LIKE '-book'
Queries that should work as intended (the last three being equivalent):
... WHERE dc:title NOT LIKE 'book'
... WHERE dc:title LIKE 'nuxeo' AND dc:title NOT LIKE 'book'
... WHERE dc:title LIKE 'nuxeo' AND NOT dc:title LIKE 'book'
... WHERE dc:title LIKE '+nuxeo -book'
11.5. Building a search UI with QueryModel
Nuxeo EP 5.3 108

Chapter 12. Look and feel
12.1. Introduction
The Nuxeo theme notion is wider than the notion attached to the same word in portal concepts. Indeed, the
Nuxeo Theme defines all the look and feel of your webapp: composition, layout and graphical appearance.
Nuxeo does not aim at developing a portal, i.e. a JSR 168 container, but it authorizes a kind of page and widget
management to get some flexibility in the design you want to give to your webapp. The tool to enable you
manage those aspects is "Nuxeo Theme editor", that you can make appear with the following command when
you are in Nuxeo Web app:
To switch to Nuxeo Theme editor click on the 'Themes Management' link in the user services panel.
Alternatively, you can type 'shift'+'alt'+'t'. To switch to Nuxeo Theme editor with Mozilla / Firefox < 2.0 type
'alt'+'t'
12.2. Principle
One special fragment is the Facelet region: in the properties tab of the editor you can specify the name of a
faces to directly integrate it into your page.
To use Nuxeo theme editor, you need to understand its model. The main entity is the theme. Then a theme may
have many pages. For each pages, you define a layout (a canvas) and add a list of fragments (widget). The
graphical editor uses a tab (theme) and sub-tab (page) system. When you want to add a new page or theme click
on "+" at the end of the tab list. For a page you have three possible views:
• wysiwyg: you can move the widgets and evaluate the rendering.
• fragments: to put the widgets in their placeholder (= a cell). You can put many widgets in a place
holder.
• layout: you can create new rows and divide the rows into cells, and specify the width of each cell (just
edit the nn% on the screen).
You can click on a fragment to edit it. When you edit a fragment you have a multitab editor to specify:
• custom properties of the fragment: e.g. the text if it is a text fragment,
• the graphical object (the widget) associated
• the style of each HTML object that composes the widget.
• then you specify the perspective in which the fragment can be seen.
One special fragment is the Facelet region: in the properties tab of the editor you can specify the name of a
faces to directly integrate it into your page.
12.3. Mechanism
Nuxeo Editor is done for not having to understand the underground mechanism. Yet it can be good to
understand the background to better leverage the tool and its possibilities. The Nuxeo component that manages
the customization and extension of Nuxeo EP 5 look and feel is: org.nuxeo.theme.services.ThemeService.
To register a whole theme (widget, style, layout etc. ...) you need to contribute to the extension point "theme"
this way:
Nuxeo EP 5.3 109

Look and feel
<extension
target="org.nuxeo.theme.services.ThemeService" point="themes">
<theme> <src>META-INF/nxthemes-setup.xml</src>
</theme> </extension>
In the trunk, the default theme is in the webapp project. Having a look inside enables us to discover the main
features.
12.3.1. The Elements

The file starts with the elements declaration, we define the pages, the rows (section markup), the cells and the
fragments in the cells.
<theme name="default"> <layout>
<page name="default"> <section> <cell> <fragment
type="generic fragment" /> </cell> <cell> <fragment
type="generic fragment" /> </cell> <cell> <fragment
type="generic fragment" /> </cell> </section>
</page> <page name = ...> . . . </page>
</layout> </theme>
All this markup refers to an Element subtype in the java model: PageElement, CellElement... The fragment
element, the one that gives the widget oriented capacity to Nuxeo is typed: we have in the default distribution
"generic fragment", "action fragments". A typed fragment returns a model to be displayed and edit in the edit
mode of the fragments. This model is often (but not always) what we can see in the "properties" tab of the
fragment editor. For now there is in the default Nuxeo distribution:
• generic fragment (empty model)
• textual fragment
• region fragment
• action fragment
The fragment can also receive a perspective attribute that specifies in which perspective it will be displayed
(the fourth tab in the fragment editor). You can then propose to Nuxeo user the same kind of experience you
have in Eclipse. The perspective are specified in the perspective extension point of !ThemeService component.
12.3.2. The format

Then, once you declared all the elements, you can format them through different axes :
• their layout
• their rendering (their view)
• their style
To do this, you put, inside the <theme> markup, children markup from those types:
• layout --> <layout element = ...>
• rendering --> <widget element ...>
• style --> <style element = ...>
Those 3 markups use the attribute element to get the reference to which element of your skeleton they will be
applied:
element="page[3]/section[3]/cell[1]"
Nuxeo EP 5.3 110

Look and feel
12.3.2.1. The rendered widget
Indeed each element is rendered by a view.

<widget element="page"> <view>page
frame</view> </widget>
This view is defined like this (with another extension point of !ThemeService: views):
<view
name="page frame"> <element-type>page</element-type>
<format-type>widget</format-type>
<class>org.nuxeo.theme.jsf.views.JSFView</class>
<template>nxthemes/jsf/widgets/page-frame.xml</template>
</view>
We can see that a view is associated to an element type. The element types contributions should be reserved to
Nuxeo only (one should manage with existing ones). The template markup gives the html/faces/text code to be
used for rendering the view. Notice that in the view, you can access the fragment model data through the EL
call nxthemesInfo.model.
<h:outputText escape="false"
value="#{nxthemesInfo.model.body}" />
12.3.2.2. The layout
The layout properties are given like this (still under the <theme> markup) :
<layout element="page[3]/section[3]/cell[1]">
<width>50%</width> <padding>20px</padding>
<margin>0</margin> </layout>
This enables to adjust the position of the fragments inside.
12.3.2.3. The style
Then comes the style properties. Again, you apply them to an element:
<style
element="page[1]/section[3]/cell[1]|page[3]/section[4]/cell[1]">
<selector path=""> <color>#757575</color>
<border-style>solid none none none</border-style>
<border-color>#003366</border-color>
<border-width>1px</border-width> <background> #FFF
url(/https/www.scribd.com/nuxeo/img/gray_gradient.gif) top left repeat-x
</background> <padding>5px 15px 5px 5px</padding>
</selector> <selector path="div">
<font-size>9px</font-size> </selector>
</style>
The selector specifies the markup to which the defined style is applied. The style definition used is the one of
the deeper upper-element that has a style definition specified. To be exhaustive, we need to present the filter
system (TODO)
12.3.3. The negotiation

We have seen how to define a theme. Now we need to see how a theme is applied. More precisely, how do I
manage the choice of the page I will display? In fact, the Nuxeo Theme framework proposes many ways to
specify the theme applied to the webapp for a given view:
• with a cookie
• with a request parameter (?theme= ...)
• with an association between a JSF view id and a theme
Nuxeo EP 5.3 111

Look and feel
So how to manage priority when more than one parameter is passed to the framework? The !ThemeService
component has another extension point to achieve this: the negotiation extension point. Not only can it be
used to select a theme but it also works with other objects as we will see later.
<negotiation object="theme"
strategy="nuxeo5">
<scheme>org.nuxeo.theme.jsf.negotiation.theme.RequestParameter</scheme>
<scheme>org.nuxeo.theme.jsf.negotiation.theme.CookieValue</scheme>
<scheme>org.nuxeo.theme.jsf.negotiation.theme.ViewId</scheme>

<scheme>org.nuxeo.ecm.webapp.theme.LocalTheme</scheme>
<scheme>org.nuxeo.theme.jsf.negotiation.theme.DefaultTheme</scheme>
</negotiation>
As we can see in the example, the negotiation point defines the order in which the different methods for
obtaining the current theme information are applied. This negotiation feature also applies to other Nuxeo
Theme objects like the engine, the mode, the perspective.
12.3.4. The engine

Engine and filter are two notions that work together. An engine is the combination of different filters, and a
filter is a "sub-unit" of rendering. So the engine is the global renderer of your web app. From the elements
skeleton, it will generate the graphical appearance, passing each element through different black boxes,
depending on the type of the element. Here is the definition of the default engine of Nuxeo.
<engine name="default"> <renderer
element="theme"> <filter>add widget</filter>
<filter>collect xmlns</filter> </renderer>
<renderer element="page"> <filter>add widget</filter>
<filter>set layout</filter> <filter>set
style</filter> </renderer> <renderer
element="section"> <filter>add widget</filter>
<filter>set layout</filter> <filter>set
style</filter> </renderer> <renderer element="cell">
<filter>add widget</filter> <filter>set
layout</filter> <filter>set style</filter>
</renderer> <renderer element="fragment">
<filter>control fragment visibility</filter>
<filter>add widget</filter> <filter>set
style</filter> <filter>write fragment tag</filter>
</renderer> </engine>
The engine, that you register in the ThemeService component through the "engines" extension point lets you
add for each type of element some "filters" that will do some work around the markup content at rendering
time. Nuxeo already uses filters like the style fitler, that put the style definition you chose, the layout filter, the
"drag'n drop" filter... One interesting use of the filters is illustrated with the Nuxeo Theme editor: when you
type shift+alt+t, the display changes and you are in the WYSIWYG Nuxeo theme editor. But all the
components that make your page are still here, they just look a bit different because, some different filters are
used. For instance, because of the drag'n drop filter presence, you can move the fragments.
12.3.5. Resource management

Graphical components may need some external resources such as CSS or JavaScript libraries. Nuxeo theme has
an embedded resource management system that at rendering time automatically computes the list of the files
needed for rendering a page. Resources are served using gzip compression when supported by the browser.
JavaScript resources are also compressed using Dojo's ShrinkSafe. Finally all files of a same type (.css or .js)
are concatenated. This reduces the number of individual downloads and it enables to manage dependencies
between resources. Indeed, at declaration time you can specify the dependencies for a given resource:
<extension
target="org.nuxeo.theme.services.ThemeService" point="resources">
<resource name="controls.js">
<path>nxthemes/jsf/scripts/scriptaculous/controls.js</path>
<require>effects.js</require>
<require>prototype.js</require> </resource>
</extension>
Then, when you register the view associated to an element, you specify the resources it needs:
<view name="nuxeo5
clip board"> <format-type>widget</format-type>
Nuxeo EP 5.3 112

Look and feel
<class>org.nuxeo.theme.jsf.views.JSFView</class>
<template>incl/user_clipboard.xhtml</template>
<resource>dragdrop.js</resource>
</view>
12.3.6. Application
The last concept you need to know about to completely control the look and feel of your application is the
application extension point:
<extension
target="org.nuxeo.theme.services.ThemeService" point="applications">
<application root="/nuxeo"> <negotiation>
<strategy>nuxeo5</strategy>
<default-engine>default</default-engine>
<default-theme>default/default</default-theme>
<default-perspective>default</default-perspective>
</negotiation> <resource-caching>
<lifetime>36000</lifetime> </resource-caching>
<view id="/create_relation_search_document_popup.xhtml">
<theme>default/popup</theme> </view> <view
id="/user_dashboard.xhtml">
<theme>default/user_dashboard</theme> </view> <view
id="/view_calendar.xhtml">
<perspective>view_calendar</perspective> </view>
<view id="/print.xhtml">
<perspective>print</perspective> </view>
</application> </extension>
As you can see in the example, an application is associated to a web-app root context. There you specify the
strategy (a negotiation grouping feature), the default engine, the default theme and perspective. You also
specify the caching policy and there you also declare the JSF view id / theme association that we went through
earlier in this tutorial.
12.4. Customizing the theme

Eventually, all theme and styling work will be done in the Theme Editor. For now, we have to use both the
editor and the file theme-default.xml in
nuxeo/nuxeo-platform/nuxeo-platform-webapp-core/src/main/resources/META-INF/.
What can be done in the editor: page layout, widget moving, fragment styling, page/section/cell preset borders
and backgrounds
What must be done in theme-default.xml : commons styles and their inheritance
In addition to the theme-default.xml come palettes: a bunch of presets for colors, backgrounds, fonts and
other css attributes. Nuxeo EP 5 supports text palettes and GIMP/Photoshop palettes (for the colors).
When you add images or modify theme-default.xml, you have to redeploy your Nuxeo 5.
In case of doubt, try using the editor, because the produced code is much cleaner and compliant than anything
you would write manually :-)
12.4.1. Modifying the current theme using theme-default.xml

The file theme-default.xml is structured as follows:
• Pages and their layout
• widgets in pages
• definition of predefined styles (using preset values from palettes)
• cell and fragments styling
Nuxeo EP 5.3 113

Look and feel
In theme-contrib.xml we have our theme called:
 <extension

target="org.nuxeo.theme.services.ThemeService" point="themes">
<theme> <src>META-INF/theme-default.xml</src>
</theme> </extension>
In the editor, in Manage Themes tab, it gives:
This file is deployed in JBoss. If you modify the theme using the editor all changes will be lost so think of
downloading the theme to your Desktop, to replace the theme-default.xml in your local copy of Nuxeo EP 5.
A good way of working with this file is to add your working copy in theme-contrib.xml. It is possible in
NXThemes to load several themes and page.
Add your file(s) in themes-contrib.xml, for example:
<theme>
<src>file:///path/to/sources/nuxeo/nuxeo-platform/nuxeo-platform-webapp-core/src/main/resources/META-INF
</theme>
After a redeployment, in the 'Manage Themes' section we now have a theme that can be reloaded directly from
the file-system!
Starting from there, here are two ways of developing smartly:

• Edit your theme-default.xml in Eclipse (or in your XML editor) then go to theme editor, in Manage
Themes tab and click "Reload" on your local file: you can directly see the changes you made in the XML
source.
• Modify the theme inside the editor, then go to Manage Themes tab and click on "Save" action. All
changes will be saved in the file.
12.4.1.1. Playing with palettes.
The palettes are in

nuxeo/nuxeo-platform/nuxeo-platform-webapp-core/src/main/resources/themes.palettes/
They are called in

nuxeo/nuxeo-platform/nuxeo-platform-webapp-core/src/main/resources/OSGI-INF/theme-contrib.xml:
 <extension

target="org.nuxeo.theme.services.ThemeService" point="presets">
<palette name="Nuxeo default fonts"
src="themes/palettes/nxfonts.properties" category="font" />
<palette name="Nuxeo psd colors"
src="themes/palettes/nxcolors.aco" category="color" />
<palette name="Nuxeo default backgrounds"
src="themes/palettes/nxbackgrounds.properties" category="background"
/> </extension>
There are 3 default palettes:

• nxbackgrounds.properties that specifies the banner's css background and the shadow under it
• nxcolors.aco that contains nuxeo default colors in a photoshop palette format
• nxfonts.properties that contains default css font, small and 4 levels of titles
The easiest way for you to customize yout Nuxeo EP 5 app is to modify the existing palettes!
Nuxeo EP 5.3 114

Look and feel
For example, in nxfonts.properties change the line
default=11px Verdana, Arial,

sans-serif
to
default=12px Courier, serif
Then all the fonts of the app will be changed to your new value!
We advise you to add your own color palette.
12.4.1.2. Definition of a predefined style
Currently in nxthemes-setup.xml we have a style named default buttons, which is defined as:
<style name="default buttons"> <selector

path="input.button">
<background>url(/nuxeo/img/button_1.gif) 0 0 repeat-x
#e3e6ea</background> <font preset="default (Nuxeo default
fonts)"/> <margin>5px 10px 10px 0px</margin>
<color>#000</color>
<border-style>solid</border-style>
<border-width>1px</border-width>
<border-color>#ccc #666 #666 #ccc</border-color>
<padding>2px 5px 2px 5px</padding>
<cursor>pointer</cursor> </selector> <selector
path="input.button:hover"> <color preset="white (Nuxeo psd
colors)"/> <font preset="default (Nuxeo default fonts)"/>
<background>url(/nuxeo/img/button_2.gif) 0 0 repeat-x
#3f89ef</background> <border-color>#0099ff #0066cc
#0066cc #0099ff</border-color>
<border-width>1px</border-width> </selector>
<selector path="input.button[disabled=disabled],
input.button[disabled=disabled]:hover">
<color>#c1c1c1</color> <font preset="default (Nuxeo
default fonts)"/>
<background>url(/nuxeo/img/button_disabled.gif) 0 0 repeat-x
#ebeff4</background> <border-color>#ccc #999 #999
#ccc</border-color> <cursor>default</cursor>
<border-width>1px</border-width> </selector>
</style>
We can see that:

• a style that does not apply to an element is name
• inside this style, several HTML attributes/classes are called
• palette preset are called, such as the font attribute
Predefined styles are also a good way of efficiently changing the look of your application because you need to
change the CSS only once!
12.4.1.3. Using a predefined style
Later in the file we notice that the 'user services' fragment takes the default buttons style preset:
 <style

element="page[1]/section[1]/cell[2]/fragment[1]|page[3]/section[1]/cell[2]/fragment[1]"
inherit="default buttons">
Nuxeo EP 5.3 115

Look and feel
It means that the styles defined for the buttons will be applied to the 'user services' fragment (user links and
search in the banner).
12.4.2. Modifying the current theme
12.4.2.1. Styling the theme using the editor
As we explained earlier, layout editing and local styling can be done in the theme editor.
In the editor, click on an element you want to style, click "Edit" in the Menu. Here we chose the RSS/Atom link
button
Access the Style tab.
The existing selectors are on the right in the Properties box, otherwise move the mouse over the preview area
and click on an element to create a CSS selector path.
We choose to change the small font preset to the default one. As you see, the Style picker shows all the palettes
and all the presets are rendered. We remove the background property for the syndication links button and add a
preset background-color, our RSS/Atom button is all changed now:
When you are done with managing your theme you might want to save it to your local copy of Nuxeo. Just go
in the Manage Themes tab, download the custom theme to your computer, then put it in your repository.
Congratulation, you have just customized the Nuxeo EP theme!
12.4.2.2. Modifying the theme by adding/modifying a fragment
You may want to modify an existing fragment to customize your project, let's say you want your compagny
logo instead of Nuxeo EP's and you own corporate links in the footer. We won't create & declare new
fragments (as we saw, fragments and their resources are defined in theme-contrib.xml), we'll use the
default-ones to override Nuxeo EP's, considering you have your own project using Nuxeo EP default as made
in the sample project.
Here are the steps do to so:

• copy your logo (let's call it corporate_logo.gif) to
your.project/src/main/resources/nuxeo.war/img
• copy and paste logo.xhtml and footer.xhtml from

nuxeo/nuxeo-platform/nuxeo-platform-webapp/src/main/resources/nuxeo.war/incl to
your.project/src/main/resources/nuxeo.war/incl so it's overridden when doing your ant.
Tip
This is a general principle for nuxeo.war folder. The contents of the /img/ folder of your app
are the contents of Nuxeo EP's default .../nuxeo.war/img folder. Every specific resource in
your.project/.../nuxeo.war/img come in addition of what is already in default
.../nuxeo.war/img if non-existing there with same filename, or come instead of what is
existing in default .../nuxeo.war/img if same filename.
• edit logo.xhtml that currently contains

<div xmlns:h="http://java.sun.com/jsf/html"
xmlns:ui="http://java.sun.com/jsf/facelets"
xmlns:t="http://myfaces.apache.org/tomahawk"
xmlns:c="http://java.sun.com/jstl/core" class="menu">
Nuxeo EP 5.3 116

Look and feel
<div> <h:form> <h:commandLink

action="#{navigationContext.goHome()}"> <h:graphicImage
value="#{logoHelper.logoURL}" alt="Nuxeo EP 5" width="194"
height="99" /> </h:commandLink> </h:form>
</div> </div>
• change the line <h:graphicImage value="#{logoHelper.logoURL}" alt="Nuxeo EP 5" width="194"

height="99" /> for something like <img src="/nuxeo/img/corporate_logo.gif" alt="My
corporate logo" /> and save your changes
• edit footer.xhtml that currently contains
xmlns:ui="http://java.sun.com/jsf/facelets"
xmlns:f="http://java.sun.com/jsf/core"> <ui:insert
name="footer"> Copyright
<f:verbatim>©</f:verbatim> 2006 Nuxeo.
Visit  <h:outputLink
value="http://www.nuxeo.com"> <h:outputText
value="nuxeo.com" /> </h:outputLink> | Get <h:outputLink
value="http://www.nuxeo.com/en/services/support/">
<h:outputText value="support" /> </h:outputLink> |
Join the  <h:outputLink
value="http://www.nuxeo.org/sections/community">
<h:outputText value="community" /> </h:outputLink>
<br /> <h:form> <h:outputText
value="#{messages['label.selectLocale']}" />
<h:selectOneMenu value="#{localeSelector.localeString}"
styleClass="langSelect"> <f:selectItems
value="#{localeSelector.supportedLocales}"/>
</h:selectOneMenu> <h:commandButton
action="#{localeSelector.select}"
value="#{messages['command.changeLocale']}" class="langSubmit"
/> </h:form> </ui:insert>
</div
• Change from Copyright to <br /> by something like <a href="http://yoursite.com">My Corporate
Site</a>, save your changes
• Do an ant on your projet, rerun your jboss and appreciate the changes...
Congratulation, you have just customized some Nuxeo EP fragments!
12.4.3. Adding a new theme and its pages

We rarely create a theme from scratch. Since the default, popup and dashboards are used in every projetc, we
usually duplicate the default theme and use it as a basis. But let's pretend you want to add a completely new and
custom theme to your project. Here are the steps.
Note
We assume you are familiar to Nuxeo EP way and have read the theme section above!
12.4.3.1. Create a new theme

• Log in as Administrator
• Go to the Manage Theme view
• Click the plus tab, right next to the themes names
• Define a (smart) name. We are currently using "cuztom"
Nuxeo EP 5.3 117

Look and feel
• You have a page called "default", toy with it, add sections and fragments, color the areas so your theme
is not empty. We recommend to add a region fragment with name set as body so the main content is
displayed.
• You can add pages to your theme by clicking the plus tab next to the pages names.
• Go the manage themes tab
• Download your theme
12.4.3.2. Setting the files
You will need a few files/declaration to set your new theme. What we will be overriding in our project is
/nuxeo/nuxeo-platform/nuxeo-platform-webapp-core/src/main/resources/.
Make sure that:

• You copied your downloaded cuztom theme (or duplicate default nuxeo theme, of course) to
/yourproject/.../resources/themes
• META-INF/META-INF.MF calls your OSGI-INF/cuztom-theme-contrib.xml as component
• You have a OSGI-INF/cuztom-theme-contrib.xml with inside:
• The component name set is your project's
• The theme extension point contains your JBoss's theme file
• The theme extension point contains your local theme file (if you plan to work that way)
• The applications extension point set the negociation with your theme as default theme
• If you have specific fragments or palettes, declare them there.
Your new theme is now part of your project and set as default. Your can ant your app and re-run JBoss.
Tip
A good way to name your files is to add your project's name before the current Nuxeo filename.
For an example, theme-contrib.xml may become cuztom-theme-contrib.xml.
12.4.3.3. Working the theme
Your now all set to create your own design with all the tools explained in the sections above:
• Create fragments, declare theme in cuztom-theme-contrib.xml and drop them into your pages using the
theme editor
• Add palettes, declare them, call them in your theme-file.
• Create generic style and make elements inherit of it.
• Modify the structure of the pages with the theme editor and save your changes in your local files
• Add style in your local files and reload the theme using the Manage Theme tab in theme editor.
• Add images and icon into your nuxeo.war folder and call them in the style, in the actions-contrib.xml or
Nuxeo EP 5.3 118

Look and feel
in the fragments.
Have fun and send us your creations!
Nuxeo EP 5.3 119

Chapter 13. Authentication, Users & Groups
Management
13.1. Introduction
In Nuxeo EP, the concept of a user is needed for two main reasons:
• Users are needed for authentication and authorization to work,
• Users have associated information that can be displayed, for instance to display someone's full name or
email address.
An abstraction, the UserManager, centralizes the way a Nuxeo EP application deals with users (and groups of
users). The UserManager is queried by the platform's LoginModule when someone attemps to authenticate
against the framework. It is also queried whenever someone wants the last name or email of a user for instance,
or to get all users having "Bob" as their first name.
13.2. Users and Groups configuration

The data about users (login, password, name, personal information, etc.) and the groups they belong to (simple
members, or any application-related group) are managed through the Directory abstraction. This means that
users can be stored in LDAP or in SQL, and groups can be part of the LDAP tree or stored in a SQL table, but
the application doesn't see the difference as long as the connectors are configured properly.
13.2.1. Schemas
To define a new source of users, you simply define a new directory (or redefine the default one) to use different
connection and schema information. We'll use an example where the pet-name field is added to the user's
schema.
Let's start by defining our new schema in a .xsd file, myuser.xsd:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:nxs="http://www.nuxeo.org/ecm/schemas/user"
targetNamespace="http://www.nuxeo.org/ecm/schemas/user">
<xs:include schemaLocation="base.xsd" />
<xs:element name="username" type="xs:string" />
<xs:element name="password" type="xs:string" />
<xs:element name="email" type="xs:string" />
<xs:element name="firstName" type="xs:string" />
<xs:element name="lastName" type="xs:string" />
<xs:element name="company" type="xs:string" />
<xs:element name="petName" type="xs:string" />

<xs:element name="groups" type="nxs:stringList" />
</xs:schema>
This schema must be registered in an extension point:

<schema name="myuser" src="myuser.xsd" />
</extension>
TODO: FG groups
Nuxeo EP 5.3 120

Authentication, Users & Groups Management
13.2.2. Directories
The user schema can now be used when we define a new directory, MyUserDirectory. A SQL directory is
defined like this:
<extension target="org.nuxeo.ecm.directory.sql.SQLDirectoryFactory" point="directories">
<directory name="MyUserDirectory">
<schema>myuser</schema>
<idField>username</idField>
<passwordField>password</passwordField>
<table>myusers</table>
<dataFile>myusers.csv</dataFile>
<references>
<inverseReference field="groups" directory="groupDirectory"
dualReferenceField="members" />
</references>
</directory>
</extension>
And we can provide a file, myusers.csv, which will be used to populate the table if it is missing:
username, password, firstName, lastName, company, email, petName
bob,bobSecret,Bob,Doe,ACME,[email protected],Lassie
If instead we had used an LDAP directory, the configuration would look like:
<extension target="org.nuxeo.ecm.directory.ldap.LDAPDirectoryFactory" point="servers">

<server name="default">
<ldapUrl>ldap://localhost:389</ldapUrl>
<bindDn>cn=manager,dc=example,dc=com</bindDn>
<bindPassword>secret</bindPassword>
</server>
</extension>
<extension target="org.nuxeo.ecm.directory.ldap.LDAPDirectoryFactory" point="directories">
<directory name="MyUserDirectory">
<schema>myuser</schema>
<server>default</server>
<searchBaseDn>ou=people,dc=example,dc=com</searchBaseDn>
<searchClass>inetOrgPerson</searchClass>
<searchScope>subtree</searchScope>
<fieldMapping name="username">uid</fieldMapping>
<fieldMapping name="password">userPassword</fieldMapping>
<fieldMapping name="email">mail</fieldMapping>
<fieldMapping name="firstName">givenName</fieldMapping>
<fieldMapping name="lastName">sn</fieldMapping>
<fieldMapping name="company">o</fieldMapping>
<references>
</references>
</directory>
</extension>
Detailed configuration on SQL Directories and LDAP Directories can be found in Chapter 19, Directories and
Vocabularies.
13.2.3. UserManager
We can now tell the UserManager that this directory should be the one to use when dealing with users:
<extension target="org.nuxeo.ecm.platform.usermanager.UserService" point="userManager">
<userManager>
Nuxeo EP 5.3 121

<users>
<directory>MyUserDirectory</directory>
<emailField>email</emailField>
<searchFields append="true">
<searchField>username</searchField>
<searchField>firstName</searchField>
<searchField>lastName</searchField>
<searchField>myfield</searchField>
</searchFields>
</users>
</userManager>
</extension>
This configuration also sets the email field, and search fields that have to be queried when searching for users.
It can be completed to set the anonymous user, add virtual users, or set the group directory properties.
<extension target="org.nuxeo.ecm.platform.usermanager.UserService" point="userManager">

<userManager>
<users>
<directory>MyUserDirectory</directory>
<emailField>email</emailField>
<searchFields append="true">
<searchField>username</searchField>
<searchField>firstName</searchField>
<searchField>lastName</searchField>
<searchField>myfield</searchField>
</searchFields>
<listingMode>tabbed</listingMode>
<anonymousUser id="Anonymous">
<property name="firstName">Anonymous</property>
<property name="lastName">User</property>
</anonymousUser>
<virtualUser id="MyCustomAdministrator" searchable="false">
<password>secret</password>
<property name="firstName">My Custom</property>
<property name="lastName">Administrator</property>
<group>administrators</group>
</virtualUser>
<virtualUser id="MyCustomMember" searchable="false">
<password>secret</password>
<property name="firstName">My Custom</property>
<property name="lastName">Member</property>
<group>members</group>
<group>othergroup</group>
<propertyList name="listprop">
<value>item1</value>
<value>item2</value>
</propertyList>
</virtualUser>
<virtualUser id="ExistingVirtualUser" remove="true" />
</users>
<defaultAdministratorId>Administrator</defaultAdministratorId>

<administratorsGroup>myAdmins</administratorsGroup>
<administratorsGroup>myOtherAdmins</administratorsGroup>
<disableDefaultAdministratorsGroup>
false
</disableDefaultAdministratorsGroup>

<userSortField>lastName</userSortField>
<userPasswordPattern>^[a-zA-Z0-9]{5,}$</userPasswordPattern>
<groups>
<directory>somegroupdir</directory>
<membersField>members</membersField>
<subGroupsField>subgroups</subGroupsField>
<parentGroupsField>parentgroup</parentGroupsField>
<listingMode>search_only</listingMode>
</groups>
<defaultGroup>members</defaultGroup>
<groupSortField>groupname</groupSortField>
</userManager>
</extension>
The anonymous user represents a special kind of virtual user, used to represent users that do not need to log in
the application. This feature is used in conjunction with the anonymous plugin (see next chapter).
Virtual users can be added for authentication. Properties are used to create the appropriate model as if user was
Nuxeo EP 5.3 122

retrieved from the user directory. This is a convenient way to add custom users to the application when the user
directory (using LDAP for instance) cannot be modified. Virtual users with the "administrators" group will
have the same rights than the default administrator.
The default administrator id can be set either to an existing or virtual user. This user will be virtually member
of all the groups declared as administrators (by default, the group named "administrators" is used).
Since 5.3.1, new administrators groups can be added using the "administratorsGroup" tag. Several groups can
be defined, adding as many tags as needed. The default group named "administrators" can be disabled by
setting the "disableDefaultAdministratorsGroup" to "true" (defaults to false): only new defined administrators
groups will then be taken into account. Note that disabling this default group should be done after setting up
custom rights in the repository, as this group is usually defined as the group of users who have all permissions
at the root of the repository. Administrators groups will have access to vocabulary management, theme editor,...
They are also added local rights when blocking permissions to avoid lockups.
The group directory can also be configured to define the groups hierarchy and the contained users. This
configuration has to match the user directory inverse references.
Every authenticated user will be placed in the configured default group. This group does not need to exist in the
backing group directory, nor does any other group listed in virtual users configuration.
13.2.4. User Management Interface

Since 5.2.GA, The default users and groups management pages use some layouts for display. If you're using
custom schemas and would like to display your new fields, or would like to change the default display, you can
redefine layouts names "user" and "group" by contributing new layouts with this name. See chapter Chapter 8,
Layouts for more information about layouts configuration.
Do not forget to put "<require>org.nuxeo.ecm.platform.forms.layouts.webapp</require>" on your layout

contribution to ensure default layouts are overridden.
Example 13.1. Sample layout contribution for users and groups management.
<component name="org.nuxeo.ecm.platform.forms.layouts.usersAndGroups">
point="layouts">
<layout name="user">
<templates>
</templates>
<rows>
<row>
<widget>username</widget>
</row>
<row>
<widget>firstname</widget>
</row>
<row>
<widget>lastname</widget>
</row>
<row>
<widget>company</widget>
</row>
<row>
<widget>email</widget>
</row>
<row>
<widget>firstPassword</widget>
</row>
<row>
<widget>secondPassword</widget>
</row>
<row>
<widget>passwordMatcher</widget>
</row>
<row>
<widget>groups</widget>
</row>
</rows>
Nuxeo EP 5.3 123

<widget name="username" type="text">

<labels>
<label mode="any">username</label>
</labels>
<fields>
<field schema="user">username</field>
</fields>
<widgetModes>
<mode value="editPassword">hidden</mode>
<mode value="any">view</mode>
</widgetModes>
<property name="validator">
#{userManagerActions.validateUserName}
</property>
</properties>
</widget>
<widget name="firstname" type="text">
<labels>
<label mode="any">firstName</label>
</labels>
<fields>
<field schema="user">firstName</field>
</fields>
<widgetModes>
</widgetModes>
</properties>
</widget>
<widget name="lastname" type="text">
<labels>
<label mode="any">lastName</label>
</labels>
<fields>
<field schema="user">lastName</field>
</fields>
<widgetModes>
</widgetModes>
</properties>
</widget>
<widget name="company" type="text">
<labels>
<label mode="any">company</label>
</labels>
<fields>
<field schema="user">company</field>
</fields>
<widgetModes>
</widgetModes>
</properties>
</widget>
<labels>
<label mode="any">email</label>
</labels>
<fields>
<field schema="user">email</field>
</fields>
<widgetModes>
</widgetModes>
</properties>
</widget>
<widget name="firstPassword" type="secret">
<labels>
<label mode="any">password</label>
</labels>
<fields>
<field schema="user">password</field>
</fields>
<widgetModes>
<mode value="editPassword">edit</mode>
Nuxeo EP 5.3 124

<mode value="any">hidden</mode>
</widgetModes>
</properties>
</widget>
<widget name="secondPassword" type="secret">
<labels>
<label mode="any">password.verify</label>
</labels>
<widgetModes>
</widgetModes>
</properties>
</widget>
<widget name="passwordMatcher" type="template">
<labels>
</labels>
<widgetModes>
</widgetModes>

/widgets/user_password_validation_widget_template.xhtml
</property>
</properties>
</widget>
<widget name="groups" type="template">
<labels>
<label mode="any">label.userManager.userGroups</label>
</labels>
<fields>
<field schema="user">groups</field>
</fields>
<widgetModes>
<mode value="edit">
#{nxu:test(currentUser.administrator, 'edit', 'view')}
</mode>
</widgetModes>
/widgets/user_suggestion_widget_template.xhtml
</property>
<property name="userSuggestionSearchType">GROUP_TYPE</property>
</properties>
</widget>
</layout>
<layout name="group">
<templates>
</templates>
<rows>
<row>
<widget>groupname</widget>
</row>
<row>
<widget>members</widget>
</row>
<row>
<widget>subgroups</widget>
</row>
</rows>
<widget name="groupname" type="text">
<labels>
<label mode="any">label.groupManager.groupName</label>
</labels>
<fields>
<field schema="group">groupname</field>
</fields>
<widgetModes>
</widgetModes>
</properties>
Nuxeo EP 5.3 125

</widget>
<widget name="members" type="template">
<labels>
<label mode="any">label.groupManager.userMembers</label>
</labels>
<fields>
<field schema="group">members</field>
</fields>
</property>
<property name="userSuggestionSearchType">USER_TYPE</property>
</properties>
</widget>
<widget name="subgroups" type="template">
<labels>
<label mode="any">label.groupManager.groupMembers</label>
</labels>
<fields>
<field schema="group">subGroups</field>
</fields>
</property>
<property name="userSuggestionSearchType">GROUP_TYPE</property>
</properties>
</widget>
</layout>
</extension>
</component>
Before 5.2.GA, you need to redefine the deprecated layout configuration of two standard document types, User
and UserCreate (which are used in the default user management screens and backing beans) to add our new
field:
<type id="User" coretype="User">
<label>User</label>
<icon>/icons/user.gif</icon>
<default-view>view_user</default-view>
<layout>
<widget schemaname="myuser" fieldname="username"
jsfcomponent="h:inputTextReadOnly" />
<widget schemaname="myuser" fieldname="firstName"
jsfcomponent="h:inputText" />
<widget schemaname="myuser" fieldname="lastName"
<widget schemaname="myuser" fieldname="email"
<widget schemaname="myuser" fieldname="company"
<widget schemaname="myuser" fieldname="petName"
</layout>
</type>
<type id="UserCreate" coretype="UserCreate">
<label>UserCreate</label>
<icon>/icons/user.gif</icon>
<default-view>create_user</default-view>
<layout>
<widget schemaname="myuser" fieldname="username"
jsfcomponent="h:inputText" required="true" />
<widget schemaname="myuser" fieldname="password"
jsfcomponent="h:inputSecret" required="true" />
<widget schemaname="myuser" fieldname="firstName"
<widget schemaname="myuser" fieldname="lastName"
<widget schemaname="myuser" fieldname="email"
jsfcomponent="h:inputText" required="true" />
<widget schemaname="myuser" fieldname="company"
<widget schemaname="myuser" fieldname="petName"
</layout>
</type>
Nuxeo EP 5.3 126

</extension>
13.3. Authentication
13.3.1. Authentication Framework Overview

Nuxeo Authentication is based on the JAAS standard.
Authentication infrastructure is based on 2 main components :

• a JAAS Login Module: NuxeoLoginModule
• a Web Filter: NuxeoAuthenticationFilter
Users and groups are managed via the UserManagerService that handles the indirection to users and groups
directories (SQL or LDAP).
Nuxeo authentication framework is pluggable so that you can contribute new plugin and don't have to rewrite
and reconfigure a complete JAAS infrastructure.
13.3.2. Pluggable JAAS Login Module

NuxeoLoginModule is a JAAS LoginModule. It is responsible for handling all login call within Nuxeo's
security domains:
• nuxeo-ecm: for the service stack and the core
• nuxeo-ecm-web: for the web application on the top of the service stack
On JBoss application server, the JBoss Client Login module is used to propagate security between the web part
and the service stack.
Here is the default JBoss security configuration:

<domain name="nuxeo-ecm-web">
<login-module code = "org.nuxeo.ecm.platform.login.NuxeoLoginModule"
flag = "required">
<option name="principalClassName">org.nuxeo.ecm.platform.login.NuxeoPrincipal</option>
<option name="useUserIdentificationInfoCB">true</option>
</login-module>
<login-module code="org.jboss.security.ClientLoginModule" flag="required">
<option name="password-stacking">true</option>
<option name="restore-login-identity">true</option>
<option name="multi-threaded">true</option>
</login-module>
</domain>
<domain name="nuxeo-ecm">
<login-module code = "org.nuxeo.ecm.platform.login.NuxeoLoginModule" flag = "required">
<option name="principalClassName">org.nuxeo.ecm.platform.login.NuxeoPrincipal</option>
<option name="useUserIdentificationInfoCB">true</option>
</login-module>
</domain>
As shown by this configuration, the principals returned by NuxeoLoginModule is

org.nuxeo.ecm.platform.login.NuxeoPrincipal.
Each protected service declares the nuxeo-ecm security domain

<jboss>
<enterprise-beans>
<session>
<ejb-name>DocumentManagerBean</ejb-name>
<security-domain>nuxeo-ecm</security-domain>
</session>
</enterprise-beans>
</jboss>
Nuxeo EP 5.3 127

13.3.2.1. NuxeoLoginModule
NuxeoLoginModule mainly handles 2 tasks:

• login user
This means extract information from the CallBack stack and validate identity.
NuxeoLoginModule supports several types of CallBacks (including Nuxeo specific CallBack) and uses a
plugin system to be able to validate user identity in a pluggable way.
• Principal creation
For that NuxeoLoginModule uses Nuxeo UserManager service that does the indirection to the
users/groups directories.
When used in conjunction with UserIdentificationInfoCallback (Nuxeo custom CallBack system), the
LoginModule will choose the right LoginPlugin according to the CallBack information.
13.3.2.2. NuxeoLoginModule Plugins
Because validating User identity can be more complex that just checking login/password, NuxeoLoginModule
exposes an extension point to contribute new LoginPlugins
Each LoginPlugin has to implement the org.nuxeo.ecm.platform.login.LoginPlugin interface.
Main method is:

String validatedUserIdentity(UserIdentificationInfo userIdent)
that is used to validate the UserIdentificationInfo.
Typically, default implementation will extract Login/Password from UserIdentificationInfo and call the
checkUsernamePassword against the UserManager that will validate this information against the users
directory.
Other plugins can use other informations carried by UserIdentificationInfo (token, ticket ...) to validate the
identity against an external SSO system. The UserIdentificationInfo also carries the LoginModule plugin name
that must be used to validate identity. Even if technically, a lot of SSO system could be implemented using this
plugin system, most SSO implementations have be moved to the Authentication Plugin at the Web Filter level,
because they need a http dialog.
For now, the NuxeoLoginModule has only two way to handle validateUserIdentity:
• default
Uses UserManager
• Trusted_LM
This plugin assumes the user identity has already been validated by the authentication filter, so the
validatedUserIdentity will always return true. Using this LoginModule plugin, a user will be logged if
the user exists in the UserManager. This plugin is used for most SSO system in conjunction with a
Authentication plugin that will actually do the work of validating password or token.
13.3.2.3. Remote Login to the EJB layer
The Login system can be used via Remote EJB calls.
You can login as System user:

LoginContext lc = Framework.login();
Nuxeo EP 5.3 128

// do some service calls

lc.logout();
You can login using user / password:

LoginContext lc = Framework.login(userName, password);
// do some service calls
lc.logout();
You can also call the login method and pass it directly a CallBackHandler. This can be used in conjunction with
org.nuxeo.ecm.platform.api.login.UserIdentificationInfoCallbackHandler.
13.3.3. Pluggable Web Authentication Filter

The Web Authentication filter is responsible for:
• guarding access to web resources
The filter can be parameterized to guard urls with a given pattern
• finding the right plugin to get user identification information
This can be getting a userName/Password, getting a token in a cookie or a header, redirecting user to
another authentication server.
• create the LoginContext
This means creating the needed callBacks and call the JAAS Login
• store and reestablish login context
In order to avoid recreating a login context for each request, the LoginContext is cached.
13.3.3.1. NuxeoAuthenticationFilter
The NuxeoAuthenticationFilter is one of the top level filter in Nuxeo Web Filters stack.
For each request it will try to find a existing LoginContext and create a RequestWrapper that will carry the
NuxeoPrincipal.
If no existing LoginContext is found it will try to prompt the client for authentication information and will
establish the login context.
If order to execute the task of prompting the client and retrieving UserIndetificationInfo, the filter will rely on a
set of configured plugins.
Each plugin must:

• Implement org.nuxeo.ecm.platform.ui.web.auth.interfaces.NuxeoAuthenticationPlugin
The two main methods are:
Boolean handleLoginPrompt(HttpServletRequest httpRequest,HttpServletResponse httpResponse, String baseURL);

UserIdentificationInfo handleRetrieveIdentity(HttpServletRequest httpRequest, HttpServletResponse httpResponse);
• Define the LoginModule plugin to use if needed
Typically, SSO AuthenticationPlugin will do all the work and will use the Trusted_LM LoginModule
Plugin.
Nuxeo EP 5.3 129

• Define if stating URL must be saved
AuthenticationPlugins that uses HTTP redirect in order to do the login prompt will let the Filter store the
first accessed URL in order to cleanly redirect the user to the page he asked after the authentication is
successful.
Additionnaly, AuthenticationPlugin can also implement the

org.nuxeo.ecm.platform.ui.web.auth.interfaces.NuxeoAuthenticationPluginLogoutExtension
interface if a specific processing must be done when logging out.
Here is a sample XML descriptor for registering an AuthenticationPlugin:
<component name="org.nuxeo.ecm.platform.ui.web.auth.defaultConfig">
<extension
point="authenticators">
<authenticationPlugin name="FORM_AUTH" enabled="true"
class="org.nuxeo.ecm.platform.ui.web.auth.plugins.FormAuthenticator">
<needStartingURLSaving>true</needStartingURLSaving>
<parameters>
<parameter name="LoginPage">login.jsp</parameter>
<parameter name="UsernameKey">user_name</parameter>
<parameter name="PasswordKey">user_password</parameter>
</parameters>
</authenticationPlugin>
</extension>
</component>
As you can see in the above example, the descriptor contains the parameters tag that can be used to embed
arbitrary additional configuration that will be specific to a given AuthenticationPlugin. In the above example, it
is used to define the field names and the JSP file used for form based authentication.
NuxeoAuthenticationFilter supports several authentication system. This is, for example, useful for having users
using Form based authentication and having RSS clients using Basic Authentication. Because of that
AuthenticationPlugin must be ordered. For that purpose, NuxeoAuthenticationFilter uses a dedicated extension
point that let you define the AuthenticationChain.
<component name="Anonymous.auth.activation">
<require>org.nuxeo.ecm.platform.ui.web.auth.defaultConfig</require>
<extension
point="chain">
<authenticationChain>
<plugins>
<plugin>BASIC_AUTH</plugin>
<plugin>ANONYMOUS_AUTH</plugin>
<plugin>FORM_AUTH</plugin>
</plugins>
</authenticationChain>
</extension>
</component>
The NuxeoAuthenticationFilter will use this chain to trigger the login prompt. When authentication is needed,
the Filter will call, in a first round, the handleRetrieveIdentity method on all the plugins in the order of the
authentication chain and then, in a second round, the handleLoginPrompt method in the same order on all the
plugins if the authentication could not be achieved in the first round. The aim is to have as much automatic
authentications as possible, that's why all the manual authentications (those which need a prompt) are done in a
second round.
Some authentication plugins may choose to trigger or not the LoginPrompt depending on the situation. For
example: the BasicAuthentication plugin generates the login prompt (in the case of the BasicAuthentication
plugin the login prompt is an HTTP basic authentication which takes the form of a popup) only for specific
URLs used for RSS feeds or restlet calls. This allows the platform to be easily called by Restlets and RSS
clients without bothering browser clients who are presented with web forms to authenticate.
13.3.3.2. Built-in Authentication Plugins
Nuxeo EP 5.3 130

NuxeoAuthenticationFilter comes with two built-in authentication plugins:

• FORM_AUTH: Form based Authentication
This is a standard form based authentication. Current implementation let you configure the name of the
Login and Password fields, and the name of the page used to display the login page
• BASIC_AUTH: Basic HTTP Authentication
This plugin supports standard HTTP Basic Authentication. By default, this plugin only generates the
authentication prompt on configured URLs.
There are also additional components that provides other Authentication plugins (see below).
13.3.3.3. Additional Authentication Plugins
Nuxeo provides a set of other authentication plugins that are not installed by default with the standard Nuxeo
EP setup. These plugins can be downloaded and installed separately.
13.3.3.3.1. CAS2 Authentication

This plugin implements a client for CAS SSO system (Central Authentication System). It can be configured to
use a CAS proxy. It has been tested and reported to work with CAS V2.
It's easy to test this plugin by installing the JA-SIG Central Authentication Service Open Source CAS server.
To install this authentication plugin, you need to:

• be sure that there is a CAS server already setup and running
• download the nuxeo-platform-login-cas2 plugin
• put it in $JBOSS_HOME/server/default/deploy/nuxeo.ear/plugins and restart the server
• configure the CAS2 descriptor
• put CAS2 plugin into the authentication chain
In order to configure CAS2 Auth, you need to create an XML configuration file into
$JBOSS_HOME/server/default/deploy/nuxeo.ear/config
Here is a sample file named CAS2-config.xml.

<component name="MyAPP.Cas2SSO">
<require>org.nuxeo.ecm.platform.login.Cas2SSO</require>

<extension
<authenticationPlugin
name="CAS2_AUTH">
<loginModulePlugin>Trusting_LM</loginModulePlugin>
<parameters>
<parameter name="ticketKey">ticket</parameter>
<parameter name="appURL">http://127.0.0.1:8080/nuxeo/nxstartup.faces</parameter>
<parameter name="serviceLoginURL">http://127.0.0.1:8080/cas/login</parameter>
<parameter name="serviceValidateURL">http://127.0.0.1:8080/cas/serviceValidate</parameter>
<parameter name="serviceKey">service</parameter>
<parameter name="logoutURL">http://127.0.0.1:8080/cas/logout</parameter>
</parameters>
</extension>

<extension
point="chain">
<plugins>
Nuxeo EP 5.3 131

<plugin>CAS2_AUTH</plugin>
</plugins>
</extension>
</component>
Tip: If while authenticating on the CAS server you get in the logs the following exception, it simply means that
the user JOEUSER does not exist in the Nuxeo directory and does not mean that the CAS process is not
working.
ERROR [org.nuxeo.ecm.platform.login.NuxeoLoginModule] createIdentity failed
javax.security.auth.login.LoginException: principal JOEUSER does not exist
at org.nuxeo.ecm.platform.login.NuxeoLoginModule.createIdentity(NuxeoLoginModule.java:304)
at org.nuxeo.ecm.platform.login.NuxeoLoginModule.validateUserIdentity(NuxeoLoginModule.java:362)
at org.nuxeo.ecm.platform.login.NuxeoLoginModule.getPrincipal(NuxeoLoginModule.java:216)
at org.nuxeo.ecm.platform.login.NuxeoLoginModule.login(NuxeoLoginModule.java:271)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:585)
at javax.security.auth.login.LoginContext.invoke(LoginContext.java:769)
at javax.security.auth.login.LoginContext.access$000(LoginContext.java:186)
at javax.security.auth.login.LoginContext$4.run(LoginContext.java:683)
at java.security.AccessController.doPrivileged(Native Method)
at javax.security.auth.login.LoginContext.invokePriv(LoginContext.java:680)
at javax.security.auth.login.LoginContext.login(LoginContext.java:579)
at org.nuxeo.ecm.platform.ui.web.auth.NuxeoAuthenticationFilter.doAuthenticate(NuxeoAuthenticationFilter
13.3.3.3.2. PROXY_AUTH: Proxy based Authentication

This plugin assumes Nuxeo is behind a authenticating reverse proxy that transmit user identity using HTTP
headers. This modules has be used on projects that uses a apache reverse proxy using client certificates to
authenticate. SSO system (Central Authentication System V2):
To install this authentication plugin, you need to:

• download the nuxeo-platform-login-mod_sso plugin
• configure the plugin via an XML descriptor
• put the plugin into the authentication chain
In order to configure this plugin, you need to create an XML configuration file into
Here is a sample file named proxy-auth-config.xml.

<component name="MyAPP.Mod_sso">
<require>org.nuxeo.ecm.platform.login.Proxy</require>
<extension
name="PROXY_AUTH">
<parameters>

<parameter name="ssoHeaderName">remote_user</parameter>
</parameters>
</extension>

<extension
point="chain">
<plugins>

<plugin>PROXY_AUTH</plugin>
Nuxeo EP 5.3 132

</plugins>
</extension>
</component>
13.3.3.3.3. NTLM_AUTH: NTLM and IE challenge/response authentication

This plugin uses JCIFS to handle NTLM authentication.
This plugging was partially contributed by Nuxeo EP users and has been reported to work by several users.
If you have troubles with latest version of IE on POST requests, please see JCIFS instructions on that
(http://jcifs.samba.org/src/docs/ntlmhttpauth.html#post).
To install this authentication plugin, you need to :

• download the nuxeo-platform-login-ntlm plugin
Here is a sample file named ntlm-auth-config.xml.

<component name="MyAPP.NTLM">
<require>org.nuxeo.ecm.platform.login.NTLM</require>
<extension
name="NTLM_AUTH">
<parameters>

</parameters>
</extension>

<extension
point="chain">
<plugins>
<plugin>NTLM_AUTH</plugin>
</plugins>
</extension>
</component>
13.3.3.3.4. PORTAL_AUTH: SSO implementation for portal clients

This plugin provides a way to handle identity propagation between an external application and Nuxeo. It was
coded in order to propagate user identify between a JSR168 portal and a Nuxeo server. See the
Nuxeo-Http-client-library for more information.

• download the nuxeo-platform-login-portal-sso plugin
Nuxeo EP 5.3 133

Here is a sample file named portal-auth-config.xml.

<component name="MyAPP.postal_sso">
<require>org.nuxeo.ecm.platform.login.Portal</require>
<extension
name="PORTAL_AUTH">
<parameters>

<parameter name="secret">nuxeo5secretkey</parameter>
<parameter name="maxAge">3600</parameter>
</parameters>
</extension>

<extension
point="chain">
<plugins>

<plugin>PORTAL_AUTH</plugin>
</plugins>
</extension>
</component>
13.3.3.3.5. ANONYMOUS_AUTH: Anonymous authentication plugin

This plugin provides anonymous authentication. Users are automatically logged as a configurable Anonymous
user. This modules also includes additional actions (to be able to login when already logged as Anonymous)
and a dedicated Exception handling (to automatically redirect Anonymous users to login screen after a security
error).

• download the nuxeo-platform-login-anonymous plugin
• configure the plugin via an XML descriptor (define who the anonymous user will be)
Here is a sample file named anonymous-auth-config.xml.

<component name="org.nuxeo.ecm.platform.login.anonymous.config">

<require>org.nuxeo.ecm.platform.login.anonymous</require>

Nuxeo EP 5.3 134

<extension target="org.nuxeo.ecm.platform.usermanager.UserService"
point="userManager">
<userManager>
<users>
<anonymousUser id="Guest">
<property name="firstName">Guest</property>
<property name="lastName">User</property>
</anonymousUser>
</users>
</userManager>
</extension>

<extension
point="chain">
<plugins>
<plugin>ANONYMOUS_AUTH</plugin>
</plugins>
</extension>
</component>
Nuxeo EP 5.3 135

Chapter 14. Security Policy Service
14.1. Introduction
The Security Service provides an extension point to plug custom security policies that do not rely on the
document security settings. For instance, it can be used to define permissions according to the document
metadata, or to the logger user information.
14.2. Architecture
Policies are set in two places:
• in the core where custom checks of permission can be performed before resolving the document security
using its ACP.
• in the search where the query can be patched with custom constraints before processing it.
Policies are checked in the order given as a parameter when registering them.
On the core side, they are used when checking permissions: they can grant or deny access, in case following
policies - as well as the default security check relying on the ACP set on the document - will be ignored. They
can also return an undefined access, in case following policy checks will continue.
When defining a custom policy for the Read permission, queries to the search service have to be adapted to
have the same constraints: otherwise some queries will not return documents that the user can see, or will return
documents that the user cannot see. Search policies are used when performing any search.
These policies are set on different services and follow different interfaces. When deploying on multi machines
environment, where search and core may be hosted on different machines, the core and search policies will
have to be deployed on the corresponding machine.
14.3. Policy contributions
14.3.1. Core policy contribution

To register a core security policy, you need to write a contribution specifying the class name of your
implementation.
Example 14.1. Sample core security policy contribution
<component name="org.nuxeo.ecm.core.securityPolicy.accessLevelContrib">
<extension target="org.nuxeo.ecm.core.security.SecurityService"
point="policies">
<policy name="accessLevel"
class="org.nuxeo.ecm.core.security.AccessLevelSecurityPolicy" order="0" />
</extension>
</component>
Here is a sample contribution: core policies have to follow the org.nuxeo.ecm.core.security.SecurityPolicy

interface.
Nuxeo EP 5.3 136

Security Policy Service
public class AccessLevelSecurityPolicy extends AbstractSecurityPolicy {

public Access checkPermission(Document doc, ACP mergedAcp,
Principal principal, String permission,
String[] resolvedPermissions, String[] additionalPrincipals) {
Access access = Access.UNKNOWN;
try {
if (principal instanceof NuxeoPrincipal) {
DocumentModel userModel = ((NuxeoPrincipal) principal).getModel();
if (userModel != null) {
Long accessLevel = (Long) userModel.getPropertyValue("user:accessLevel");
Long securityLevel = (Long) doc.getPropertyValue("sp:securityLevel");
if (accessLevel < securityLevel) {
access = Access.DENY;
}
}
}
} catch (Exception e) {
}
return access;
}
}
Here a specific check is done on all documents, regardless of the permission being checked. A property on the
document (securityLevel) is checked against a property set on the user model (accessLevel).
Note that the "unknown" access is returned when the policy should not interfere with the standard security
check.
14.3.2. Search policy contribution

The search policy can be registered in the same way than a cor security policy. Search policies have to follow
the org.nuxeo.ecm.core.security.SecurityPolicy interface, and implement methods that will return query
transformers.
Here is a sample contribution:

public class NoFileSecurityPolicy extends AbstractSearchPolicy {
public Access checkPermission(Document doc, ACP mergedAcp,
Principal principal, String permission,
String[] resolvedPermissions, String[] additionalPrincipals) {
if (doc.getType().getName().equals("File")) {
return Access.DENY;
}
return Access.UNKNOWN;
}
@Override
public boolean isExpressibleInQuery() {
return true;
}
/**
* Transformer that adds {@code AND ecm:primaryType <> 'File'} to the query.
*/
public static class NoFileTransformer implements Transformer {
public static final Predicate NO_FILE = new Predicate(new Reference(
"ecm:primaryType"), Operator.NOTEQ, new StringLiteral("File"));
public SQLQuery transform(SQLQuery query) {
WhereClause where = query.where;
Predicate predicate;
if (where == null || where.predicate == null) {
predicate = NO_FILE;
} else {
predicate = new Predicate(NO_FILE, Operator.AND,
where.predicate);
}
SQLQuery newQuery = new SQLQuery(query.select, query.from,
new WhereClause(predicate), query.groupBy, query.having,
query.orderBy, query.limit, query.offset);
return newQuery;
}
}
public static final Transformer NO_FILE_TRANSFORMER = new NoFileTransformer();
@Override
public Transformer getQueryTransformer() {
return NO_FILE_TRANSFORMER;
}
Nuxeo EP 5.3 137

Security Policy Service
As a check is done on the core side regardless of the permission, it will also apply for the "Read" permission
which is checked when navigating to a document. Without this policy, searches would return documents that
the user may not be able to see, and would generate a security exception when the user clicks on the document
link.
The same checks here are performed on the core and added as constraint to the search query.
For additional information about NXQL queries, please refer to the Section 11.3, “Programmatic Searching”
section.
Nuxeo EP 5.3 138

Chapter 15. Workflow & jBPM
15.1. Workflow in Nuxeo 5.1
15.1.1. Deploying process definitions

A workflow definition is designed for a given workflow engine backend and not for the Nuxeo workflow
service itself. Nuxeo workflow doesn't specify a new process definition language. Thus it has no Nuxeo
specificities speaking of format or process definition language. For instance, if you use jBPM as a backend with
Nuxeo 5 then the workflow definition should be a standard jpdl file that you may have designed using your
favorite editor or still if you are using Shark as a backend then the workflow definition will be a standard
WFMC process definition.
Once your workflow definition has been designed and is ready you can deploy it in Nuxeo workflow. Of
course, the target workflow engine backend plugin should be deployed and registered against the workflow
service.
15.1.1.1. Using extension points
The Nuxeo workflow service provides a dedicated extension point for workflow definition deployment. The
extension point is called definition.
In this case, the workflow definition will be deployed at application server deployment time (For now, this is
the case when the application server is starting up since hot deployment is not yet possible using Nuxeo
Runtime at the time of writing this document).It means this way of deploying workflow definition is not
suitable for all cases. See the next subsections for other ways of deploying workflow definitions.
Below is an example of a jPDL workflow definition contribution for the jBPM backend. This XML fragment
would be defined in a contribution registered as a component in a bundle:
<component name="com.company.workflow.sample.contributions">
<extension target="org.nuxeo.ecm.platform.workflow.service.WorkflowService"
point="definition">
<definition>
<engineName>jbpm</engineName>
<mimetype>text/xml</mimetype>
<definitionPath>workflows/process_definition.xml</definitionPath>
</definition>
</extension>
</component>
• engineName: name specified for the target backend at workflow service registration time (see workflow
service backend extension point)
• mimetype: mimetype of the workflow definition. This is especially interesting in case of the format is
binary. (serialization issue at deployment time)
• definitionPath: bundle relative path of the workflow definition to deploy.
In this situation here is how would look the tree:
com.company.workflow /
META-INF /
workflows /
process_definition.xml
MANIFEST.MF
OSGI-INF /
workflow-definitions-contrib.xml
Nuxeo EP 5.3 139

Workflow & jBPM
15.2. Workflow from Nuxeo 5.2: the jBPM Service
15.2.1. Introduction
Nuxeo jBPM Service is a task and work flow management service based on jBPM. One can use this service
without knowledge of jBPM, but for any advance use a good knowledge is necessary, please refer to jBPM
documentation .
The service provides:

• an easy way to deploy process definitions (see Section 15.2.2.5, “deployer extension point”)
• 2 abstract classes to test process definition and the jBPM service using those definitions (see
Section 15.2.5.4, “How to test a process ?”)
• A set of convention to facilitate manipulation of documents (see Section 15.2.3, “Document

management”)
• Helpers class to create ActionHandler, AssignmentHandler, DecisionHandler and TaskControllerHandler

that interact with repository, user manager and documents. (see Section 15.2.3, “Document
management”)
• A set of hibernate queries that optimize queries on documents. (see Section 15.2.5.1, “How to optimize
jBPM service ?”)
• 2 default workflows for document validation. (see Section 15.2.4, “Default processes”)
15.2.2. jBPM service configuration
15.2.2.1. Event and Notification
jBPM can be used for different use cases. The default Nuxeo contributions uses it as a simple workflow
management on a single document. You could use it for complex BPM, SOA orchestration or pageflow
management. All those different uses make it impossible to send meaningful event at the service level.
So we let the responsibility of sending event to the user of the jBPM service. It is the responsibility of the user
of the service to send event .
For example, the default workflow will send a workflowStart event when the user presses the 'Start Workflow'
button. (However, the jBPM process has already started and 2 tasks have already been completed at this stage).
The default workflow also sends event (workflowTaskAssign) when a task is assigned to a pooled actors (This
is not considered a task assignment for jBPM) and send a mail to each pooled actor.
If you use jBPM for workflow management on documents, we recommend that you use the event named in
JbpmEventNames. You can check the default workflow, the TaskNotificationHandler or the JbpmActionsBean
for code that sends event.
15.2.2.2. jBPM Job Executor
jBPM uses a JobExecutor to run asynchronous node and timer. The default Nuxeo configuration does not use
nor start a JobExecutor. However, from version 5.3.1, it comes bundle with a JobExecutor. To start the
JobExecutor when Nuxeo starts, you need to set the property "org.nuxeo.ecm.platform.jbpm.startJobExecutor"
to true in any of the *.properties in nuxeo.ear/config.
They are 2 differences between the default jBPM JobExecutor and Nuxeo's JobExecutor. Firstly, Nuxeo's uses
a transaction to run jobs. Secondly, Nuxeo's notifies the event service so asynchronous event thrown from a job
will be handle correctly.
Nuxeo EP 5.3 140

Workflow & jBPM
15.2.2.3. configurationPath and activeConfiguration extension points
Nuxeo configures jBPM in 2 steps . First, it creates named configurations using configurationPath extension
point, such as:
<extension
target="org.nuxeo.ecm.platform.jbpm.core.JbpmService"
point="configurationPath">
<configuration name="prod" path="config/jbpm.cfg.xml" />
</extension>
Finally, it gives the configuration to use:

<component
name="org.nuxeo.ecm.platform.jbpm.core.ActiveConfiguration">
<extension target="org.nuxeo.ecm.platform.jbpm.core.JbpmService"
point="activeConfiguration">
<configuration name="prod" />
</extension>
</component>
From version 5.3, the default activeConfiguration is 'runtime'. This is not the name of a configuration that was
contributed. It is a keyword meaning that the configuration name will be chosen at runtime. The workflow
service comes bundle with different configuration (jboss, jetty ...).
'runtime' configuration name.

From version 5.3, the runtime configuration name is a keyword for an activeConfiguration and
should not be used as a configuration name.
If you want to use a different configuration you just need to overwrite the
org.nuxeo.ecm.platform.jbpm.core.ActiveConfiguration component.
The default configuration uses a transactional persistent service. It also adds to the default hibernate
configuration a nuxeo.hibernate.queries.hbm.xml file with nuxeo's specific queries.
Production settings
The default hibernate configuration, referenced in jbpm.cfg.xml, is not for production. For
production, you should comment out the 'hibernate.hbm2ddl' property. You also should ask your
DBA to finalize your database schema for your target database (Derby should not be used in
production).
15.2.2.4. processDefinition extension point
To contribute a new process definition, contribute to the processDefinition extension point by giving the
definition path relative to the root of the package and the name of the deployer.
The default contribution is:

point="processDefinition">
<processDefinition path="process/parallel-review.xml" deployer="nuxeoProperties" />
<processDefinition path="process/validation-review.xml" deployer="nuxeoProperties" />
</extension>
15.2.2.5. deployer extension point
jBPM needs to keep all process definition versions in persistent storage, so a process may finish with the same
definition it started with. When Nuxeo starts, the jBPM service needs to know if a process definition is to be
deployed as a new version. The Deployer is responsible for process definition deployment, you choose how
Nuxeo EP 5.3 141

Workflow & jBPM
processes are deployed by choosing a Deployer.
The service comes with 3 Deployers:

ifChanged
This deployer is depreacated and shouldn't be used (see https://jira.nuxeo.org/browse/NXP-4650
nuxeoProperties
This deployer will deploy a process definition unless the property
'org.nuxeo.ecm.platform.jbpm.deployProcessDefinition' is set to false in nuxeo.properties. It is
recommended to use it, and set the property to false after the process have been deployed (when a server is
restarted but after all process definition have been used once).
never
This deployer never deploys a process definition.
always
This deployer always deploys a process definition.
You can contribute to new Deployer by contributing to the deployer extension-point. The contributed class
needs to implement the ProcessDefinitionDeployer interface. It can also extend the
AbstractProcessDefinitionDeployer that provides some helpers method.

point="deployer">
<deployer name="always"
class="org.nuxeo.ecm.platform.jbpm.core.deployer.AlwaysDeployer" />
<deployer name="never"
class="org.nuxeo.ecm.platform.jbpm.core.deployer.NeverDeployer" />
<deployer name="ifChanged"
class="org.nuxeo.ecm.platform.jbpm.core.deployer.IfChangedDeployer" />
<deployer name="nuxeoProperties"
class="org.nuxeo.ecm.platform.jbpm.core.deployer.NuxeoPropertiesDeployer" />
</extension>
15.2.2.6. securityPolicy extension point
The security extension point allows to contribute a security policy to a process definition. This security policy
is used in the document related methods of the JbpmService.

point="securityPolicy">
<securityPolicy
class="org.nuxeo.ecm.platform.jbpm.core.service.DefaultJbpmSecurityPolicy"
for="review_parallel" />
<securityPolicy
class="org.nuxeo.ecm.platform.jbpm.core.service.DefaultJbpmSecurityPolicy"
for="review_approbation" />
</extension>
This class follows the JbpmSecurityPolicy interface, and is used to define who is allowed to edit the process
(administrator or initiator). Other permissions (who is allowed to add some reviewers for instance) is left out to
the interface.
15.2.2.7. typeFilter extension point
The typeFilter extension point allows to bind process definition to a type of document. This is used in the
default 'Workflow' tab to show what choices to offer to the user.
Nuxeo EP 5.3 142

Workflow & jBPM
point="typeFilter">
<type name="Note">
<processDefinition>review_parallel</processDefinition>
<processDefinition>review_approbation</processDefinition>
</type>
<type name="File">
<processDefinition>review_parallel</processDefinition>
<processDefinition>review_approbation</processDefinition>
</type>
</extension>
15.2.3. Document management

The jBPM service provides a set of methods to interact with a single document. We use a simple convention to
attach a document to a process instance. 2 variables are added to the process instance:
documentId
The id of the document.
documentRepositoryName
The name of the document's repository.
The VariableName enum on the JbpmService names the different variables.
The abstract class AbstractJbpmHandlerHelper implements ActionHandler, AssignmentHandler,

DecisionHandler and TaskControllerHandler. It provides useful methods when dealing with document and
repository.
15.2.4. Default processes
15.2.4.1. The parallel review workflow
Nuxeo EP 5.3 143

Workflow & jBPM
Description
Start state
When the process is started, 3 variables are added to the process: the document id and the repository name
variable, the transition to follow( endLifecycleTransition variable). A start state task is also created to
capture the initiator actor id. It is retrievable afterward as the 'initiator' swimlane.
Choose participants node

A task is created for the initiator. At the end of this task a 'participants' variable is added to the process. It is
a list with one item per participant.
Set up rights
This is an action node. The process sets up the rights on the document so all participants can read it.
for each participant node

It uses an action node defined in the Nuxeo jBPM service. It creates a child token for each item of the list
given as parameter in the process definition. In this case, a child token is created for each participant. On
each child token, a variable named participant will hold the participant.
validate node
A task for the participant. If it is rejected, adds a variable named 'rejected' to the process. (The process is
therefore considered rejected if only one participant rejects it)
join
A normal jBPM join. Waits for all participants to finish their tasks before resuming.
do follow transition
A decision node that checks if there is a 'rejected' variable. If there is, go to end. Otherwise go to follow
transition node.
Nuxeo EP 5.3 144

Workflow & jBPM
follow transition
The attached document follows the named transition
15.2.4.2. The validation review workflow
Description
start state
Same as for the parallel review process.
choose participants
Same as for the parallel review process.
Condition on participants
Check if there is an item in the participants list. If there isn't, then go to follow transition. Otherwise go to
set up rights. Remove the first item of 'participants' list and put it in the participant variable. In any case,
remember the previous participant in the previousActorId variable (the initiator if no previous participant).
Setup rights
Makes the document readable to the participants
validate node
Create a task for participant. If she validates, then go to condition on participants otherwise to validate after
reject node.
validate after reject node

Create a task for previousActorId user. She has to validate the node.
Nuxeo EP 5.3 145

Workflow & jBPM
follow transition
The document follows the transition set in the transition variable.
15.2.5. Nuxeo jBPM How-to
15.2.5.1. How to optimize jBPM service ?
The jBPM service methods on documents use the jBPM API. To find task related to a document it iterates over
all the tasks and checks its variables.
If you have a lot of tasks, such a behavior can be too costly. We recommend in such a case to create a hibernate
query and to call this query from your own jbpmOperation object. The module nuxeo-platform-jbpm-core
comes with a nuxeo.hibernate.queries.hbm.xml that you can use. If you create your own query file, you
need to add it in the hibernate configuration file.
If you need to query on property of the attached document, you can optimize the query by directly using the
repository (this is valid only when using the sql backend). You need to create a class to map to the schema you
want to query and add the hibernate annotation, you'll then be able to create a hbm query using the schema.
You need to keep in mind that hibernate or the repository could be caching data, using such queries should be
used carefully.
15.2.5.2. How to use jBPM as a task management service ?
The jBPM service can also be used as a simple task management service. The publication service uses it that
way. It creates a task when someone needs to validates a publishing request. There is no process instance
attached to it (but still a document attached to the task).
The code to create a task is:

TaskInstance ti = new TaskInstance();
ti.setPooledActors(new String[]{"some", "actors"});
Map<String, Serializable> variables = new HashMap<String, Serializable>();
variables.put(JbpmService.VariableName.documentId.name(), document.getId());
variables.put(JbpmService.VariableName.documentRepositoryName.name(), document.getRepositoryName());
ti.setVariables(variables);
ti.setName("my task");
ti.setCreate(new Date());
jbpmService().saveTaskInstances(Collections.singletonList(ti));
15.2.5.3. How to clean the database ?
jBPM keeps all tasks, processes and definitions in the database. If you don't need to keep an history of the
processes, you have two ways to delete unwanted data.
You can use the event service to call the deleteProcess on all finished process periodically (Note: the default
process in Nuxeo finishes only when all tasks are finished).
You can run a SQL procedure at the database level to remove the ended process and attached tasks.
15.2.5.4. How to test a process ?
Testing a process is done in two steps. The first step is to test the process definition itself. The second is to test
the use of the process definition by the jbpm service and your other methods.
To test a process definition, you can extend the AbstractProcessDefinitionTest and implement the
getProcessDefinitionResource() methods. It should return the path of the process definition. You can then use
the jbpmContext variable to interact with the process definition. You might have trouble if one of your action
requests some of Nuxeo services. If your handlers extend the AbstractJbpmHandlerHelper, you can surround
the logic inside a if(nuxeoHasStarted()){....}. This way no nuxeo services will be called inside unit test without
services.
Nuxeo EP 5.3 146

Workflow & jBPM
If you want to test a process definition and its interaction with nuxeo service, you can have a look at
JbpmServiceTest. It creates a repository, deploys the user manager service and the sql directory.
15.2.5.5. How do I add a new workflow to a type of document
To add a new worfklow you need to follow these step:

• Create a new process definition and register it using the processDefinition extention point.
• Add a security policy and a type filter using the securityPolicy and typeFilter extention point.
• If you want to see your process on a new type of document, you need to add the JBPM_TAB to you type
of document.
• Create the xhtml file that will show the process and different tasks. You need to add a xhtml file that
would be named the-name-of-your-process.xhtml and add new xhtml file if you create new type of task.
Nuxeo EP 5.3 147

Chapter 16. Document Versioning
16.1. Setting the version of a document

The versioning information are stored in the DocumentModel under the fields major_version and
minor_version of the uid.xsd schema. Set the version as you would any other field:
documentModel.setProperty("uid","major_version",1);
documentModel.setProperty("uid","minor_version",1);
The field used for version is adaptable via the properties extension point of the
org.nuxeo.ecm.platform.versioning.service.VersioningService component. It allows to define which
properties should be used to set versions for a given document type.
<versioningProperties>
<majorVersion>my:major_version</majorVersion>
<minorVersion>my:minor_version</minorVersion>
<documentType>File</documentType>
<documentType>Note</documentType>
</versioningProperties>
16.2. Modifying automatically the version of a document

Event such as saving a document or following a life cycle transition can change the document's version number.
To use this feature you need first to define which event should be listened to and then how the version number
should behave.
The CoreEventListenerService is used to define which event to listen to. The default declaration is in
nuxeo-platform-versioning-core:
<listener name="versioninglistener"
class="org.nuxeo.ecm.platform.versioning.listeners.DocVersioningListener">
<eventId>lifecycle_transition_event</eventId>
<eventId>documentCreated</eventId>
<eventId>beforeDocumentModification</eventId>
<eventId>documentUpdated</eventId>
<eventId>documentRestored</eventId>
</listener>
<listener name="versioningChangelistener"
class="org.nuxeo.ecm.platform.versioning.listeners.VersioningChangeListener" />
The class org.nuxeo.ecm.platform.versioning.listeners.DocVersioningListener implements the

behavior of the versioning when those events happen.
To modify the version of a document when a life cycle state is reach you need to define rules with the
behavior(increment major, minor or do nothing) using the extension rules from
org.nuxeo.ecm.platform.versioning.service.VersioningService:
<versioningRuleEdit name="sampleEditRuleProject" action="ask_user"

lifecycleState="project">
<option value="no_inc" default="true" />
<option value="inc_minor" />
<option value="inc_major" />
</versioningRuleEdit>
The default behavior for all type but File and Note is to increase the minor version for each life cycle change.
You need to override one of the default rules if you add a new type. The order is important, the list of rules is
read and the first match is used.
<versioningRuleEdit name="sampleEditRuleAnyState" action="ask_user"
lifecycleState="*">
<includeDocType>File</includeDocType>
<includeDocType>Note</includeDocType>
<includeDocType>MyNewType</includeDocType>
<option value="no_inc" default="true" />
Nuxeo EP 5.3 148

Document Versioning
<option value="inc_minor" />

<option value="inc_major" />
</versioningRuleEdit>
16.3. Accessing document from previous version

The CoreSession or the seam component documentVersioning and versionedActions allow to access
document from previous version. On CoreSession, the method getVersions return all the versions of a
document.
16.4. The versioning service implementation

The versioning service manages the version inside Nuxeo. Two implementations are available:
• The custom Nuxeo service, more flexible and used by default
• The default JackRabbit implementation.

To modify this setting edit the file config/default-versioning-config.xml:

<match>
<mimetype>OOo</mimetype>
<extension>OOo</extension>
<description>OOo 1.x and OpenDocument file</description>
<test type="detector" offset="0" length="" bitmask="" comparator="=">
org.nuxeo.ecm.platform.mimetype.detectors.OOoMimetypeSniffer
</test>
</match>
</match>
First a simple offset detection is performed to qualify a zip file, then a sub-match is defined. The detector
type indicates that the org.nuxeo.ecm.platform.mimetype.detectors.OOoMimetypeSniffer has to be called
and this is its responsibility to give all the valid information (mimetype, extension, description) if the file is
of correct type.
For MS-Office files, the "magic numbers" (the value to be found at a certain offset) are not that clear, as the
magic number defined by Jmimemagic (based on the file Linux command resource file) is the same for all
MS-Office application. Then we invoke a detector for each component that uses the POI library to detect what
file we deal with.
<match>
<mimetype>application/msword</mimetype>
<extension>doc</extension>
<description>Microsoft Office Document</description>
<test offset="0" type="string" comparator="=">\320\317\021\340\241\261</test>
<match-list>

<match>
<mimetype>application/vnd.ms-excel</mimetype>
<extension>xls</extension>
<description>Excel File</description>
org.nuxeo.ecm.platform.mimetype.detectors.XlsMimetypeSniffer
</test>
</match>

<match>
<mimetype>application/vnd.ms-powerpoint</mimetype>
<extension>ppt</extension>
<description>Powerpoint File</description>
org.nuxeo.ecm.platform.mimetype.detectors.PptMimetypeSniffer
</test>
</match>
</match-list>
</match>
Once a Microsoft Office Document has been detected at offset 0 in the first match, two sub-matches
detectors are defined for application/vnd.ms-excel
(org.nuxeo.ecm.platform.mimetype.detectors.XlsMimetypeSniffer) and
application/vnd.ms-powerpoint (org.nuxeo.ecm.platform.mimetype.detectors.PptMimetypeSniffer). If
none returns a correct mimetype, the only possibility remains then application/msword. (This may be lightly
refactored for simplicity in a near future).
Nuxeo EP 5.3 167

Mimetype detection
A detector is a class that implements net.sf.jmimemagic.MagicDetector. The public process method has to
detect if the file fulfills the condition. If successful, it returns the mimetypes supported by this file. The public
methods getHandledExtensions and getHandledTypes define the String arrays that are used by Jmimemagic
to build the final match.
21.4. Invoking the mimetype detection

All the detection is based on MimetypeRegistry like object. When invoked, the registry is populated with the
information that has been exposed previously. The registry implements the interface
org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry.
Once available, directly or from a bean, any File or Blob can be analyzed and the information retrieved like the
mimetype name or the supported extensions list.
import org.nuxeo.ecm.platform.mimetype.ejb.MimetypeRegistryBean;
...
private MimetypeRegistryBean mimetypeRegistry;
...
public void testSniffWordFromFile() throws Exception {
File file = FileUtils.getResourceFileFromContext("test-data/hello.doc");
String mimetype = mimetypeRegistry.getMimetypeFromFile(file);
assertEquals("application/msword", mimetype);
List<String> extensions = mimetypeRegistry.getExtensionsFromMimetypeName(mimetype);
assertTrue(extensions.contains("doc"));
}
In the above example, the mimetypeRegistry object used is a MimetypeRegistryBean. The purpose is to sniff
the mimetype of a given file. The MS-Word file is first read and the getMimetypeFromFile method is called.
Once the mimetype is retrieved, the getExtensionsFromMimetypeName can be called and it gives the associated
extensions from the registry.
Note that the API of org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry contains various

ways to ask for a mimetype, dealing with File or Blob objects, with or without default responses. It is worth a
look to avoid unneeded work.
Nuxeo EP 5.3 168

Chapter 22. Content Transformation
22.1. Introduction
Transforms are operations that perform any action modifying an input document. This can cover file conversion
as well as mail merging or information extraction.
22.2. Plugins module

The various plugins are stored in the nuxeo-plateform-transforms-plugins.* module. They are declared as a
contribution of the org.nuxeo.ecm.platform.transform.service.TransformService component at extension
point plugins.
The plugins are the engines that perform the needed transformations.
22.2.1. Creating a plugin

A transform plugin follows a framework defined in the nuxeo-plateform-transforms-core module. It is
basically a class that extends a org.nuxeo.ecm.platform.transform.interfaces.Plugin. The main common
method that has to be exposed is transform
List<TransformDocument> transform(
Map<String, Serializable> options, TransformDocument... sources);
The transform method returns a list of TransformDocument and accepts an options map and
TransformDocument sources. TransformDocument object is defined in
org.nuxeo.ecm.platform.transform.interfaces.TransformDocument and holds the binary as well as other
information such as mimetype.
The options map holds all the necessary options to be passed to the plugin. Please note that the keys are the
plugin names. See the officeMerger plugin below for an implementation example.
22.2.2. Declaring a plugin module

We first declare a contribution to the extension point plugins of
org.nuxeo.ecm.platform.transform.service.TransformService:
<extension target="org.nuxeo.ecm.platform.transform.service.TransformService" point="plugins">

<plugin name="any2odt"
class="org.nuxeo.ecm.platform.transform.plugin.joooconverter.impl.JOOoConvertPluginImpl"
destinationMimeType="application/vnd.oasis.opendocument.text">
<sourceMimeType>text/xml</sourceMimeType>
<sourceMimeType>text/plain</sourceMimeType>
<sourceMimeType>text/rtf</sourceMimeType>

<sourceMimeType>application/msword</sourceMimeType>

<sourceMimeType>application/vnd.sun.xml.writer</sourceMimeType>
<sourceMimeType>application/vnd.sun.xml.writer.template</sourceMimeType>

<sourceMimeType>application/vnd.oasis.opendocument.text</sourceMimeType>
<sourceMimeType>application/vnd.oasis.opendocument.text-template</sourceMimeType>
<option name="ooo_host_name">localhost</option>
<option name="ooo_host_port">8100</option>
</plugin>
</extension>
Nuxeo EP 5.3 169

Content Transformation
The name attribute will be used to declare the transform chain. The class attribute is the class that will do the
effective job of the transformation while the destinationMimeType is the mime-type of the result of the
transform.
After attributes, <sourceMimeType> nodes define the allowed input mime-types the transform is supporting. In
the presented case, we can see that the any2odt plugin will be able to handle text, Microsoft office word , OOo
1.x and OpenDocument format (OOo2.x) files to output an application/vnd.oasis.opendocument.text
OpenDocument file. Options can also be added as we see for <option> tags with ooo_host_name and
ooo_host_port attributes.
Plugins can be combined to build transform chains. This chains are declared in a transformer which is a
contribution to the extension-point transformers of
org.nuxeo.ecm.platform.transform.service.TransformService component.
<extension target="org.nuxeo.ecm.platform.transform.service.TransformService"
point="transformers">
<transformer name="any2text"
class="org.nuxeo.ecm.platform.transform.transformer.TransformerImpl">
<plugins>
<plugin name="any2pdf"/>
<plugin name="pdf2text"/>
</plugins>
</transformer>
</extension>
A transformer is defined by its name. This is this name that will be used to initialize a transform service when
using it.
Then, plugins involved in the chain are listed. Wen can see that our any2txt transformer is composed with two
chained plugins: any2pdf then pdf2txt. Obviously, a single plugin for a transform is legal as we can see with
the use of our previous any2odt plugins.
<extension target="org.nuxeo.ecm.platform.transform.service.TransformService"

<transformer name="any2odt"
<plugins>
<plugin name="any2odt"/>
</plugins>
</transformer>
</extension>
22.2.3. Using a transform plugin

Once a transform plugin has been declared and the transformer is known, we can use it to perform various
transformation actions.
TransformService service = NXTransform.getTransformService();

Transformer transformer = service.getTransformerByName("any2pdf");
List<TransformDocument> results = transformer.transform(null,
new TransformDocumentImpl(sourceStream, "application/vnd.oasis.opendocument.text"));
SerializableInputStream resultStream = results.get(0).getStream();
We first get the TransformService that exposes all the available transforms. Then a specific transformer is
built with the getTransformerByName method of the service. The name is the one that has been declared in the
contribution to the transformers extension-point of the
org.nuxeo.ecm.platform.transform.service.TransformService component.
Then the transformer exposes a transform method that returns a list of TransformDocument. The arguments are
the:
• options: the plugin options (the keys are the plugin names) - we pass null here as we do not have any
Nuxeo EP 5.3 170

options. See officeMerger plugin for a more detailed example
• list of sources as TransformDocument instances
There are three levels of options that overload. First the plugin options are the default. Then any option in the
transformer that define an option for this plugin overload them. Finally, any code-defined options are merged,
overloading any previous option that may have been already defined. Please note again that options are defined
on a plugin name basis.
A TransformDocument instance can be constructed from:

• a source stream
• a source stream and its mime-type
• a blob
In our example, we use the second way and give a sourceStream and the mime-type of an ODF document.
Once the input list processed, the results list contains all the transformed files as TransformDocument instances
from which you can retrieve the SerializableInputStream stream with getStream method, the mime-type
using getMimetype and the blob with getBlob method.
An alternate way of using the transform is to call it directly from the service
List<TransformDocument> results = service.transform(converter,

null, new TransformDocumentImpl(stream, sourceMimetype));
The arguments are the same and the converter name is given as first argument. An other constructor using
blobs as input instead of TransformDocument is also available. Before calling a transform we can also check
that the source mime-type is supported by calling the isMimetypeSupportedByPlugin method. Be careful
though that this plugin name may be different than the transformer name.
Transforms can be called directly but are also part of the docModifier framework that reacting on events, can
call transforms to alter or generate new informations (see below oleExtract plugin or docModifier
documentation)
22.3. Available transforms

All the transform plugin packages start with org.nuxeo.ecm.platform.transform.plugin. Some of them are
optional and not included in the default platform.
22.3.1. Document conversion

The document conversion plugin is a generic transform delivered in Nuxeo that allow transforming a file from
a format to an other. It uses the third-party JODconverter tool. The transform is implemented in the
org.nuxeo.ecm.platform.transform.plugin.joooconverter.impl.JOOoConvertPluginImpl class and
defined as a plugin contribution to org.nuxeo.ecm.platform.transform.service.TransformService .
Then it can be classically called as explained in the previous section:
TransformService service = NXTransform.getTransformService();

Transformer transformer = service.getTransformerByName("any2pdf");
List<TransformDocument> results = transformer.transform(null,
new TransformDocumentImpl(sourceStream, "application/vnd.oasis.opendocument.text"));
SerializableInputStream resultStream = results.get(0).getStream();
Nuxeo EP 5.3 171

The transform call relays to the JOOoConvertPluginImpl that first connects to OOo on port and host defined
in the contribution (usually localhost:8100) or in the options (not defined in our example). It then acquire an
OpenOfficeDocumentConverter from JODconverter tool and then can call the convert method with the
requested target mimetype and source file. Note that in future version, the
StreamOpenOfficeDocumentConverter class will be used to avoid dealing with File objects. This limitation
will be solved when a new version of OpenOffice.org (2.3) will be out and solves a regression on loading
streams.
Before any call to the underlying OpenOffice.org converter, once in the transformation engine
JOOoConvertPluginImpl, the source document mimetype is tested. If it is the same than the requested
destinationMimetype defined by the plugin, the source file is returned immediately as result unless the
mimetype occurs in the <sourceMimeType> of the plugin to allow self-transformations. By default, any2pdf
plugin will return immediately if an application/pdf file is submitted while any OpenDocument
transformation (any2odt, any2ods, any2odp) will process the files as each one contains its own mimetype like
<sourceMimeType>application/vnd.oasis.opendocument.text</sourceMimeType>. This allow to clean and
validate files forged by hand and possibly apply automatic treatments at OpenOffice.org side.
22.3.1.1. Remote engine
Since OOo 2.3.0, it is possible to use InputStreams as source documents so that no more File objects are
needed. This is useful if we want to isolate the OOo server on a separate machine (and if needed use a farm
with load balancing if heavy work is needed) As this feature is only available with OOo2.3+ (due to a bug in
previous versions), there is a nuxeo.property to define the OOo version used.
org.nuxeo.ecm.platform.transform.ooo.version=2.3.0
At term, the JODConverter tool should be able to return the OOo version it is using, so that this property will
not be needed anymore. For the moment, let use this property. But as OOo stream loading has been reported as
less efficient than File/URL by JODConverter users, the streaming method is only used if OOo is really a
remote instance. This is analyzed if the ooo_host_name transformer option is 'localhost' or starts with
'127.0.0'. And of course, only if OOo declared version is greater than 2.3.0.
22.3.1.2. OpenOffice.org loading options
As the underlying engine is based on OpenOffice.org, one can extend the document converter by supporting
OOo loading options. The transform plugins options mechanism is fully supported, so they can be defined at
plugin, transformer and code level. The available fields to be passed to OOo is listed at MediaDescriptor IDL
reference and have to be bound to the plugin name.
Here is an example passing two options for loading conditions of a special document that is a password
protected and has an autostart bound event that delete the content of the file to put the word DELETED in the
document. This simulate any other heavy process such as document merging or automatic mail-merge from a
database.
Map<String, Map<String, Serializable>> options = new HashMap<String, Map<String, Serializable>>();

Map<String, Serializable> pdfOptions = new HashMap<String, Serializable>();
pdfOptions.put("Password", "TheDocumentPassWord");
short ALWAYS_EXECUTE_NO_WARN = 4;
pdfOptions.put("MacroExecutionMode", ALWAYS_EXECUTE_NO_WARN);
pdfOptions.put("ReadOnly", false);
pdfOptions.put("Hidden", false);
options.put("any2pdf", pdfOptions);
// Note: due to password, file mimetype can not be sniffed
// so mimetype has to supplied to TransformDocumentImpl
results = service.transform("any2pdf", options,
new TransformDocumentImpl(getBlobFromPath(path), "application/vnd.oasis.opendocument.text"));
assertTrue(results.size() > 0);
// The macro on the open event replaces the text by "DELETED"
assertEquals("pdf content", "DELETED", DocumentTestUtils.readPdfText(pdfFile));
First, we build the plugin options map. The Password field is in charge of sending the password string to the
OOo loader so that the file can be opened. The MacroExecutionMode field defines how macros and script are
Nuxeo EP 5.3 172

handled at startup. By default, the consequence of the -headless OOo mode, is that the NEVER_EXECUTE = 0
value is used. One can change this default behaviour by using any value listed in the OOo MacroExecMode
constant group. One important thing to be noted is that type is important: Password require a String argument
while MacroExecutionMode requires a short one. The types have to be correct otherwise the field will not be
handled by OOo.
By default, JODConverter sets the ReadOnly option as true. As we want to modify the document, we will have
to set the ReadOnly flag to false. The Hidden flag has also to be set to false. This trick is due to a problem in
OpenOffice.org PDF engine that seems not to be able to handle document modification while Hidden. As an
headless server-deployed OOo instance, this should not be a major problem.
Once Options have been defined, they are globally merged to the options map under the plugin name key (here,
any2pdf)
Then the transform can be called as usual. Please note that mimetype of password document have to be passed
explicitly to the TransformDocumentImpl constructor as it can not be sniffed by the Mimetype service for the
moment.
Finally, as expected a PDF document is returned with its content changed to the DELETED string.
22.3.2. Pdfbox
22.3.3. OLE objects extraction

OLE objects are objects included in office files that can be edited as standalone ones. For example, a
spreadsheet table may be included in a report so that the presented datas are always up to date.
This plugin is located in nuxeo-plateform-transform-plugin-oleextract module and is not include by

default in the plateform.
22.3.3.1. Implementation
The purpose of this plugin is to extract all these Ole objects and provide them as standalone files so that they
can be checked individually. It is also extended to extract images. It has a classical Transform plugin structure,
the plugin name is oleExtractPlugin bound to
org.nuxeo.ecm.platform.transform.plugin.oleextract.impl.OfficeOleExtractorPluginImpl. The
transform name is oleExtract.
As an example it can be called like

List <TransformDocument > results =
service.transform(TRANSFORMER_NAME, null, new TransformDocumentImpl(stream, mimetype));
TransformDocument result = results.get(0);
List <Map<String, Serializable>> ole =
(List < Map < String, Serializable > >) result.getPropertyValue("ole:olecontents");
First, the transform service is classically called, the TRANSFORMER_NAME being set to oleExtract. After
processing, the only TransformDocument returned result contains a property ole:olecontents that gives the
list of embedded objects that have been extracted.
The olecontents schema is defined in olecontent.xsd. Each element of the list contains the following fields
<xs:complexType name="olecontent">
<xs:sequence>
<xs:element name="displayname" type="xs:string" />
<xs:element name="filename" type="xs:string" />
<xs:element name="data" type="nxs:content"/>
<xs:element name="thumbnail-mime-type" type="xs:string"/>
<xs:element name="thumbnail-data" type="nxs:content"/>
</xs:sequence>
</xs:complexType>
Nuxeo EP 5.3 173

Each olecontent element contains file datas (data & mime-type) and thumbnail ones (thumbnail-mime-type
& thumbnail-data). The displayname is the name retrieved in the office file if it was named otherwise the
internal one that has been given in the office file. The filename fields is built from the displayname and the
extension deduced from the mime-type.
Based on this new schema, the File doctype is extended in the

org.nuxeo.ecm.platform.transform.oleextract.coretypes contributing type and schema needed by oleExtract

<doctype name="FileWithOle" extends="File">
<schema name="olecontents" />
</doctype>
</extension>
A new FileWithOle doctype, based on File, is defined. It can be subtype of Workspace and Folder and is
defined as a contribution of org.nuxeo.ecm.platform.types.TypeService which allows to create new
documents based on it.
The oleExtract transform plugin has been bound to the oleExtractModifier docModifier. The contribution to
the extension point is defined in
<extension target="org.nuxeo.ecm.platform.modifier.service.DocModifierService"
point="docTypeToTransformer">
<documentation>
docModifier for oleExtract transform plugin.
</documentation>
<docModifier name="oleExtractModifier"
documentType="FileWithOle"
transformationPluginName="oleExtract"
sourceFieldName="file:content"
destinationFieldName="file:content">
<coreEvent>documentCreated</coreEvent>
<coreEvent>documentModified</coreEvent>
<customField name="olecontents:olecontents" transformParamName="ole:olecontents"/>
<customOutputField outputParamName="ole:olecontents" name="olecontents:olecontents"/>
</docModifier>
</extension>
This contribution reacts on document creation and modification. It receives the initial office file file:content
and gives back the olecontents:olecontents back mapped top the ole:olecontents we saw above. The
initial file is returned unchanged.
With this docModifier reacting on some events, the oleExtract results can now be integrated in the application.
The org.nuxeo.ecm.platform.transform.oleextract.action component defines an ActionService contribution
<action id="TAB_OLEOBJECT" link="/incl/tabs/document_oleobjects.xhtml"

enabled="true" label="action.view.ole" order="49">
<filter id="view_ole">
<rule grant="true">
<type>FileWithOle</type>
</rule>
</filter>
</action>
The TAB_OLEOBJECT action defines a new tab listing the olecontents:olecontents elements and providing
links for retrieving each file provided the document is of the current type FileWithOle.
22.3.3.2. Extraction details
OleExtract is based on the parsing of OpenDocument File format. If the submitted file is an ODF one, then it is
unzipped and processed without any connection to OpenOffice.org. If the file is not an ODF one, then a
converter plugin is used according to the source mime type. In this case, OpenOffice.org is required as a
JODConverter dependency.
Once we have an ODF file it is unzipped and its content.xml is parsed to find draw:object-ole, draw:object
Nuxeo EP 5.3 174

and draw:image related tags. For each one, the name of the resource is retrieved if it exists. Then for each
found resource, the alternate view is retrieved so that a preview can be proposed when listing this content (still
under development)
ODF resources in an ODF file (think at a spreadsheet diagram embedded in a text document) are stored in
directories and flat XML form while other resources are stored in a binary format. So for ODF resources the
global manifest file is parsed to isolate the files with their correct manifest:media-type so that the new ODF
archive for the Ole object can be built. Once the new manifest file is created, the embedded ODF directory is
zipped and this binary form is returned.
22.3.4. Office files merger

This transform plugin is contained in nuxeo-plateform-transform-plugin-officemerger module and is not
include by default in the platform. Its purpose is to build a new file as the result of the merging of the list given
as parameters. It uses OpenOffice.org merging capabilities, mainly through the insertDocumentFromURL UNO
method for text documents.
The public method merge is available from OfficeMergerImpl and returns a SerializableInputStream
containing the resulting document.
OfficeMergerImpl merger = new OfficeMergerImpl();
SerializableInputStream result = merger.merge(sourceFiles, engineType, converter,
outlineRank, withPageBreaks);
SerializableInputStream result = merger.mergeStreams (sourceStreams, engineType,
converter, outlineRank, withPageBreaks);
Some options have been added to enhance the building of the main document. Here is the list of the arguments
of the merge method
• sourceFiles/sourceStreams: Ordered array of File objects or streams to be merged.
• engineType: Depending on the nature of source documents, the OpenOffice.org API to be used is
obviously not the same. If source files are text file, the user will probably want to have a text file as a
result while if he deals with slides, the results is expected as a presentation. This String argument tells
which engine to be used (text, presentation, spreadsheet- only text is already implemented) -
Default text
• converter: Once the document is built, the Document Converter plugin can be called automatically to
create the final document. This is the converter name that is expected (eg. any2pdf) and an exception is
raised if it does not exist or the mime type deduced from the engineType is not supported. If an empty
string is provided, no transform occur at the end of the merging - Default empty
• outlineRank: This is the rank (compared to the file list) where a Table Of Content may appear. For
example, if the value is 3, then the first two files of the file list are inserted, the T.O.C is built and
inserted and then the remaining files are processed. The Table of Content is refreshed at the end of the
whole insertion. A value of 0 means no T.O.C. - Default 0
• withPageBreaks: A boolean that adds or removes page breaks between file insertions - Default true
The plugin engine, the merge method is available directly but the principal use will occur through a Transform
call. The Transform name is officeMerger and the package name is
org.nuxeo.ecm.platform.transform.plugin.officemerger
<plugin name="OfficeMergerPlugin"
class="org.nuxeo.ecm.platform.transform.plugin.officemerger.impl.OfficeMergerImpl"
destinationMimeType="application/vnd.oasis.opendocument.text">
<sourceMimeType>application/vnd.oasis.opendocument.text</sourceMimeType>
<sourceMimeType>application/vnd.sun.xml.writer</sourceMimeType>
<option name="ooo_host_name">localhost</option>
<option name="ooo_host_port">8100</option>
</plugin>
Note that OpenOffice.org has to be listening from incoming UNO connections on the specified interface
Nuxeo EP 5.3 175

ooo_host_name and port ooo_host_port. If it is not the case, an OpenOfficeException exception will be
raised.
So, once defined, the officeMerger transform can be called passing the options like
Map<String, Serializable> mergingOptions = new HashMap<String, Serializable>();

mergingOptions.put("engineType", "text");
mergingOptions.put("converter", "any2pdf");
mergingOptions.put("outlineRank", 0);
mergingOptions.put("withPageBreaks", false);
options.put("officeMerger", mergingOptions);
List<TransformDocument> results = transformer.transform(options, sourceFiles);
Note that mergingOptions can be incomplete or even null. The options will then take their default values.
The results list contains the final merged document, and converted if requested, at first index.
22.3.5. XSL Transformation

The XSLT plugin provides XSL transformations in Nuxeo. It allows you to transform XML documents using a
XSL stylesheet as defined in the XSLT Specification. The plugin is implemented in the
org.nuxeo.ecm.platform.transform.plugin.xslt.impl.XSLTPluginImpl class and defined as a plugin
contribution to org.nuxeo.ecm.platform.transform.service.TransformService.
The XSLT Plugin accepts XML documents as source files, and you must provide the XSL stylesheet as a
plugin's option named stylesheet. The XSL stylesheet must be provided as a Blob.
Then, you can easily transform your documents:
final Map<String, Serializable> pluginOptions =

new HashMap<String, Serializable>();
pluginOptions.put("stylesheet", (FileBlob) getXSLStylesheetBlob(...);
final Map<String, Map<String, Serializable>> options =
new HashMap<String, Map<String, Serializable>>();
options.put("xslt", pluginOptions);
TransformServiceCommon service = TransformServiceDelegate.getLocalTransformService();
final List<TransformDocument> results = service.transform(
"xslt", options, xmlSourceFiles);
The resulting documents' mime-type is set depending of the method attribute of the xsl:output element,
specified in the XSL stylesheet. If there is no method attribute defined in the XSL stylesheet, a default value is
chosen for the method attribute as defined in the XSLT Specification.
The mime-type is chosen as follows:
• text/html: if the output method is html.
• text/plain: if the output method is text.
• text/xml: if the output method is xml.
If there is no XSL stylesheet provided to the plugin or if an error occurs during the transformation (corrupted
xml or xsl for instance), a TransformException is thrown.
Nuxeo EP 5.3 176

Chapter 23. Nuxeo Conversion Service
The nuxeo-core-convert provides a service to manage conversion of Blobs from one format to an other.
nuxeo-core-convert has been available since Nuxeo EP 5.2-M4.
23.1. Conversion Service vs Transformation Service

Since Nuxeo EP 5.2, the Conversion Service replaces the Transformation service that is now deprecated.
23.1.1. Motivations for this API changes

The Transformation Service had some API design issues that we wanted to correct. Because full text indexing
is now handled by the repository, we also had to have a core service to manage full text conversion. We
decided to define a brand new API with a new service and we changed the service name to avoid any confusion
and be able to provide backward compatibility.
23.1.2. What has been improved
• API is now simpler
there are only converters, not transformers and plugins like before
• ConversionService includes a caching system
this eliminate the need of having custom cache managed by all high level services that may use
converters (like the preview service)
• Data input/output is now handled via BlobHolder interface.
There is only data structure (no more TransformDocuments or plain Blobs). This also makes the caching
system more efficient sice link between the blobs and the associated DocumentModel is preserved when
available.
• Availability check API interface.
ConversionService now provides an API to know if converter is available, this is useful when the
converter depends on an external program that must be installed on the server (like OpenOffice server)
23.1.3. About compatibility

Transformer API is now deprecated and the old transform-service implementations and plugins have been
removed from default distribution. Nevertheless, we provide a tranformer-compat bundle that handles
compatibility between the old and the new API.
In order to activate this compatibility you need to deploy:

• nuxeo-platform-transform-api
• nuxeo-platform-transform-compat
23.1.3.1. Using the transformer API
The transformers API is still available, but the implementation now wraps calls to the ConversionService. This
means you can use the new Converters from the old Transformation service API. All default included
Nuxeo EP 5.3 177

Nuxeo Conversion Service
Transformers have been migrated to converters with the same name. Code that was using transformers should
still work in 5.2.
23.1.3.2. Contributed transformers and plugins
Contributions to the old Transformation service are now contributed to the ConversionService using specific
converters that wraps transformers or Plugins.
There are some limitations thought :

• Transformers must be based on the TransformerImpl class
• you may have to change the dependencies in pom.xml and MANIFEST.MF to point to the compat artifact
instead of the core one.
23.2. Using Conversion Service
23.2.1. built-in converters

Inside nuxeo-core-convert-plugins
• pdf2text, xml2text, html2text, word2text, xl2text, ppt2text, oo2text
text extractors for common office formats
• rfc822totext
text extractors mime encoded mails
• any2text
meta-converter for text extraction
Inside nuxeo-platform-convert
• pdf2html
PDF to html conversion based on pdftohtml command line tool
• office2html
convert standard office formats to html (uses openoffice)
• any2html
compound converted to convert any input to html
• any2pdf
cuse OpenOffice to generate PDF
23.2.2. Conversion Service API

The Conversion Service can be accessed via the standard Nuxeo Service lookup:
ConversionService conversionService = Framework.getService(ConversionService.class);
Nuxeo EP 5.3 178

To convert a BlobHolder to a given destination mime type:

BlobHolder result = conversionService.convertToMimeType("text/plain", blobHolder, params);
params is a simple Map<String,Serializable> to pass parameters to the converter (can be null);
To use a known converter:

BlobHolder result = conversionService.convert("converterName", blobHolder, params);
To find a converter to a given conversion:

String converterName = conversionService.getConverterName(sourceMimeType, destinationMimeType);
To test if a converter is available:

ConverterCheckResult checkResult = conversionService.isConverterAvailable("converterName");
This call can throw ConverterNotRegistred if the target converter does not exist at all. The
ConverterCheckResult class provides:
• a isAvailable() method
• a getErrorMessage() method
Returns the error that occured while doing the availability check
• a getInstallationMessage method
Returns the installation message that was contributed by the converter contributor
23.2.3. Configuring the Convertion Service

The Conversion Service supports a global configuration via XML file in order to configure caching.
<component name="org.nuxeo.ecm.core.convert.config">
<extension target="org.nuxeo.ecm.core.convert.service.ConversionServiceImpl"
point="configuration">
<configuration>

<cachingDirectory>/var/ConversionCache</cachingDirectory>

<gcInterval>10</gcInterval>

<diskCacheSize>1024</diskCacheSize>

<enableCache>true</enableCache>
</configuration>
</extension>
</component>
23.2.4. Contributing converters

To contribute a new converter, you have to contribute a class that implement the
org.nuxeo.ecm.core.convert.extension.Converter interface. This class will be associated to:
• a converter name
• a list of source mime-types
• one destination mime-type
Nuxeo EP 5.3 179

• optional named parameters
point="converter">
<converter name="html2text" class="org.nuxeo.ecm.core.convert.plugins.text.extractors.Html2TextConverter">
<sourceMimeType>text/html</sourceMimeType>
<sourceMimeType>text/xhtml</sourceMimeType>
<destinationMimeType>text/plain</destinationMimeType>
<parameters>
<parameter name="myParam">myValue</parameter>
</parameters>
</converter>
</extension>
You can also contribute a converter that is a chain of existing converters (what was called a transformer in 5.1
transform service API). To to this, the contributed transformer does not have to define an implementation class,
just a chain of either converters or mime-types. If mime-types are used, the conversion service will
automatically guess the converter chain from the mime-types steps.
point="converter">

<converter name="chainedConverter" >
<sourceMimeType>some/mimetype</sourceMimeType>
<destinationMimeType>some/other-mimetype</destinationMimeType>
<conversionSteps>
<subconverter>converter1</subconverter>
<subconverter>converter2</subconverter>
</conversionSteps>
</converter>

<converter name="chainedMimeType" >
<sourceMimeType>foo/bar1</sourceMimeType>
<destinationMimeType>foo/bar3</destinationMimeType>
<conversionSteps>
<step>foo/bar2</step>
</conversionSteps>
</converter>
</extension>
When using chained converters, the additional optional parameters are passed to each underlying converter.
Converter based on external tools (such as command line or OpenOffice server based) can implement the
ExternalConverter interface. This interfaces adds a isConverterAvailable() method that will be called in
order to check converter availability.
23.2.5. Converters based on external command line tools

A lot of conversion tools comes as command line executable. So in some case it's interesting to wraps these
command lines into a converter.
For that purpose, we provide a base class for converters that are based on a command line wrapped by the
nuxeo command-line service.
The base class org.nuxeo.ecm.platform.convert.plugins.CommandLineBasedConverter handles all the

dirty work, and you only have to override the methods to define the parameters of the command line and the
parsing of the output.
point="converter">

<converter name="pdf2html" class="org.nuxeo.ecm.platform.convert.plugins.PDF2HtmlConverter">
<sourceMimeType>application/pdf</sourceMimeType>
<destinationMimeType>text/html</destinationMimeType>
<parameters>
<parameter name="CommandLineName">pdftohtml</parameter>
</parameters>
</converter>
Nuxeo EP 5.3 180

</extension>
Nuxeo EP 5.3 181

Chapter 24. Relations
24.1. Introduction
Relations in Nuxeo EP 5 follow concepts as described by the W3C Resource Description Framework (RDF).
The purpose is to provide content management relations (relations between documents of the site for instance)
as well as being able to share this information with third party applications, by following the RDF standards.
24.2. Concepts
There are a few jargon terms to understand when dealing with relations.
Let's consider a relation like "document A is a version of document B". This relation is described as a triplet or
statement: it has a subject, "document A", a predicate, "is version of", and an object, "document B".
The statement elements are more generally referred to as nodes. More specific kinds of nodes are literals and
resources. A subject and a predicate will always be resources, while the object may be also a literal. In a
relation like "document A has title 'documentation'", the object will be the literal string 'documentation'.
Literals are simple nodes, holding information like a string or a date. Resources refer to uniquely identifiable
objects, and often use a URI as identifier that looks like a URL. If this URI refers to an identified namespace,
we can make a difference between resources using it.
For instance, we can use the dcterms namespace to identify predicates: "http://purl.org/dc/terms/References",
"http://purl.org/dc/terms/IsBasedOn","label.relation.predicate.IsBasedOn",...
Documents in the Nuxeo default application use the following namespace:

"http://www.nuxeo.org/document/uid/". A document URI would look like
"http://www.nuxeo.org/document/uid/618e53c8-409e-40e8-9b73-5493f7e6de88" because we use the
JackRabbit identifier to identify fully the resource. Imagine that we use custom unique identifiers for
documents, we could use them too, but we should use a different namespace so that we do not mistake the JCR
identifier and the custom identifier.
When defining a relation like "document A is a version of document B", we will then build a statement which
subject is a resource representing document A, which predicate is a resource representing the "is a version of"
information, and which object is a resource representing document B.
If we would like to state that this relation was created as a certain date, we will add a date property to the
statement. This can be seen as a relation where the subject would be the statement itself, the predicate a
resource representing the "was created at" information, and which object would be a literal representing the
given date.
24.3. Configuration
If you would only like to change the storage used for the default graph of Nuxeo EP 5, please refer to
Section 44.4.2, “Relation service configuration”.
24.3.1. Graph instances

Relations are stored in a graph, that can also be called a model.
The graph definition is made though an extension point. It holds configuration about where and how to store
relations. Here is an example contribution.
Nuxeo EP 5.3 182

Relations
Example 24.1. Jena graph configuration for the Relation Service using PostgreSQL as storage

<component name="MyJenaGraph">
<require>org.nuxeo.ecm.platform.relations.jena</require>
<extension target="org.nuxeo.ecm.platform.relations.services.RelationService"
point="graphs">
<graph name="default" type="jena">
<option name="backend">sql</option>
<option name="databaseType">PostgreSQL</option>
<option name="datasource">java:/nxrelations-default-jena</option>
<option name="databaseDoCompressUri">false</option>
<option name="databaseTransactionEnabled">false</option>
<namespaces>
<namespace name="rdf">
http://www.w3.org/1999/02/22-rdf-syntax-ns#
</namespace>
<namespace name="dcterms">http://purl.org/dc/terms/</namespace>
<namespace name="nuxeo">http://www.nuxeo.org/document/uid/</namespace>
</namespaces>
</graph>
</extension>
</component>
This graph uses a Jena graph. Jena is a RDF framework, a plugin has been developed to integrate it to the
nuxeo platform. The graph definition requires the plugin to be registered to the application.
The graph is named "default" and declares its connection configuration.
24.3.2. Resource adapters

The graph configuration includes namespaces used for some of the graph resources so that resources with a
known namespace can be transformed into any kind of object.
For instance, the namespace "http://www.nuxeo.org/document/uid/" is used to identify documents using their
JCR unique identifier. We can register an adapter so that the resource can be transformed into the actual
document model it represents.
For example, the DocumentModelResourceAdapter class allows to get a DocumentModel object from a
resource, build with a namespace and a local name.
24.4. Manage relations

Managing relations turns around the following actions:
• adding a new relation to a graph
• removing an existing relation from a graph
• determining if a relation already exists
• emptying a graph to remove all existing relations
24.5. Display relations

The StatementInfo interface provides methods to manipulates data about statements. That way, you can retrieve
informations to display relations and their properties: These tools are:
• wrappers/getters, to recover information about a statement (subject, predicate, object, ...) or a node (type
of node : literal, resource, QNameResource ...)
Nuxeo EP 5.3 183

Relations
• methods to get all statements or statements which are matching a given pattern: this can be useful to
determine if a relation is incoming (document is the subject of the statement) or outgoing (the document
is the object of the resource)
• methods to get extra properties: for each relation, informations are added like creation date or the creator
of the relation.
Another interesting interface is NodeInfo: it is useful to qualify the type of resource you are handling with.
Some methods can determine if the node is a literal, a document, a blank node, etc ...
24.6. Architecture overview
Nuxeo EP 5.3 184

Chapter 25. Placeful Configuration
25.1. Introduction
The placeful configuration service allows configuration to be placed on a node in a repository. It is possible to
update, remove this configuration and merged it with all the configuration located from this node to the root of
the repository.
Placeful Configuration (PC in the rest of this chapter) is useful when you have a number of nodes much bigger
than the number of configuration. It allows to change and merge these configuration without having to travel
the repository tree.
25.2. Using Placeful Configuration

The PlacefulConfigurationManager is used for all interaction with PC. This service is available via the
extension point
org.nuxeo.ecm.platform.placeful.configuration.service.PlacefulConfigurationService. Before
using it, you need to associate a configuration with a storage in the component definition ???.
You can then use the placeful configuration service. The following code snippet show the basic usage:
Path p1 = new Path("/mon/path");
RepositoryLocation repo = new RepositoryLocation("monrepo");
NuxeoPrincipal principal = new NuxeoPrincipalImpl("myself");
PlacefulConfigurationManager pcs = Framework.getService(PlacefulConfigurationManager.class);
LocalTheme lt1 = pcs.createConfigurationEntry(LocalTheme.class, p1, repo, principal);
lt1.setMode("myMode");
pcs.saveConfigurationEntry(lt1);
Map<String, Object> map = new HashMap<String, Object>();
map.put("mode", "myMode");
List<LocalTheme> list = pcs.getAllConfigurations(LocalTheme.class, map); ❶
LocalTheme lt = pcs.getConfiguration(LocalTheme.class, repo, p, principal);
LocalTheme ltMerge = pcs.getMergedConfiguration(LocalTheme.class, repo, p, principal);
pcs.removeConfiguration(LocalTheme.class, repo, p1, principal);
❶ Query the storage for all the PC that have those field/value.
Note that:
• you never create a PlacefulConfiguration yourself but ask the manager for one.
• You need to save the PC after modification.
• You can not move a PC, you need to remove it and create a new one.
For more information on available methods and class, have a look at the Javadoc.
25.3. Contributing a placeful configuration

A PC is composed of two distinct types of information:
• The information specific to this configuration, for example, a local theme configuration has a mode, a
page or a docId.
• The information relative to its "placefulness": the path, principal and repository.
To contribute a configuration to the service you only have to gives the information specific to the configuration.
Nuxeo EP 5.3 185

Placeful Configuration
The "placeful" part is taken care of by the service. You also need to give a way to merge the PC. We will create
a simple config as an example. A "Simple" PC that has only one field: value.
• Create an interface specific for your configuration.
interface SimpleConfig {
setValue();
getValue();
}
• Create the empty interface that will be manipulated by the user. It needs to extends
PlacefulConfiguration, Serializable and your specific interface.
public interface Simple extends PlacefulConfiguration, SimpleConfig, Serializable {}
• Create the implementation of the specific configuration. It needs to implement your specific interface
and PlacefulConfigurationConfig. The PlacefulConfigurationConfig interface adds the
getAssociatedInterface() methods. It returns the "user" interface:
SimpleConfigImpl implements SimpleConfig, PlacefulConfigurationConfig {

private String value;
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
public Class<Simple> getAssociatedInterface() {
return Simple.class;
}
}
• Create the class for the merge algorithm. It has to implement PlacefulConfigurationAlgorithm. Its
only method takes a PC and a storage and returns a merged PC. Our Simple configuration will do no
merge at all:
public class SimpleMergeAlgorithm implements PlacefulConfigurationMergeAlgorithm {

Simple mergeEntries(Simple pc, PlacefulConfigurationStorage storage) {
return pc;
}
}
• Finally the "user" interface has to know the implementing and merge class. You add the
@configurationClass annotation on the "user" interface:
@ConfigurationClass(value=SimpleConfigImpl.class, mergeAlgorithm=SimpleMergeAlgorithm.class)
public interface Simple extends PlacefulConfiguration, SimpleConfig, Serializable {};
• If you want your PC to be usable by a Directory storage you also need to provide a schema
Section 25.4.2, “Directory storage”
25.4. Available storage

A storage specifies where the configuration is stored. You can pass specific values to each storage using the
properties map (see Section 25.5, “Exemple of extension definition”). The storage gives you also the possibility
to define fields that will be indexed. When a user query the storage, only the indexed fields can be queried. At
the moment, only String field can be queried and indexed.
Nuxeo EP 5.3 186

It is assumed that an indexed field is a property of the PC and so available via getters. By default, all the
"placeful" values (principal, path, repository) are indexed and don't need to be added to the fields list.
25.4.1. In memory storage

The InMemory storage does not use any persistence. You should only use in it in very simple situation such as
test. The storageBackend class is:
org.nuxeo.ecm.platform.placeful.configuration.storage.InMemoryPlacefulConfigurationStorage.
You can pass comma-separated values in the fields property. Each value represent a property of the PC. In the
backend, an index will be created for each property. You can then use it as a search field in the map passed to
manager to find configurations (Section 25.2, “Using Placeful Configuration”).
25.4.2. Directory storage

org.nuxeo.ecm.platform.placeful.configuration.storage.SQLDirectoryPlacefulConfigurationStorage
implements the storageBackend. You pass it as the class attribute. You also need to add the name of you
directory:
<storageBackend name="SQL"
class=
"org.nuxeo.ecm.platform.placeful.configuration.storage.SQLDirectoryPlacefulConfigurationStorage">
<properties>
<property name="directoryName">localTheme</property>
</properties>
</storageBackend>
To use directory storage you need to define a directory and the associated schema. The schema only needs to
include the base.xsd schemaLocation and the placefulConfiguration.xsd schemaLocation. You can also
add any String element that you want to be indexed. Note that the "placeful" fields general for all
configurations are included by default and don't need to be added.
Don't forget to declare the schema and directory to the extension point. It is assumed that each field to be
indexed is a property of the PC and can be accessed by getters.
25.5. Exemple of extension definition
<component
name="org.nuxeo.ecm.platform.placeful.configuration.defaultContrib">
<extension
target=
"org.nuxeo.ecm.platform.placeful.configuration.service.PlacefulConfigurationService"
point="storage"> ❶❷
<storageBackend name="RAM"
class=
"org.nuxeo.ecm.platform.placeful.configuration.storage.InMemoryPlacefulConfigurationStorage">
<properties>
<property name="fields">docId,theme,mode</property> ❸
</properties>
</storageBackend>
</extension>
<extension
target=
"org.nuxeo.ecm.platform.placeful.configuration.service.PlacefulConfigurationService"
point="configuration"> ❷
<configuration name="TestConfig" storage="RAM"
class="org.nuxeo.ecm.platform.placeful.configuration.entry.LocalTheme" />
</extension>
</component>
❶ Definition of the storage.

❷ The configuration reference the storage name using the storage attribute.
Nuxeo EP 5.3 187

❸ Storage specific values.
Nuxeo EP 5.3 188

Chapter 26. Content Template Service
26.1. Introduction
The content template service helps you to automatically create documents. For instance, you might want to
create an English and a French folder each time you create a workspace.
Here is how you can do it easily with a simple contribution.
26.2. Contributing a content factory
26.2.1. Factory Binding

First you have to contribute a factoryBinding to the ContentTemplateService factoryBinding extension
point. The factories are used whenever a document is created using an EventListener.
Example 26.1. Example of a factoryBinding registration
<extension target="org.nuxeo.ecm.platform.content.template.service.ContentTemplateService"
point="factoryBinding">
<factoryBinding name="LangFactory" factoryName="SimpleTemplateFactory" targetType="Workspace">
......
</factoryBinding>
</extension>
Options available are

• name: name of the factory, defining a factory with the same name will override the first to be registered.
• factoryName: the name of the factory defined in the factory extension point.
• targetType: the document type for which the factory will be executed.
• targetFacet: the document facet for which the factory will be executed. You should target a facet if you
want the factory to be used for different document types.
26.2.2. Template
Once you have a factoryBinding, it is time to think about which kind of Document you want to create
automatically.
Example 26.2. Example of a template registration

<template>
<templateItem typeName="Folder" id="en_folder" title="EN"
description="English Folder"/>
<templateItem typeName="Folder" id="fr_folder" title="FR"
description="French Folder"/>
</template>
</factoryBinding>
Nuxeo EP 5.3 189

Content Template Service
• typeName: the Type of the Document you want to create
• id: the id of the Document you want to create.
• title: the title of the Document you want to create.
• description: the description of the Document you want to create.
• path: additional path, added to factoryBinding's targetType DocPath
26.2.3. ACL
Maybe you don't want every user to have Write right in both folder? If so, you can use ACL to manage rights
on your newly created templates.
Example 26.3. Example of an ACL registration for all templates of the factory

<acl>
<ace principal="Administrator" permission="Everything" granted="true"/>
<ace principal="administrators" permission="Everything" granted="true"/>
<ace principal="members" permission="Read" granted="true"/>
<ace principal="members" permission="Version" granted="true"/>
</acl>
<template>
.....
</template>
</factoryBinding>
Example 26.4. Example of an ACL registration for a single templateItem
<templateItem typeName="Folder" id="en_folder" title="EN">

<acl>
<ace principal="FRGroup" permission="Read" granted="true" />
<ace principal="ENGroup" permission="Write" granted="true" />
</acl>
</templateItem>

• principal: Name of the group/user
• permission: the permission you want to set.
• granted: grant or denied the permission.
26.3. How to Register your own Factory

If you need a better control on the factory, you can contribute your own using the following extension point:
Example 26.5. Example of a Factory registration
<extension target="org.nuxeo.ecm.platform.content.template.service.ContentTemplateService"
point="factory">
<contentFactory
name="SimpleTemplateFactory"
class="org.nuxeo.ecm.platform.content.template.factories.SimpleTemplateBasedFactory"/>
Nuxeo EP 5.3 190

Content Template Service
</extension>

• name: The name of the new factory, used in factoryBinding definition.
• class: The class implementing ContentFactory.
• enabled: Boolean to enable/disable the factory.
The newly defined Factory has to implement ContentFactory interface. A better way to do this would be to
extend the abstract class BaseContentFactory.
Nuxeo EP 5.3 191

Chapter 27. Nuxeo's Management Service
Nuxeo comes with management by providing a resource publisher, an use case scheduler and a REST XML
serializer. Nuxeo makes use of theses services for providing you information about components deployment,
directory status, events metric, http and directories session metrics.
These services is to used for integrating nuxeo in a management platform.
27.1. Integrating Nuxeo monitoring in your management system

As an administrator, I want to monitor my Nuxeo server.
Nuxeo exposes monitoring data and behaviors by using the JMX standard. If your management platform does
not support JMX, you're able to feed it using the XML serializer provided as a WebEngine module. Nuxeo
provided mbeans are published in the "nx" domain.
Nuxeo has identified these kinds of monitoring data : inventory, metric and usecase. Nuxeo types theses objects
using the "management naming attribute.
27.1.1. Inventory (nx:*,management=inventory)

The inventory is based onto the component registry. It mainly adapt the registration objects graph (components,
extension points, contributions) as an mbean tree. This gives you an access to what and how are the services
deployed. Other informations about these services (metrics, status, usecases) will be is to be attached to the
inventory. Using these information, you can check that your server is correctly deployed.
27.1.2. Metric (nx:*,metric=*,management=metric)

Inventory is being completed by metrics. It's the accounting information that they can easily provide to users
with no costs overhead. As example, directory manager provide core sessions counters. These information are
bound into the mbeans tree. Managers defines gauges that polls metric for treesholds or to gather historical
data.
27.1.3. Quality (nx:*,usecase=*,management=usecase)

Services are tested periodically by running a typical use case. Results about are published in the service subtree
by the management use case scheduler. These informations is to be polled by managers for issuing alerts. We
already defined a use case checking that the repository is well working by creating and removing a document.
27.2. Integrating management in nuxeo server

As an administrator, I want to enable nuxeo platform management features.
Management is packaged into three distinct packages : nuxeo-runtime-management,

nuxeo-platform-management and nuxeo-webengine-management modules.
27.2.1. nuxeo-runtime-management
That module contains the management logic : the resource publisher and the use cases scheduler. These
services implements only behaviors and have to be contributed by other components for activation.
27.2.2. nuxeo-platform-management
That module contains adapters for nuxeo services such as the runtime inventory or the http session metric. It
Nuxeo EP 5.3 192

Nuxeo's Management Service
also contains the use case scheduler and some typical use cases such as the directory one.
Nuxeo platform management provides you the basic monitoring resources. The following section describes
how coding integrating newer monitoring resources suitable for your needs.
27.2.3. nuxeo-webengine-management
That module contains a web engine module for serializing in XML mbeans. You have to use it if your
management platform is not JMX aware.
27.3. Contributing management
27.3.1. Publishing
As a developer, I want to publish some informations suitable for monitoring services I'm in charge for.
Here is the typical use cases for : service publishing, resource publishing and mbeans aliasing.
27.3.1.1. Publishing a service
As a developer, I want to publish a service. Usually, services are defined as singleton.
To publish summarized informations about this service, you first have to define a Java interface for and makes
your singleton implementing it. Then, you have to contribute to the resource publisher service, naming your
singleton. Given the monitoring interface myPackage.MyServiceMBean and the implemented class
myPackage.MyService , you have to define an extension in service definition as follow :
..
<require>org.nuxeo.runtime.management.ResourcePublisher</require>
<extension point="services"
target="org.nuxeo.runtime.management.ResourcePublisher">
<service class="mypackage.MyService"
ifClass="myPackage.MyServiceMBean" name="myService" />
</extension>
..
Note
As you respect a JMX convention, resource publisher is able to guess the interface class you use by
its name. So, in that case, it is not mandatory to provide the interface class name.
27.3.1.2. Publishing resources using a factory
As a developer, I want to publish a collection of informations, such as a map of metrics.
The first idea is to expose a getter that returns the map. That kind of information is not well supported on
manager side. Monitors and gauges are just able to bind to attribute with a string or numeric type. If the
cardinality is acceptable, the resource publisher enables you to register a factory that is to be call backed for
publishing your resources. Given the monitoring interface MyMetricMBean , the MyMetricFactory will publish
metrics provided by MyService
package mypackage;
import org.nuxeo.runtime.management.ResourceFactory;
import org.nuxeo.runtime.management.ObjectNameFactory;
public class MyMetricFactory implements ResourceFactory {
public void configure(ResourcePublisherService publisher, ResourceFactoryDescriptor descriptor) {
this.publisher = publisher;
Nuxeo EP 5.3 193

this.service = (MyService)Framework.getLocalService(My.class);
}
protected final ComponentName myServiceName = MyService:NAME;
protected MyService service;
protected ResourcePublisher publisher;
public void registerResources() {
for (String name:myService.doGetMetricNames() {
doRegisterMetric(name);
}
}
protected void doRegisterMetric(String name) {
MyMetricContext context = new MyMetricContext(String name, service);
String shortName = ObjectNameFactorty.formatMetricShortName(name);
ObjectName qualifiedName = ObjectNameFactory.formatMetricQualifiedName(myServiceName,name);
publisher.registerResource(shortName, qualifiedName, MyMetricMBean.class, metric);
}
}
package mypackage;
public class MyMetricContext implements MyMetricMBean {

public void MyMetricContext(String name, MyService service) {
this.service = service;
this.name = name;
}
protected final String name;
protected final MyService service;
int getCount() {
return service.doGetCount(name);
}
package mypackage;
public class MyService implements Service {

protected String doGetNames() {
..
return ...
}
protected int doGetCount(String name) {
..
return ...
}
}
..
<extension point="factories"
<factory class="mypackage.MyMetricFactory"
ifClass="myPackage.MyMetricMBean" name="myMetricFactory" />
</extension>
..
27.3.2. Providing shortcuts

As an administrator I want to monitor OperatingSystem attributes in my management system using the XML
serializer. I will contribute to the resource publisher by defining the following extension point :
..
Nuxeo EP 5.3 194

<extension point="shortcuts"
..
<shortcut name="operatingSystem" qualifiedName="java.lang:type=OperatingSystem"/>
..
</extension>
..
27.3.3. Reporting quality

As a developer, I want to provide a feature operational status.
Services quality are to be monitored by scheduling typical use cases. Use cases should throw an exception for
indicating error condition. Use cases are registered under the service they belongs to.
..
<require>org.nuxeo.ecm.management.usecases.UsecaseScheduler</require>
<extension point="usecases"
<usecase name="myUsecase" class="mypackage.MyUsecase"
serviceClass="mypackage.My" />
</extension>
..
package mypackage;
import org.nuxeo.ecm.management.usecases.Usecase;
public class MyUsecase implements Usecase {
void init(Object service) {
this.service = (My)service;
}
MyService service;
void runCase(CoreSession session) throws ClientException {
service.doSomething();
}
}
Nuxeo EP 5.3 195

Chapter 28. Publisher Service
28.1. Overview
Since Nuxeo 5.3GA, you can now publish a document in 3 different ways:
• On local sections
• On remote sections (on a remote Nuxeo server)
• On the file system
When using the PublisherService, you only need to care about 3 interfaces:
• PublishedDocument: represents the published document: could be created from a DocumentModel, a
proxy, a file on the file system.
• PublicationNode: represents a Node where you can publish a DocumentModel: could be another
DocumentModel (mainly Folder / Section), a directory on the file system.
• PublicationTree: the tree which is used to publish / unpublish documents, to approve / reject
publication, list the already published documents in a PublicationNode, ... See the javadoc of the
PublicationTree.
The PublisherService mainly works with 3 concepts:

• factory: the classe which is used to actually create the published document. It also manages the
approval / rejection workflow on published documents.
• tree: a PublicationTree instance asociated to a name: for instance, we have a SectionPublicationTree

which will publish in Sections, a LocalFSTree to publish on the file system, ...
• tree instance: an actual publication tree where we define the factory to use, the underlying tree to use,
its name / title, and some parameters we will see later.
Next, we will see how to configure the different ways to publish in your Nuxeo server.
28.2. Local sections

That was the only way to publish on version < 5.3GA, and so this is the default way to publish.
Here is the default contribution you can find in Nuxeo (publisher-jbpm-contrib.xml in

nuxeo-platform-publisher-jbpm. This contribution override the one in publisher-contrib.xml located in the
nuxeo-platform-publisher-core project):
<extension target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl"
point="treeInstance">
<publicationTreeConfig name="DefaultSectionsTree" tree="RootSectionsCoreTree"
factory="CoreProxyWithWorkflow" localSectionTree="true"
title="label.publication.tree.local.sections">
<parameters>

<parameter name="RelativeRootPath">/sections</parameter>
<parameter name="enableSnapshot">true</parameter>
<parameter name="iconExpanded">/icons/folder_open.gif</parameter>
<parameter name="iconCollapsed">/icons/folder.gif</parameter>
</parameters>
</publicationTreeConfig>
</extension>
Nuxeo EP 5.3 196

Publisher Service
We define an instance using the RootSectionsTree tree and the CoreProxyWithWorkflow factory. We give it a
name, a title and configure it to be a localSectionTree (which means we will publish on Sections on the same
Nuxeo as the documents to be published are).
The parameters:
• RootPath: it's used when you want to define the root publication node of your PublicationTree. You can't
use RootPath AND RelativeRoothPath parameter.
• RelativeRootPath: used when you just want to define a relative path (without specifying the domain
path). A PublicationTree instance will be created automatically for each Domain, appending the
RelativeroothPath value to each Domain.
For instance, assuming we have 2 Domains: domain-1 and domain-2, and the RelativeRootPath is set to
"/sections", 2 PublicationTree instances will be created:
• the first one with a RootPath set to /domain-1/sections.
• the second one with a RootPath set to /domain-2/sections.
In the UI, when publishing, you can chose the PublicationTree you want. The list of trees will be
automatically updated when creating and deleting Domain(s).
• iconExpanded and iconCollapsed: specify which icons to use when displaying the PublicationTree on
the interface.
28.3. Remote sections

To make the remote publication work, both the Nuxeo server and client need to be configured.
28.3.1. Server configuration

You should create a new config file, publisher-server-config.xml for instance, in the nuxeo.ear/config
folder of your Nuxeo acting as a server.
Here is a sample configuration:
<component name="org.nuxeo.ecm.platform.publisher.contrib.server">
<extension target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl"
<publicationTreeConfig name="ServerRemoteTree" tree="CoreTreeWithExternalDocs" factory="RemoteDocModel" >
<parameters>
<parameter name="RootPath">/default-domain/sections</parameter>
</parameters>
</extension>
</component>
Parameters:
• RootPath: its value must be the path to the document which is the root of your PublicationTree. Here, it
will be the document /default-domain/sections, the default Sections Root in Nuxeo.
This parameter can be modified to suit your needs. Don't forget to put the whole path to the document
28.3.2. Client configuration
Nuxeo EP 5.3 197

Publisher Service
You should create a new config file, publisher-client-config.xml for instance, in the nuxeo.ear/config
folder of your Nuxeo acting as a client.
Here is a sample configuration
<component name="org.nuxeo.ecm.platform.publisher.contrib.client">
<extension
target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl"
<publicationTreeConfig name="ClientRemoteTree" tree="ClientForRemoteTree"
factory="ClientProxyFactory">
<parameters>
<parameter name="title">label.publication.tree.remote.sections</parameter>
<parameter name="userName">Administrator</parameter>
<parameter name="password">Administrator</parameter>
<parameter name="baseURL">
http://myserver:8080/nuxeo/site/remotepublisher/
</parameter>
<parameter name="targetTree">ServerRemoteTree</parameter>
<parameter name="originalServer">localserver</parameter>
</parameters>
</extension>
</component>
Parameters:
• targetTree: this parameter corresponds to the name of the tree defined on the server, here
ServerRemoteTree.
• username, password: the account defined by those parameters will be the one used to connect to the
remote Nuxeo and so to create documents in the PublicationTree. This account MUST exist on the
server.
• baseURL: URL used by the publisher service on the client side to communicate with the server.
• originalServer: identify the Nuxeo server used as client.
28.4. File system

To publish on the file system, you just need to define a new tree instance using the LocalFSTree and the
RootPath of your tree.
Here is a sample configuration:
<extension
target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl"
<publicationTreeConfig name="FSTree" tree="LocalFSTree"
factory="LocalFile" localSectionTree="false"
title="label.publication.tree.fileSystem">
<parameters>
<parameter name="RootPath">/opt/publishing-folder</parameter>
<parameter name="iconExpanded">/icons/folder_open.gif</parameter>
<parameter name="iconCollapsed">/icons/folder.gif</parameter>
</parameters>
</extension>
• RootPath: the root folder on the file system to be used as the root of the publication tree.
Nuxeo EP 5.3 198

Publisher Service
Nuxeo EP 5.3 199

Part III. Core Services
Nuxeo EP 5.3 200

Chapter 29. Nuxeo Runtime
29.1. Overview
Nuxeo Runtime is the foundation of the Nuxeo infrastructure. It handles deployment and extensibility of
components to target platforms. This component allows the whole Nuxeo infrastructure to be easily ported
between Java platforms (Java EE, OSGi, etc.) and features an easy plug-in mechanism that any component can
use to declare extension points. These extension points can be used by other components to extend the former
one.
The Nuxeo Runtime uses the OSGi component model and a set of adapters to deploy POJO components to Java
host platforms, such as Eclipse/Equinox, or a Java EE 5 application server such as JBoss or WebLogic. When
deployed, Nuxeo Runtime components become actual host platform components. For example on JBoss the
component is seen as a MBean, while when deployed on Geronimo it is seen as a GBean and on Eclipse it is
seen as a native Eclipse plug-in. In short, Nuxeo Runtime offers a new and seamless way to make your Java EE
applications and components extensible (as Eclipse developers are already used to).
Nuxeo Runtime is not specific to the Nuxeo platform, it is a generic deployment and extension system that can
be used in any Java or Java EE application.
Forget specific build of your applications for a dedicated project or customer and enjoy “Code once, deploy
anywhere” for real!
29.1.1. Main Goals

One of the main requirements of the “Nuxeo Core” component is to be deployable on both the JBoss and
Eclipse platforms. To ease development and allow as much code reuse as possible, Nuxeo developed a common
component and packaging model that may be deployed and used on both of these platforms without any code
change or repackaging. This model, the Nuxeo Runtime, was developed as the foundation for all Nuxeo
components. The Nuxeo Runtime is not a standalone framework. It is, in short, a component model running on
top of an existing platform that provides a common, platform-independent, model to underlie the components
of an application. This architecture allows flexible and true componentization of applications.
In addition to the component model, the Nuxeo Runtime also defines a common model for packaging, the
OSGi bundle model. At the lowest level, OSGi bundles are simply regular JARs containing an OSGi manifest
file. OSGi technology is becoming more and more popular and is currently used by Eclipse, Geronimo,
Glassfish, and Jonas as their runtime framework. Because of the component and packaging choices,
applications based on Nuxeo Runtime can run on different platforms without modification and without having
to care about the particulars of a deployment platform.
29.1.2. Main Features

The main features provided by Nuxeo Runtime are:
1. Native OSGi support
2. Extensible component model through extension points
3. Adapters to support host platforms (JBoss and Eclipse support is built-in)
29.2. What is OSGi?

OSGi (Open Services Gateway initiative) is an open standards organization founded by Sun Microsystems,
IBM, Ericsson and others in March 1999. OSGi defines a modular and complete, Java-based service
framework. The deployment units used by this framework are called bundles, so we will refer them as OSGi
bundles.
Nuxeo EP 5.3 201

Nuxeo Runtime
OSGi bundles are normal Java libraries (JAR files) containing a special manifest file (META-INF/MANIFEST.MF)
describing all aspects related to the bundle, for example: the bundle name, description, bundle dependencies,
exported packages, the bundle classpath, the bundle activator and many other OSGi-defined features.
Here is a typical OSGi manifest file:

Bundle-Name: NxRuntimeEclipseDemo Plug-in
Bundle-SymbolicName: org.nuxeo.runtime.demo.eclipse.Demo; singleton:=true
Bundle-Activator: org.nuxeo.runtime.demo.eclipse.demo.Activator
Bundle-Localization: plugin
Require-Bundle: org.eclipse.ui,
org.eclipse.core.runtime,
org.nuxeo.runtime.demo.HelloWorld,
org.nuxeo.runtime
The bundle activator is a Java object that is called whenever the bundle is started and stopped by the
framework. This is the only way available to the application to access the framework functionality.
Besides bundles and bundle management, OSGi provides a service registry: an API to register the services
provided by a bundle and to lookup services defined by other bundles. Also, OSGi defines a Declarative
Services specification that significantly simplifies the service-oriented programming model. Through this
model, services can be defined in XML files inside the bundle and automatically deployed by the framework.
For a complete definition of OSGi, see Wikipedia.
A key goals of Nuxeo Runtime is to natively support various implementations of the OSGi framework and to
use the OSGi bundle model for packaging and deployment. Another goal is to align the Nuxeo Runtime
component model with the OSGi-notion of Declarative Specification.
29.3. OSGi Support

Nuxeo Runtime provides "built-in integration" with any OSGi-compliant framework. This means Nuxeo
Runtime-based components can run “as is” on any OSGi-enabled platform. On other platforms like JBoss, an
adapter is required. The Nuxeo Runtime eases the creation of such adapters by providing an abstract OSGi
adapter that can be customized for any platform.
Note: This does not mean you can transform any platform into a fully OSGi-compliant platform using Nuxeo
Runtime adapters. Primarily, this is because the adapter must use the host platform's class-loading and
deployment model that may be incompatible with the OSGi specifications. The Nuxeo Runtime's adapters only
mimic an OSGi environment, using native host platform features, for applications using Nuxeo Runtime. Many
OSGi features are not yet provided by the adapter – but we hope to add more and more features. If you are
interested in helping on this, do not hesitate to contact us :-). Currently, one of the most important features that
is missing is OSGi service support, but we are working on this and hope to provide it soon.
When running on true OSGi platforms, no adapter is used and thus all OSGi features are available and supplied
by the host platform. Nuxeo Runtime components run on such a platform without any alteration.
Currently we provide two built-in adapters:

1. JBoss OSGi adapter – used to deploy OSGi bundles on JBoss AS 4.x
2. Test OSGi adapter – used for JUnit testing and can be used on any simple Java application that is not
using a complex class loading or deployment mechanism.
29.3.1. Supported Features

Currently, Nuxeo Runtime adapters can provide the following OSGi features:
1. OSGi Bundle deployment
Nuxeo EP 5.3 202

Nuxeo Runtime
2. Manifest file loading
3. Classpath processing
4. BundleActivator support (activation and deactivation)
5. BundleActivator notification each time a bundle is started and stopped
6. Fake Bundle and BundleContext implementations that adapt OSGi operations to native operations of the
host platform
7. Support for the common operations defined by the OSGi API for BundleActivators
8. Bundle lifecycle and framework support
9. Bundle dependencies (as specified in the manifest)
29.3.2. Unsupported Features

The following OSGi features are not supported (yet):
1. The OSGi service layer
2. The OSGi security layer
3. The OSGi class-loading specifications (the class-loading mechanism of the host platform is used)
4. Some methods of the interfaces Bundle and BundleContext (unimplemented Methods will thrown an
UnsupportedOperationException exception)
29.3.3. Planned Features

1. Supporting the OSGi service layer
2. Implementing the OSGi declarative services based on the runtime component model
29.4. Component Model

The component model provides a flexible way to define, register and locate components. It was designed in
order to reuse the same components on very different platforms like JBoss and Eclipse.
Full support of OSGi declarative service specifications is planned for the medium-term future. In addition to
this, Nuxeo components can describe any type of components, not only services.
29.4.1. What are components?

A definition from Wikipedia: “A software component is a system element offering a predefined service and
able to communicate with other components”. Components as defined by the Nuxeo model are logical units
that may depend on and/or extend one another. The Nuxeo Runtime is responsible for providing a common API
to register, locate or extend components and most commonly components are registered using XML descriptor
files.
Components can be declared as independent, top-level components - by using a standalone XML file in the
bundle- or they can be declared at a finer granularity by programmatically registering sub-components within
the bundle. To declare an top-level component, you need to create an XML description file, put it somewhere in
the bundle, typically in the OSGI-INF directory, and specify the “Nuxeo-Component” header in the bundle
Nuxeo EP 5.3 203

Nuxeo Runtime
manifest to load the component at bundle activation. For example, the manifest shown below has a reference to
the XML file "helloworld-extension.xml" that declares a component.
Bundle-Name: HelloWorldExtension Plug-in
Bundle-SymbolicName: org.nuxeo.runtime.demo.HelloWorldExtension
Require-Bundle: org.nuxeo.runtime.demo.HelloWorld
Nuxeo-Component: OSGI-INF/helloworld-extension.xml
29.4.2. Main Features

1. Declarative components through XML descriptors: XML component descriptors are tightly integrated
with OSGi – you can specify which components should be deployed at bundle activation-time by using
the custom manifest header “Nuxeo-Component”.
2. Dependency between components: components are activated only when all their prerequisites are met. If
prerequisites are not met the components will be put in a pending state until their dependencies are
completely resolved. Similarly when uninstalling a component, all the components depending on it will
be moved to the pending state when the a component is deactivated.
3. Extensibility through extension points: each component can let other components extend its functionality
by defining a set of extension points. Other components (or the component itself) may then plug
extensions (Java code) into one of the declared extension points. This flexible extension mechanism
draw inspiration from the Eclipse extension points but is not identical to it.
4. Life Cycle Events: component life cycle events are sent by the runtime to any interested component. See
Adaptable Components for a common use case.
5. OSGi integration: the component model is about to be fully integrated with OSGi and will be soon
compliant with the OSGi declarative service model.
6. Platform Independence: the component model can be used on any platform. It provides a single API to
register and look-up components – the Nuxeo Runtime native API may be used (and in the future, the
OSGi service API will be available too).
29.4.3. Planned Features

1. Complete integration with OSGi declarative services specifications
2. Component lookup through JNDI
29.4.4. Adapting Components

The runtime implementation may "adapt" registered components to components of the host platform. (This can
often be accomplished using the Nuxeo component life cycle notifications.) The JBoss adapter for the Nuxeo
Runtime, for example, is already doing this to adapt runtime components into JBoss "MBean services", and
thus Nuxeo "components" are seamlessly integrated into the host platform. Since these components are
understood by the host platform, we can leverage existing host platform functionally, such as MBean service
management on JBoss.
29.4.5. Flexible Model

You should not be afraid by the “component model” denomination. The runtime component model does not
limit your objects, nor imposing any extra rules on your development practices. You do not need to modify
your existing objects to derive from some Nuxeo-supplied base class, nor implement some runtime interfaces in
order to plug your objects into the component registry. Your objects that implement a "component" may be of
Nuxeo EP 5.3 204

Nuxeo Runtime
any kind.
The only requirement is that to be a "component", your object must have a public constructor without
arguments (the default constructor) so that it can be instantiated via newInstance method on the your object's
Class object. The component model makes this a mild restriction, since it supplies other means for object
initialization if you need to do complex actions at the time your object is created.
If you want to benefit from the extension points mechanism or to respond to component life cycle events like
activation or deactivation, there are two options. You can either implement the Component interface if this is
convenient for you, or define some methods with a particular signature so your object will be called by the
runtime using Java reflection. See below for more details on this.
In conclusion, the component model offers substantial benefits with few requirements; the model primarily
provides you the capability to register your components, extend others components, allow others to extend your
components, and look up components. These functions work the same way on any platform supported by
Nuxeo Runtime.
29.4.6. Component Life Cycle

A component has three primary life cycle states:
1. Registered: the component registration information was created and inserted into the registry. The
component dependencies are not yet processed or resolved, so the component cannot be activated.
2. ResolvedAll: dependencies of this component are satisfied. The component can be safely activated.
Other unresolved components waiting for a resolution that depends on this component are notified and if
they have no more dependencies, they will be moved to this state as well.
3. ActivatedComponent: Activation occurs as a result of one of three events: immediately upon component
becomin resolved, programmatically at the user request, or lazily the first time the component is referred
to by another component. The only requirement for activation is that the component must be resolved.
Currently only the immediate activation mode is supported.
When an activated component is deactivated it is put back into the resolved state. If a components is to
become unregistered, it will first be put in the resolved state, then an unresolved event is fired and the
component regresses to the registered sate, and finally it is removed from the registry.
When a component is activated or deactivated the runtime will call the activate or the deactivate method
of the component, if any. Implementing life cycle methods is the programmer's choice, they are not
required. These methods can be used to initialize and destroy the component in the given context.
The activation of a component signifies that the component is available and ready to be used by other
components, so that the component must be correctly initialized when it enters this state. The following
diagram illustrates the life cycle states, method call, and messages sent for Nuxeo Runtime components.
a. XXX ADD GRAPHIC HERE
29.4.7. Component Extensibility

A key innovation of the Nuxeo Runtime component model is the extension mechanism that enables
components to extend one another.
We will begin with a demonstration of how this mechanism works: Imagine you have a component A,
implemented in Java with class ImplA, that manages an action menu for the application. A wants to let other
components contribute actions to the menu in an easy and flexible way – for example by using XML files to
describe these actions.
To be able to do this, component A should declare an extension point, let's name this point “actions”. Other
Nuxeo EP 5.3 205

Nuxeo Runtime
components willing to contribute some actions to this "group effort" of a menu should use "actions" to indicate
their contribution. (A component may declare any number of extension points and may contribute to any
number of extensions to other components' extension points but we are using only point for this example.)
Components may declare extension points and extension contributions using a simple XML syntax like the
following:
<component name="A">



</indexing>

</repository>
</repository>
</extension>
</component>
44.3.2. JCR backend configuration

First you have to specify a datasource in
$JBOSS_HOME/server/default/deploy/nuxeo.ear/datasources/default-repository-ds.xml.
Example 44.3. Datasource for JCR backend
<!DOCTYPE connection-factories PUBLIC
"-//JBoss//DTD JBOSS JCA Config 1.5//EN"
Nuxeo EP 5.3 294

"http://www.jboss.org/j2ee/dtd/jboss-ds_1_5.dtd">
<connection-factories>
<mbean code="org.nuxeo.ecm.core.repository.JBossRepository"
name="nx:type=repository,name=default">
<constructor>
<arg type="java.lang.String" value="default"/>
</constructor>
</mbean>
<tx-connection-factory>
<jndi-name>NXRepository/default</jndi-name>
<adapter-display-name>NX Repository Adapter</adapter-display-name>
<rar-name>nuxeo.ear#nuxeo-core-jca-${project.version}.rar</rar-name>
<connection-definition>org.nuxeo.ecm.core.model.Repository</connection-definition>
<xa-transaction/>

<config-property name="name">default</config-property>
</tx-connection-factory>
</connection-factories>
Then edit $JBOSS_HOME/server/default/deploy/nuxeo.ear/config/default-repository-config.xml.
Example 44.4. Default repository configuration
<component name="default-repository-config">
<documentation>
Defines the default JackRabbit repository used for development and testing.
</documentation>
<extension target="org.nuxeo.ecm.core.repository.RepositoryService"
point="repository">
<documentation>
Declare a JackRabbit repository to be used for development and tests. The
extension content is the Jackrabbit XML configuration of the repository.
</documentation>
<repository name="default"
factory="org.nuxeo.ecm.core.repository.jcr.JCRRepositoryFactory"
securityManager="org.nuxeo.ecm.core.repository.jcr.JCRSecurityManager"
forceReloadTypes="false">
<Repository>

<FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
<param name="path" value="${rep.home}/repository" />
</FileSystem>

<Security appName="Jackrabbit">

<AccessManager class="org.apache.jackrabbit.core.security.SimpleAccessManager">

</AccessManager>
<LoginModule class="org.apache.jackrabbit.core.security.SimpleLoginModule">

<param name="anonymousId" value="anonymous" />


</LoginModule>
</Security>

<Workspaces rootPath="${rep.home}/workspaces" defaultWorkspace="default" />

<Workspace name="${wsp.name}">

<param name="path" value="${wsp.home}" />
</FileSystem>

<PersistenceManager class="org.apache.jackrabbit.core.state.obj.ObjectPersistenceManager">
</PersistenceManager>

<SearchIndex class="org.apache.jackrabbit.core.query.lucene.SearchIndex">
<param name="path" value="${wsp.home}/index" />
</SearchIndex>
</Workspace>

<Versioning rootPath="${rep.home}/version">

<param name="path" value="${rep.home}/version" />
</FileSystem>

<PersistenceManager class="org.apache.jackrabbit.core.state.obj.ObjectPersistenceManager">
</Versioning>

<param name="path" value="${rep.home}/repository/index" />
</SearchIndex>
</Repository>
</repository>
</extension>
</component>
Change the two PersistenceManager sections defining various database connection settings.
Refer to the Jackrabbit documentation for more information, and to the Jackrabbit Javadoc for details about
configuring the PersistenceManager.
In particular, decide if you want the binary blobs stored inside the database or in the filesystem (change
externalBLOBs to true if you want them outside the database, in the filesystem).
Using externalized Blobs can provide a performance improvement in particular if you need to store a lot of big
files. Depending on the RDBMS used, there may also be a max size limit for blob if you store them in the
RDBMS (for PostgeSQL 8.2 blobs are limited to 1 GB).
Here are some examples:
Example 44.5. Sample configuration for a PostgreSQL Jackrabbit repository

(...)
<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.PostgreSQLPersistenceManager"
<param name="driver" value="org.postgresql.Driver"/>
<param name="url" value="jdbc:postgresql://localhost/nuxeo"/>
<param name="user" value="postgres"/>
<param name="password" value="password"/>
<param name="schema" value="postgresql"/>
<param name="schemaObjectPrefix" value="jcr_${wsp.name}_"/>
<param name="externalBLOBs" value="false"/>
(...)

Nuxeo EP 5.3 296

(...)
<param name="schemaObjectPrefix" value="jcr_ver_"/>
Example 44.6. Sample configuration for a MySQL Jackrabbit repository
(...)
<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.MySqlPersistenceManager">
<param name="driver" value="com.mysql.jdbc.Driver"/>
<param name="url" value="jdbc:mysql://localhost/nuxeo"/>
<param name="user" value="mysql"/>
<param name="schema" value="mysql"/>
<param name="externalBLOBs" value="true"/>
(...)
(...)
<PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.MySqlPersistenceManager">
<param name="driver" value="com.mysql.jdbc.Driver"/>
<param name="url" value="jdbc:mysql://localhost/nuxeo"/>
<param name="user" value="mysql"/>
<param name="schema" value="mysql"/>
<param name="externalBLOBs" value="true"/>
Note: "schemaObjectPrefix" must have different values in workspace & versioning configuration
For JackRabbit, there are some persistence manager specific to each RDBMS :
• for PostgreSQL: you may use
org.apache.jackrabbit.core.persistence.bundle.PostgreSQLPersistenceManager
• for MySQL: you may use org.apache.jackrabbit.core.persistence.bundle.MySqlPersistenceManager
• for Oracle 10: you may use org.apache.jackrabbit.core.persistence.bundle.OraclePersistenceManager
• for MSSQL2005 you may use : org.apache.jackrabbit.core.persistence.bundle.MSSqlPersistenceManager
44.3.3. Set up your RDBMS

Create the database in the database server, enable IP connection, setup permissions and test the connection.
44.3.4. Start Nuxeo EP

You can now start JBoss AS and verify that your new repository is used!
44.4. Configuring Storage for other Nuxeo Services
Nuxeo EP 5.3 297

Many services beyond Nuxeo Core Repository are using an SQL database to persist their data, such as:
• Relations Service: RDF data is stored in SQL,
• Audit Service: Audit logs are stored via JPA,
• Tag Service: the tagging entities are stored in a table in the default Nuxeo DB via JPA,
• Directories: entries can be stored into an SQL database.

By default, all these services use the JBoss AS's embedded HSQLDB.
44.4.1. Configuring datasources

Each service can use a dedicated datasource to define the database connection. However, to simplify
configuration, all datasources are JNDI NamingAlias pointing to a single datasource (NuxeoDS). If you want to
change the default database, you can simply do the following:
• deploy the needed JDBC Driver in $JBOSS_HOME/server/default/lib,
• modify the datasource definition file in

$JBOSS_HOME/server/default/deploy/nuxeo.ear/datasources/unified-nuxeo-ds.xml.
The default configuration has a commented out PostgresSQL configuration.
To use a dedicated datasource for a service, you need to modify its configuration file. If you would like to store
audit logs in PostgreSQL using its own datasource, remove the NamingAlias in nxaudit-logs-ds.xml and
replace it with the datasource configuration example:
Example 44.7. Datasource for the Audit Service using PostgreSQL
<datasources>
<local-tx-datasource>
<jndi-name>nxaudit-logs</jndi-name>
<connection-url>jdbc:postgresql://localhost/logs</connection-url>
<driver-class>org.postgresql.Driver</driver-class>
<user-name>username</user-name>
<password>password</password>
</local-tx-datasource>
</datasources>
We recommend to enable XA transactions if your database server support it (for PostgreSQL, you have to use
8.x versions). The following datasource definition example enables XA transaction for the Audit Service using
PostgreSQL.
Example 44.8. Datasource for the Audit Service using PostgreSQL with XA transactions
<datasources>
<xa-datasource>
<jndi-name>nxaudit-logs</jndi-name>
<xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class>
<xa-datasource-property name="ServerName">localhost</xa-datasource-property>
<xa-datasource-property name="PortNumber">5432</xa-datasource-property>
<xa-datasource-property name="DatabaseName">logs</xa-datasource-property>
<xa-datasource-property name="User">postgres</xa-datasource-property>
<xa-datasource-property name="Password">password</xa-datasource-property>
<track-connection-by-tx/>
</xa-datasource>
</datasources>
Nuxeo EP 5.3 298

See Datasources Configuration on the JBoss wiki for more examples of datasources.
This method works for most services:

• Audit: nxaudit-logs-ds.xml
• Placeful Configuration Service & Subscriptions: nxplaceful-ds.xml
• UID generator: nxuidsequencer-ds.xml
• jBPM engine: nxworkflow-jbpm-ds.xml
• Workflow Document Service: nxworkflow-documents-ds.xml
• Archive management: nxarchive-records-ds.xml
• Relations: nxrelations-default-jena-ds.xml
• Compass search engine: nxsearch-compass-ds.xml
44.4.1.1. Special MySQL needs
MySQL is a quirky database which sometimes needs very specific options to function properly.
The datasources used by Jena (nxrelations-default-jena-ds.xml and nxcomment-jena-ds.xml) need to use

a "relax autocommit" mode. To enable that, change the connection-url in the datasources to something like:
<connection-url>
jdbc:mysql://localhost/nuxeo?relaxAutoCommit=true
</connection-url>
The datasource used by Compass (nxsearch-compass-ds.xml) needs to be put in "relax autocommit" too, and
in addition it needs an "emulate locators" option:
<connection-url>
jdbc:mysql://localhost/nuxeo?relaxAutoCommit=true&emulateLocators=true
</connection-url>
This is documented at http://static.compassframework.org/docs/latest/jdbcdirectory.html .
Note the & syntax for the URL parameters instead of just & because the URL is embedded in an XML file.
44.4.2. Relation service configuration

The Relation Service uses a datasource to define the data storage. However modifying the datasource is not
enough, you also have to tell to the Jena engine which database dialect is used, as it doesn't auto-detect it.
To do that, edit the sql.properties file in $JBOSS_HOME/server/default/deploy/nuxeo.ear/config/ and

change the definition of the org.nuxeo.ecm.sql.jena.databaseType property. The possible values are:
• Derby
• HSQL
• MsSQL
• MySQL
• Oracle
Nuxeo EP 5.3 299

• PostgreSQL
In the same file, the property org.nuxeo.ecm.sql.jena.databaseTransactionEnabled is set to true by

default.
Please refer to the Jena Site for more information about database support.
The value of the above properties are used as variables by the extension point defining the Jena configuration,
so that they only have to be changed in one place.
44.4.3. Tag service configuration

The Tag Service uses a datasource file to define the data storage. The service uses joins with tables located in
default repository DB instance, so in order to work it is a must to be configured on the same database instance
as the default repository. Short line, the nxtags-ds.xml file has to be compliant with whatever is set in the
default-repository-ds.xml file.
44.4.4. Compass search engine dialect configuration

Note that this section is obsolete in Nuxeo 5.2, and should not be used anymore.
The Compass plugin is configured using a datasource, but at the time of this writing it still needs some
additional configuration in a file embedded in its Jar. You should go to
$JBOSS_HOME/server/default/deploy/nuxeo.ear/system/ and inside the directory
nuxeo-platform-search-compass-plugin-5.1-SNAPSHOT.jar (the version number may be different) then edit
the file compass.cfg.xml. You will find a section like:
<connection>
<jdbc managed="true"
dialectClass="org.apache.lucene.store.jdbc.dialect.HSQLDialect"
deleteMarkDeletedDelta="3600000">
<dataSourceProvider>
<jndi lookup="java:/nxsearch-compass" />
</dataSourceProvider>
</jdbc>
</connection>
The dialectClass has to be changed according to your datasource configuration. The possible values end with
MySQLDialect, PostgreSQLDialect , etc. They are documented in the Compass documention about SQL
dialects .
44.5. Setting up a new repository configuration

If you just want to change the default repository name appearing in the url
http://.../nuxeo/nxdoc/default/, modify the repository name value in:
• default-repository-config.xml
• platform-config.xml
TODO: Nuxeo configuration has changed, the two above sections need to be updated.
44.5.1. Add the new repository configuration

Create a repository definition as a contribution to the extension point
org.nuxeo.ecm.core.repository.RepositoryService (for example: MyRepo-repositoy-config.xml) in
$JBOSS_HOME/server/default/deploy/nuxeo.ear/config/.
Nuxeo EP 5.3 300

You can take example on the default repository definition

$JBOSS_HOME/server/default/deploy/nuxeo.ear/config/default-repository-config.xml.
You have to properly configure the following aspects:

• the name of the component (name="org.nuxeo.project.sample.repository.MyRepo"), which must be
unique among component names,
• the name of the repository (<repository name="MyRepo">), which is used to refer to it from your
application and must also be unique among repository names,
• the various database connection settings (driver, user, password, schema, etc.),
• decide if you want the binary blobs stored inside the database or in the filesystem (change
externalBLOBs to true if you want them outside the database).
Refer to the Jackrabbit documentation for more information, and to the Jackrabbit Javadoc for details about
configuring the BundleDbPersistenceManager.
Example 44.9. Sample configuration for a PostgreSQL Jackrabbit repository
<component name="org.nuxeo.project.sample.repository.MyRepo">
<extension target="org.nuxeo.ecm.core.repository.RepositoryService" point="repository">
<repository name="MyRepo"
factory="org.nuxeo.ecm.core.repository.jcr.JCRRepositoryFactory"
securityManager="org.nuxeo.ecm.core.repository.jcr.JCRSecurityManager"
forceReloadTypes="false">
<Repository>
<param name="path" value="${rep.home}/repository"/>
</FileSystem>
<Security appName="Jackrabbit">
<AccessManager class="org.apache.jackrabbit.core.security.SimpleAccessManager">
</AccessManager>
<LoginModule class="org.apache.jackrabbit.core.security.SimpleLoginModule">
<param name="anonymousId" value="anonymous"/>
</LoginModule>
</Security>
<Workspaces rootPath="${rep.home}/workspaces" defaultWorkspace="default"/>
<Workspace name="${wsp.name}">
<param name="path" value="${wsp.home}"/>
</FileSystem>
<param name="path" value="${wsp.home}/index"/>
</SearchIndex>
</Workspace>
<Versioning rootPath="${rep.home}/version">
<param name="path" value="${rep.home}/version"/>
</FileSystem>
</Versioning>

<param name="path" value="${rep.home}/repository/index"/>
</SearchIndex>
</Repository>
Nuxeo EP 5.3 301

</repository>
</extension>
</component>
44.5.2. Declare the new repository to the platform

TODO: this should be moved to a different section as it doesn't pertain to the SQL configuration itself.
You have now replaced the default repository (demo) with your newly defined one (MyRepo). To actually use it,
create or edit the file MyPlatform-Layout-config.xml in
$JBOSS_HOME/server/default/deploy/nuxeo.ear/config/ and configure the parameters as shown in the
following example.
<component name="MyPlatformLayout">
<require>org.nuxeo.ecm.platform.api.DefaultPlatform</require>
<extension target="org.nuxeo.ecm.platform.util.LocationManagerService" point="location">
<locationManagerPlugin> 
<locationEnabled>false</locationEnabled>
<locationName>demo</locationName>
</locationManagerPlugin>
<locationManagerPlugin> 
<locationEnabled>true</locationEnabled>
<locationName>MyRepo</locationName> 
</locationManagerPlugin>
</extension>
<extension target="org.nuxeo.ecm.core.api.repository.RepositoryManager"
point="repositories">
<documentation>The default repository</documentation>
<repository name="MyRepo" label="My Repository"/>
</extension>
<service class="org.nuxeo.ecm.core.api.CoreSession" name="MyRepo" group="core">
<locator>%DocumentManagerBean</locator>
</service>
</extension>
</component>
This sample configuration creates a new repository in the core Group that will be assigned to the default server.
If you want to have it located on an other server you can use:
<extension target="org.nuxeo.runtime.api.ServiceManagement" point="servers">


<server class="org.nuxeo.runtime.api.JBossServiceLocator">
<group>MyGroup</group>
<property name="java.naming.factory.initial">org.jnp.interfaces.NamingContextFactory</property>
<property name="java.naming.provider.url">jnp://MyServer:1099</property>
<property name="java.naming.factory.url.pkgs">org.jboss.naming:org.jnp.interfaces</property>
</server>

<service class="org.nuxeo.ecm.core.api.CoreSession" name="MyRepo" group="MyGroup">
<locator>%DocumentManagerBean</locator>
</service>
</extension>
</extension>
Nuxeo EP 5.3 302

Chapter 45. LDAP Integration
45.1. For users/groups storage backend

The user interface in Nuxeo EP gets the data from NXDirectory. As a consequence you can choose your source.
By default, the users/groups data is stored in a SQL database. If you want to get the users from a LDAP
directory, you need to deploy one of the following configuration:
• Users in LDAP, groups in SQL
Go to the examples sub-folder and copy the default-ldap-users-directory-bundle.xml file in the

nuxeo.ear/config folder of the JBoss instance (or bundle it in a jar, cf packaging in this guide). This
sample setup replaces the default userDirectory configuration SQL with users fetched from the LDAP
server. The groupDirectory remains unaffected by this setup. You might want to copy the file
default-virtual-groups-bundle.xml and adjust defaultAdministratorId to select a user from your
LDAP that have administrative rights by default. You can also configure the section on defaultGroup to
make all users members of some default group (typically the members group) so that they have default
right without having to make them belong to groups explicitly.
• Users and groups in LDAP
Copy the users setup as previously; moreover copy the default-ldap-groups-directory-bundle.xml

file in the nuxeo.ear/config folder of the JBoss instance. This sample setup which is dependent on the
previous one additionally overrides the default groupDirectory setup to read the groups from the LDAP
directory typically from groupOfUniqueNames entries with fully qualified dn references to the user entries
or to subgroups. You can edit the nuxeo.ear/config/*.xml files on the JBoss instance, but you will
need to restart JBoss to take changes into account.
You can find additional information on those settings in the documentation for LDAPDirectory extension point.
The detailed architecture of the authentication and user management modules of Nuxeo can be found in the
user authentication and directories chapters of the reference guide.
See the Nuxeo Community Site FAQ for specific cases.
Nuxeo EP 5.3 303

Chapter 46. OpenOffice.org server installation
OpenOffice.org (OOo) is used on server-side for different tasks such as file transforms (eg. to PDF) or other
advanced tasks.
46.1. Installation
See http://www.openoffice.org/ for installation procedure if not provided by your OS.
46.1.1. Start server

Since version 2.3, OpenOffice can be started in headless mode. This means that under linux, you non longer
need to run a Xvfb.
Use the oooctl control script or, depending on your system and installation method, start OOo running :
• for Linux:
/path/to/openoffice/program/soffice.bin
-headless -nofirststartwizard
-accept="socket,host=localhost,port=8100;urp;StarOffice.Service"
• for Mac OS X:
/path/to/openoffice.app/Contents/MacOS/soffice.bin
• for Windows:
soffice.exe -headless
-nofirststartwizard
46.1.2. Parameters
46.1.2.1. -headless
The -headless switch lets OOo manage to answer every question that may occur with a default response
avoiding dead-locks. It also hides the OOo windows if a display is available by default (eg. Ms Windows).
Note that the -invisible switch is not used as it is redundant and errors on PDF exports may occur.
46.1.2.2. -nofirststartwizard
The -nofirststartwizard skips any post-install wizard, allowing to use OOo directly after the installation
without any user parameterization.
Install nxSkipInstallWizard.oxt extension to make this parameter permanent.
46.1.2.3. -accept
The UNO protocol implies that OOo is opened in listening mode on a network interface. This parameter let OOo
listen on the right interface and port.
Install nxOOoAutoListen.oxt extension to set this listening permanent.
Nuxeo EP 5.3 304

OpenOffice.org server installation
Alternate method: this could also be done by adding this connection info in OOo Setup.xcu configuration file.
<node oor:name="Office">
<prop oor:name="ooSetupConnectionURL">
<value>socket,host=localhost,port=8100;urp;StarOffice.Service</value>
</prop>
</node>
46.1.3. Installing an extension

Nuxeo has developed some tools to ease the settings, they are available at the Nuxeo svn tools ooo section as
extensions to install in OpenOffice. This can be done thru the GUI via the menu "Tools>Extensions
Manager>Add..." or by opening the wanted extension with OpenOffice. To do it from a command line, run:
/path/to/openoffice/program/unopkg add extension.oxt
46.1.4. Notes
46.1.4.1. Multi-machine
On multi-machine deployment, we recommend to install OOo on the server running the webapp (ie stateless
server on a bi-machine "stateless/stateful" installation).
46.1.4.2. OpenOffice lower than 2.3.x
For OOo versions lower than 2.3, a graphical interface is needed. If the server that hosts OOo is Linux server
that has no X installed, then the X virtual frame buffer tool Xvfb (or xvfb-run depending of your distribution)
can be used to create a suitable display.
Xvfb :77 -auth Xperm -screen 0 1024x768x24

export DISPLAY=":77.0"
xvfb-run -a /path/to/openoffice/program/soffice.bin
46.1.4.3. 32/64 bits
Note that the platform used for both the JVM and OOo have to be consistent to allow UNO protocol to work:
with a 32 bits JVM, you'll have to use the 32 bits OOo version while the 64 bits one will be mandatory for a 64
bits JVM.
46.2. Running OpenOffice as a Daemon
46.2.1. Nuxeo OOo Daemon

Starting with 5.2-M4, Nuxeo includes a Daemon to start and manage OpenOffice server.
This daemon is based on the OpenOffice Server Daemon project
OOo Daemon provides :

• OpenOffice server automatic startup
Nuxeo EP 5.3 305

OpenOffice.org server installation
Depending on configuration the OOo Server may be started automatically when Nuxeo starts or on first
call.
• OpenOffice server instances pooling
Daemon can manage several OpenOffice instance (workers) and distribute tasks across them. In order to
avoid leaks, OOo workers are recycled.
46.2.2. Configuring Nuxeo OOo Daemon

Configuration is done via an xml extension point. Defaut config can be editer in file located in
nuxeo.ear/config/ooo-config.xml.
<component name="org.nuxeo.ecm.platform.convert.oooDaemon.config.default">
<extension target="org.nuxeo.ecm.platform.convert.oooserver.OOoDaemonManagerComponent"
point="oooServerConfig">
<OOoServer>

<enableDaemon>true</enableDaemon>

<oooListenIP>127.0.0.1</oooListenIP>

<oooListenPort>8100</oooListenPort>

<oooDaemonListenPort>8101</oooDaemonListenPort>

<oooWorkers>1</oooWorkers>






<autoStart>false</autoStart>
</OOoServer>
</extension>
</component>
In most cases, you should not have to define the location of your OpenOffice installation as the Daemon will
try to find it in the standard installation path.
If you want to use OpenOffice 3.x, you have to specify the jpipeLibPath in order to enable jpipe that is used by
the Daemon to communicate with OpenOffice workers.
Nuxeo EP 5.3 306

Chapter 47. Run Nuxeo EP with a specific IP binding
To be able to call the Nuxeo Services remotely using the Nuxeo Framework (e.g. when using Nuxeo RCP), you
will need to bind an IP address when running the server. To do this, a few step are needed:
• in $JBOSS_HOME/server/default/deploy/nuxeo.ear/config/nuxeo.properties change the value of
org.nuxeo.ecm.instance.host, replace "localhost" by the IP address of the JBoss server,
• in $JBOSS_HOME/server/default/deploy/nuxeo.ear/config/platform-config.xml
mono-server: ${org.nuxeo.ecm.instance.host} is used to reference address set in nuxeo.properties
multi-server: either use IP or set DNS aliases in your hosts file (default names in Nuxeo packages are
usually something like nxcoreserver, nxsearchserver, nxplatformserver, nxjmsserver, nxwebserver,
nxdbserver).
• in $JBOSS_HOME/server/default/deploy/nuxeo.ear/config/datasources/core-events-ds.xml
replace, if enabled, the 127.0.0.1 value of java.naming.provider.url by the IP address of the Jboss
server,
• start jboss with the -b option:
./run.sh -b server_IP_address
IP behavior change between JBoss 4.0.x and JBoss 4.2.x

When no IP is specified, JBoss 4.0 is bound to listening on any address, not only on localhost.
For obvious security reasons, JBoss 4.2 (version required by Nuxeo EP 5.2) has a different
behavior. If you still want this, use -b 0.0.0.0
For a server in production, see SecureJBoss.
Nuxeo EP 5.3 307

Chapter 48. Backup, restore and reset
Note
For server migration (moving a Nuxeo instance from a server to another), follow the backup
procedure on the source server and then the restore procedure on the destination server.
Note
Nuxeo-shell may be used for import/export purpose but it's not the same as the "system backup"
described here.
48.1. Backup
Important
It is highly recommended to stop nuxeo during backup.
If you use a database, you may switch it in a "hot backup" mode to ensure that all new incoming
requests will wait the end of the backup process.
Backup these directories and files:

• Nuxeo libraries deployed in JBoss as they are specific to the running Nuxeo EP version
$JBOSS/server/default/lib/nuxeo*
• Nuxeo EP EAR (Entreprise ARchive)
$JBOSS/server/default/deploy/nuxeo.ear/
• data stored on filesystem
$JBOSS/server/default/data/
• it could be useful to backup logs
$JBOSS/server/default/log/
Backup your database(s) if you use one (some).
Finally, backup any file you have customized. Here is a short list of such files :
• if you changed JVM startup parameters (run.bat, run.conf) or use Nuxeo's startup script (jbossctl,
jbossctl.conf, bind.conf)
$JBOSS/server/bin
• if you changed the logging levels (log4j.xml)
$JBOSS/server/default/conf
• if you added some .jar files for specific JDBC drivers
$JBOSS/server/default/lib
• if you changed JBoss configuration (like mail-service.xml)
Nuxeo EP 5.3 308

Backup, restore and reset
$JBOSS/server/default/deploy
48.2. Backup before an upgrade

If you plan an upgrade, you may backup separately the configuration files in order to easily apply again your
configuration on the default one (take care not to loose any evolution on these files):
• Main configuration is in $JBOSS/server/default/deploy/nuxeo.ear/config
• Datasources are defined in $JBOSS/server/default/deploy/nuxeo.ear/datasources
• Compass backend is configured in

$JBOSS/server/default/deploy/nuxeo.ear/system/nuxeo-platform-search-compass-plugin*/compass.cfg.xm
48.3. Restore
All you need is to restore previously saved database(s), files and directories.
48.4. Reset
You can simply reset Nuxeo by removing its data: delete $JBOSS/server/default/data/ and empty all used
databases. On start, Nuxeo EP recreates all its tables, files and directories.
Nuxeo EP 5.3 309

Chapter 49. Offline client synchronization
Note
This procedure applies only for clients working in read-only mode. Otherwise, the synchronization
procedures are failing.
49.1. Working environment

The environment contains 2 Nuxeo servers. One of them (further named "offline server") is the Client machine
working in read-only mode. The second (further named "online server") is the base Nuxeo server. The user
wants to have on own offline server a replication of the documents on online server so the user can consult
them (not to modify) offline.
The target is to upload on offline server the entire set of visible documents for user from online server.
Subsequent synchronizations should require minimum amount of data transfer.
The online server synchronization module is the nuxeo-platform-sync-server project, available as addon. It is
enough to deploy it to have the feature enabled.
The offline server needs:

• nuxeo-platform-sync-client-api, nuxeo-platform-sync-client-core. nuxeo-platform-sync-client-web,
available as addons, deployed
• flag org.nuxeo.ecm.webapp.readonly.mode set true in the nuxeo.properties.
49.2. Use case

As user I want to be able to synchronize my offline server.
Step 1: An empty mini Nuxeo server is used.
Step 2: Using the synchro GUI, the mini Nuxeo server is configured to connect to online server. The
mini-server is updated.
Step 3: User checks to see that all accessible documents are available offline
Step 4: Using the same synchro UI, further synchronization are effective.
49.3. User guide

The offline server user logs in and navigates to "Synchronize" page (following the link in top tool list). The
user provides the credentials on the server, starts the synchronizations and, on completion, if required, logs in
back with the new credentials.
49.4. How does it work?

The data workflow on server is simple:
• WS Addressing webservice is made available by the server to allow client requests: the current situation
and the DocumetnSnapshot of a particular document. The blobs are requested through a restlet.
• ExportRestlets are provided to download relations in RDF format and directories XML based custom
encoded.
Nuxeo EP 5.3 310

Offline client synchronization
The data workflow on client is a little more complicated, as the client is responsible to decide what documents
need to be updated:
• The module is able to obtain the webservice SEI based on the provided credentials. With this, the module
requests for server the tuples describing the current situation, or the DocumentSnapshot of a particular
document.
• Also, the query ran on server is provided to client in order to have the same scope of documents
synchronized.
• Servers runs the query with the user credentials and provides a list of tuples containing: the document id,
path, type (including version / proxy selector), modification date, context data for allowing import. Client
compares the list with the current situation running the same query.
• First it removes the documents no longer available.
• After it adds the new documents (in order: usual documents, versions, proxies).
• And finally it updates the documents modified.
The documents are added through Core import, allowing preserving the document ID. Also, this method allows
to "add" proxies and versions easily. The update of documents is made in several steps:
• first, the client requests the FlagedDocumentSnapshot (a DocumentSnapshot + the hasBlobs flag) on
synchro webservice;
• the DocumentSnapshot map of properties are set on the local document using a mechanism very likely
with the core import/export;
• if the document has blobs, client makes request to ExportRestlet for the document export;
• the Client reads the document.xml and the blob files received and adds them in the document.
The vocabularies and relations are exported entirely and also are imported by replacing existing ones.
Note
Known bug: in the case of security wholes in the tree, the offline server can end up in an undefined
state. For instance: user has read rights on Workpspace A, not on Folder B below and has on Folder
C below. The Folder C can't be created on offline server as Folder B is not supplied from server.
Nuxeo EP 5.3 311

Chapter 50. Replication tool
50.1. Functional Objective

The system replication feature aims to clone entire collection of data existing in a Nuxeo system. Consequently
the clone has to be importable in another system leading to a complete replication of the system. Such feature is
obviously an important gain because it allows:
• complete backup of system
• complete data migration
• replication of complex systems
Three projects are designed to accomplish the objectives:

• common modules
• export modules
• import modules
The export module is also ported on 5.1, allowing migration from older storages to current supported Nuxeo
deployment.
50.2. Use cases

• UC1 System backup
As administrator I want to make a backup of the system
1. Administrator is managing a complex Nuxeo system (including: users, document base, relations, etc.)
2. Administrator ensures that for the time the replication occurs no actions are performed on server (no
user connects, change documents, etc.)
3. Administrator starts the system export. No other actions are performed.
4. Administrator acknowledges the finish of the replication and the results. The UI and the server log
provides the right information.
5. The archive is stored safely.
• UC2 Data migration 5.1 to 5.2
As Administrator I want to migrate 5.1 server to 5.2 server
1. Administrator is managing a complex Nuxeo 5.1 system (including: users, document base, relations,
etc.) and has a fresh new installed 5.2 system
2. Administrator ensures that for the time the replication occurs no actions are performed on server (no
user connects, change documents, etc.) on both servers
3. Administrator starts the 5.1 system export. No other actions are performed.
Nuxeo EP 5.3 312

Replication tool
4. Administrator acknowledges the finish of the replication and the results. The UI and the server log
provides the right information.
5. Administrator copies the clone on a fresh new Nuxeo 5.2 machine.
6. Administrator starts the import of the clone. No other actions are performed.
7. Administrator acknowledges the finish of the import and the results. The UI and the server log provides
the right information.
8. As result, the new Nuxeo system is a perfect replication of the initial one.
• UC3 Backup import
As Administrator I want to import an older backup.
1. Administrator is managing a Nuxeo 5.2 system (including: users, document base, relations, etc.) and has
an older backup archive
2. Administrator ensures that for the time the import occurs no actions are performed on server (no user
connects, change documents, etc.)
3. Administrator optionally cleans up the DB before import.
4. Administrator starts the import of the clone. No other actions are performed.
5. Administrator acknowledges the finish of the import and the results. The UI and the server log provides
the right information.
6. As result, the new Nuxeo system is a perfect replication of the initial one.
50.3. User guide

A complete user guide can be found at http://doc.nuxeo.org/xwiki/bin/view/FAQ/ReplicateNuxeoRepository
50.4. How does it work?

The Nuxeo system contains a heterogeneous collection of data.
In this moment the following type of objects are considered:

• documentary base
• usual documents (workspaces and templates content, comments, tags, etc.)
• versions (the checked in documents)
• proxies (published documents)
• relation graphs
• vocabularies (excluding groups and users)
• groups and users
Nuxeo EP 5.3 313

Replication tool
• different other tables (audit, tagging, etc.)
The approach needs to be different in the case of each type.
A special attention must be paid to the Seam and core sessions. Long operations could be broken by the Seam
context. Thinking of repositories with 200,000 documents and more the Seam session is not suitable.
Also data as relations or vocabularies are easier to manage through already existing services, meaning the need
of container context.
The super user context is always used.
The export and import need to be considered one along the other.
Transaction management
In a JEE environment, we must take care of the transactions in order to:

• avoid timeouts avoid filling up the transaction cache (ex : prepare statement in case of PGSQL)
• avoid letting the DataSource in a dirty state
As general TX guideline, we must handle transactions during import/export by hand (not let the container do it)
by controlling the core session. We must handle batches (ie : commit any X documents is the DB is in a clean
state). During the export, since we don't write into Nuxeo, TX is not that important. During import TX
management is very important. It is important to maintain the right order in importing resources. Also, the
import must be done one by one or in small chunks. The resume log MUST be in sync with the TX
management : only batches that are successful must be logged.
Replication directory structure
/Replication Root
/Documentary Base
/Usual Documents
/Workspaces
/workspace1
/folder1
.........................
/Templates
.........................
/Versions
/version1 ID
.........................
/Relations
/graph1
.........................
Nuxeo EP 5.3 314

Replication tool
/Vocabularies
/directory1
.........................
/Groups
/group1
.........................
/Users
/user1
.........................
/Tables
/Audit
/Tagging
Anyway, storing the document in a FS tree is a good idea:

• avoid FS problems (too may children)
• allow easy multi-threading import
The system replication is made inside a single directory named “Replication Root”. Under it, “Documentary
Base” contains the documents. Under it, the “Usual documents” contains the repository exported muck likely
the export utility. The file names are the names of the documents. The path of Nuxeo documents is unique, so it
can be used without worrying of duplicates. We can find the usual documents exported, with blobs offline, with
a new ACL encoded export for each document (inside the usual document.xml file). The lifecycle state is
already saved in the document export). And also a new file named “import.export” containing the contextual
metadata required for core import. Under “Documentary Base” the “Versions” folder contains the checked in
versions. The versions are exported as the usual documents with proper metadata for core import. All versions
are exported flat in directories named as their ID. The proxy documents are exported amongst the usual
documents. They should only contain the core export-import metadata, these being enough for reconstructing
the proxy.
Under “Relations” every graph is RDF exported as “rdf.xml” under the graph name folder.
Under “Vocabularies” every directory is custom XML exported as “vocabulary.xml” under the directory name
folder.
Under “Groups” and “Users” the existing entities are saved in folders named by the entity name. Inside every
directory a custom XML file “user.xml” or “group.xml” file is holding the Nuxeo specific data on the entity
(see NuxeoPrincipal and NuxeoGroup).
Under “Tables” the existing and named tables are CSV exported.
The user has to provide the name of repository to be exported. The service itself creates a new thread to run the
export, respectively the import, and returns immediately in the bean.
The import occurs actually in 2 stages: first the document is core imported (in order to ensure the ID
preservation) using the contextual metadata; and after the actual import occurs (including the ACL). Data
migration may include additional steps. Because there were some schema changes between Nuxeo versions
data exported form a version 5.1.X may need to be modified before being imported into a 5.2. For this, we have
a 3 steps pipe : export from source; apply transformations; import transformed data. Before actual import, a
transformer can be contributed as Java extension mechanism. The transformer receives the exported document
XML representation and can touch it in any way. The resulted XML is later used in import instead of original
Nuxeo EP 5.3 315

Replication tool
one.
50.5. Customizing the import code

2 interfaces are provided to allow customizing the code behavior when doing the import.
• org.nuxeo.ecm.platform.replication.importer.DocumentXmlTransformer. It allows to transform the XML
document structure, as it was exported, just before importing. It offers the chance to touch the document
XML representation (as in Core IO export form). The transformation occurs in memory directly in the
DOM document. If it fails (with exception or null is returned) the initial structure is used. The default
implementation does nothing.
• org.nuxeo.ecm.platform.replication.importer.DocumentTypeSelector. It allows to decide if a particular

document gets imported or not based on the type selection. The default implementation rejects the type
"UserDataRoot".
In order to use it just set the custom implementation before running import in the service through the setter.
Nuxeo EP 5.3 316

Chapter 51. Monitoring Nuxeo
To monitor an application, you follow a set of values over a period of time and make sure some values don't go
over or under a certain threshold. The value can be the available memory, the number of file open, usage of
datasources ...
Inside JBoss, modules (called MBean) use an internal JMX server to communicate. Nuxeo, JBoss or the JVM
can use the MBean server to publish interesting data. Those data are then available by querying the JMX server.
To be able to monitor Nuxeo you need to:

• Configure Nuxeo so JBoss, Nuxeo and the JVM publish their information to the same JMX server. (
Section 51.1, “Configure Nuxeo to use a single JMX server.” )
• Choose the data you want to monitor. ( Section 51.2, “Interesting data to monitor.” )
• Retrieve information from the JMX Server by:
• persisting it on the server for later retrieval/analysis. ( Section 51.3, “Persisting and analysing data.” )
• using a tool to query the JMX server remotely. ( Section 51.4, “Querying the JMX server remotely” )
51.1. Configure Nuxeo to use a single JMX server.
51.1.1. Configuration from Nuxeo 5.3.0

The configuration is not specific to Nuxeo. JBoss documentation is available here
A JMX server allows communication between different MBean. From Java 5, a JMX server is included in the
JVM. JBoss creates its own JMX server. To set JBoss so it uses the same JMX server than the JVM and to be
able to connect to it, you need modify the command line to launch JBoss
For a linux distribution you need to add to run.conf:

# Enable the jconsole agent locally
JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote"
# Tell JBossAS to use the platform MBean server
JAVA_OPTS="$JAVA_OPTS -Djboss.platform.mbeanserver"
# Make the platform MBean server able to work with JBossAS MBeans
JAVA_OPTS="$JAVA_OPTS -Djavax.management.builder.initial=org.jboss.system.server.jmx.MBeanServerBuilderImpl"
For Windows, you need to add to run.bat:

%JAVA_OPTS% -Dcom.sun.management.jmxremote
set JAVA_OPTS=%JAVA_OPTS% -Djboss.platform.mbeanserver
set JAVA_OPTS=%JAVA_OPTS% -Djavax.management.builder.initial=org.jboss.system.server.jmx.MBeanServerBuilderImpl
Because of a bug in jboss-cache, it is necessary to replace jboss-cache by a patched version. You need to
replace:
$JBOSS/server/default/deploy/nuxeo.ear/lib/jboss-cache-jdk50-1.4.0.SP1.jar
by the version available here
51.1.2. Configuration for Nuxeo 5.2.0

To configure for Nuxeo 5.2.0, you first need to follow the configuration for 5.3.0 ( Section 51.1.1,
“Configuration from Nuxeo 5.3.0”). You also need to modify the file
$JBOSS/server/default/deploy/nuxeo.ear/config/nuxeo.properties, set the value:
Nuxeo EP 5.3 317

Monitoring Nuxeo
org.nuxeo.runtime.management.exist=true
51.1.3. Configuration for Nuxeo before 5.2.0

To use a version before the 5.2.0, you need to follow the configuration for 5.2.0 ( Section 51.1.2,
“Configuration for Nuxeo 5.2.0” ). You also need to add the management jar to Nuxeo. Download the jar and
put it in the folder $JBoss/server/default/deploy/nuxeo.ear/plugins.
51.2. Interesting data to monitor.

Once you have set up monitoring, you can access all the MBean. The easiest is to open the jmx console:
http://localhost:8080/jmx-console. The interesting bean are (some information are available in multiple
MBean):
• jboss.ca:name=<DS name>,service=ManagedConnectionPool has attribute: ConnectionCount,
ConnectionDestroyedCount, ConnectionCreatedCount, AvailableConnectionCount,
InUseConnectionCount
• jboss.mq:service=DestinationManager has statistics attribute about JMS messages. (Important for Nuxeo
previous to 5.2.0)
• jboss.system:type=ServerInfo has operation: listMemoryPools (to check memory

usage),listThreadCpuUtilization and listThreadDump (this operation is usefull to find the root of a
problem)
• jboss.web:name=http-0.0.0.0-8080,type=ThreadPool shows currentThreadCount, currentThreadsBusy

and maxThreads
• java.lang:name=***,type=*** shows usage and peak useage of memory pools
• java.lang:type=Memory shows the memory usage.
• java.lang:type=OperatingSystem shows OpenFileDescriptorCount (to compare with

MaxFileDescriptorCount).
• jboss.web:host=localhost,path=/nuxeo,type=Manager shows the number of active sessions, the total

number of sessions.
You can also publish any Nuxeo Service as MBean so they will be easy to monitor. For more information you
can look at Chapter 27, Nuxeo's Management Service.
51.3. Persisting and analysing data.

This FAQ explains how to persist MBean to a file and how to analyse the log.
51.4. Querying the JMX server remotely

JBoss comes bundle with a command line tools called twiddle. Twiddle allows to connect to a remote JBoss to
query the JMX Server. It makes it the perfect tools to use with monitoring application such as Nagios.
To query a MBean using twiddle run:

twiddle.sh -s <URL> get <MBean Name>
The output can then easily be parsed.
Nuxeo EP 5.3 318

Monitoring Nuxeo
Nuxeo EP 5.3 319

Chapter 52. The Nuxeo Shell
52.1. Overview
The Nuxeo Shell is a command line tool for everyone who needs simple and quick remote access to a Nuxeo
EP server. You can see it as the Swiss army knife for the Nuxeo EP world. It can be used by regular users to
browse or modify content, by advanced users to administrate Nuxeo servers, or by programmers to test and
debug.
The Nuxeo Shell is designed as an intuitive and extensible command line application. It can both serve as a
user, administrator or programmer tool, or as a framework to develop new Nuxeo command line clients.
The application is based on the Nuxeo Runtime framework and thus offers the same extension point mechanism
you can find on the server application.
The main features of the command line tool are:

• Two operating modes: an interactive and a batch mode.
• Advanced command line editing like:
• auto-completion
• command history
• command line colors
• command line shortcuts like: CTRL+K, CTR+A, etc.
• JSR223 scripting integration. You can thus connect and execute commands on a Nuxeo server in pure
scripting mode.
• Extensibility - using Nuxeo Runtime extension points
The advanced command line handling is done using the JLine library.
The only requirement is Java 5+. The tool works on any Unix-like OS, on Windows and on Mac OS X.
52.2. User Manual

The Nuxeo Shell application is packaged as a zip archive. To install it, you need to unzip and copy the content
in a folder.
The application folder structure is as follow:

+ nxshell
+ app
+ bundles
+ config
+ data
+ lib
+ lib
- Launcher.class
- log4j.properties
- launcher.properties
- nxshell.sh
• The lib folder contains JARs needed by the application launcher. The Launcher.class is the application
launcher and launcher.properties contains configuration for the launcher.
• log4j.properties is as you expect the configuration for log4j.
Nuxeo EP 5.3 320

The Nuxeo Shell
• nxshell.sh is a shell script that launches the application.
• The app folder contains the application code and data.
• app/bundles contains the application OSGi bundles. These bundles will be deployed using a minimal
implementation of OSGi (the same that is used on the server side). We may replace the default
implementation by equinox later.
• app/lib contains third party libraries needed by the application bundles.
• app/config contains the application configuration files.
• app/data contains temporary data.
The only file you may need to change is the nxshell.sh script. Here is the content of this file:
#!/bin/bash
#JAVA_OPTS="$JAVA_OPTS -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8788,server=y,suspend=y"
JAVA_OPTS="$JAVA_OPTS -Dorg.nuxeo.runtime.1.3.3.streaming.port=3233"
java $JAVA_OPTS Launcher launcher.properties $@
If you uncomment the first line, you will be able to run Nuxeo Shell in debug mode.
The second line [must] be commented out if on the server you are running on a nuxeo runtime
1.4.SNAPSHOT. When running against Nuxeo EP 5.1 you need to let this uncommented.
You can run the application in two modes:

1. In batch mode - in this mode you specify the command that will be executed. After the command
execution the process will exit. The command has to be passed as the first argument.
Here is an example of a command executed in batch mode:
$ ./nxclient.sh export /path/to/remote/doc /path/to/local/folder
Here is an example of a command executed in batch mode while also passing parameters:
$ ./nxclient.sh ls --host 192.168.2.54
2. In interactive mode - in this mode you can share a single session to run multiple commands against the
remote Nuxeo EP. To start the application in that mode you should run the interactive command in one
of two ways:
$ ./nxclient.sh interactive
$ ./nxshell.sh
After entering in interactive mode a command prompt will be displayed. At this prompt you can enter
commands in the same way you specify them on the command line in batch mode.
When not connected to a server, the prompt will be displayed as:
|>
After connecting to a server named, let's say "nuxeo-platform", the prompt will be
Nuxeo EP 5.3 321

The Nuxeo Shell
displayed as:
|nuxeo-platform>
So, as we've seen in the above examples, executing a command is done by using the following syntax:
command [options] [parameters]
where options and parameters are optional and are specific to the command you run.
Example:
import -u /path/to/doc /path/to/local_file
In this case "import" is the command, "-u" is a flag option and "path/to/doc" and "/path/to/local_file" are both
parameters
Parameters are stand alone arguments (they are not bound to a specific option) and can be retrieved
programmatically using their index. In the example above, the first parameter will have the index 0 while the
second the index 1.
52.2.1. Command Options

Command options are defined by a name and optionally a shortcut (a short name). When referring to an option
using its name you should prefix it by two hyphens '--'. When using short names you should only use one
hyphen as a prefix. For example if you have an option named "host" and using a short name of "h" the
following commands are equivalent:
$ ./nxshell.sh interactive -h localhost

$ ./nxshell.sh interactive --host localhost
Options may take values or may be used as flags turning on / off a specific option by their simple presence.
When using long names you should specify the option values immediately after the option. However when
using short names you can group options together. Let say for example we have a command that support 4
options: a, v, i, o. a and v are flag options and both i and o takes an argument as value. In this case the you can
group options like the following:
command -avi in_file -o out_file
or
command -avio in_file out_file
or anyhow you want. You should keep in mind that when grouping options that take arguments, these
arguments will be assigned to each of this options in the order they were specified on the command line.
52.2.1.1. Global Options
Besides the specific options that commands may define, there are several global options that apply to all
commands. These are:
• host (--host or -h) the Nuxeo EP host where to connect - defaults to localhost
Nuxeo EP 5.3 322

The Nuxeo Shell
• port (--port or -p) the Nuxeo EP port where to connect - defaults to 62474
• username (--username or -u) the username to use - defaults to the "system" user
• password (--password or -P) the password to use
• debug (--debug or -d) to start with debug mode (logs at DEBUG level)
52.2.2. Commands
There is the list of all built-in commands of nuxeo shell.
Notes:
1. At the time of this writing some of these built-in commands are not yet implemented. Those are be
marked with an asterisk (*).
2. The commands can be grouped in two categories:
• offline commands - command that doesn't need a connection to work. Example: help, log etc.
• online commands - commands that requires a connection to work. These commands are automatically
connecting if no connection is currently established.
3. Some commands make no sense and are not available in both modes (batch and interactive). This will be
specified by each command if it is the case.
52.2.2.1. interactive
Runs in the interactive mode. This command is not available when already in interactive mode.
Has no specific options.
$ ./nxshell.sh interactive
52.2.2.2. help
Displays the help page.
Takes an optional parameter which is the name of a command.
By default, displays the global help page. If a command is given as an argument, displays the help page for that
command.
$ ./nxshell.sh help ls
52.2.2.3. log
Manage logs from console without having to edit log4j.xml. Allow to switch on/off a debug mode, add/remove
loggers, ...
log filename [log level [package or class]] creates a file (created in $PWD/log/ if filename do not contain path
separator, else given path is used). It will record logs at level greater or equal to level (if specified, else default
level is INFO; available values are TRACE, DEBUG, INFO, WARN, ERROR, FATAL). If a package or a
class (canonical name) is specified, logs will be filtered from this package/class.
Nuxeo EP 5.3 323

The Nuxeo Shell
log off [package or class] stops logging. Applies on all custom appenders (console and filenames) if no
package or class is specified. Don't worry about the warning log off command may cause (the logger is
re-created):
log4j:WARN No appenders could be found for logger (org.nuxeo.ecm.shell.commands.InteractiveCommand).
log4j:WARN Please initialize the log4j system properly.
log debug switches debug mode on/off. Same result as starting the shell with -d (--debug) option. This
decrease the log level to DEBUG on console and filenames.
See log4j documentation for more information.
Available only in interactive mode
52.2.2.4. connect *
Connects to a given server. If a connection is already established, close it first.
52.2.2.5. disconnect *
Disconnects from the current connected server. If no connection exists, does nothing.
52.2.2.6. ls
Lists the children of the current folder in the repository.
By default, Folderish types are displayed in blue.
Note that the ls directory-name command is accepted but won't list the content of directory-name, it will
only list the content of the current directory. This might be improved in the future to provide a behavior alike
the one of the Unix ls command.
52.2.2.7. tree
Displays the complete tree structure of the documents as it would be returned by the Unix tree command.
52.2.2.8. cd
Changes the current directory in the repository (to a Folderish document)
52.2.2.9. pwd
Displays the current path in the repository.
52.2.2.10. view
Views info about document. The information displayed can be controlled using these command options:
--all (-a) - view all data
--system (-s) - view only the system data
Nuxeo EP 5.3 324

The Nuxeo Shell
--acp - view the ACLs on that document
52.2.2.11. rm
Removes a document or a tree of documents.
52.2.2.12. mkdir
Creates a Folder document.
52.2.2.13. put
Uploads a blob to a file document. If the target document doesn't exists, creates it.
52.2.2.14. putx
Creates a document other than a file. Metadata (and blobs) are specified in the Nuxeo export format.
52.2.2.15. get
Downloads the blob from a File document.
52.2.2.16. getx
Gets a document as an XML file (as export, but only for a document).
52.2.2.17. export
Exports documents from the repository.
52.2.2.18. import
Imports documents into the repository.
52.2.2.19. script
Makes it possible to run external scripts. Here are examples of such scripts.
From interactive mode use:
script --file <path_to_your_script> <args>
52.2.2.20. chperm *
Changes a privilege on the given document.
52.2.2.21. useradd
Creates new user(s).
To create user joe:
useradd joe
To create the users define in the users.csv CSV file:
Nuxeo EP 5.3 325

The Nuxeo Shell
useradd --file users.csv
52.2.2.22. groupadd *
Creates new group(s).
52.2.2.23. groupmod
Modifies a group
To add user joe to the company-service1 group:
groupmod --user joe company-service1
To set the users of the company-service1 group to be only joe
groupmod --set --user madarche company-service1
To add the users in the users_for_group.csv CSV file to the company-service1 group:
groupmod --file users_for_group.csv company-service1
To set the users of the company-service1 group to be the users define in the users_for_group.csv CSV file:
groupmod --file users_for_group.csv company-service1
52.2.2.24. select
Search the repository using the NXQL query language. For example:
select * from Document where ...
This command can be used as a starting point to write another script to perform search service queries if
needed.
This command is only available in the Nuxeo 5.2 branch.
52.2.2.25. lstypes *
52.2.2.26. viewtype *
52.2.2.27. lsusers *
52.2.2.28. lsgroups *
52.2.2.29. viewuser *
Nuxeo EP 5.3 326

The Nuxeo Shell
52.2.2.30. viewgroup *
52.3. Troubleshooting
52.3.1. Check listened IP

Be sure on what precise IP address and what precise port the server is listening to. To find out, use the netstat
command on the server host. The example below shows that, on the same host, there are 2 servers listening on
the 62474 port but on different IP addresses. You should always use as arguments to the nuxeo shell the exact
IP address and port you find out.
$ sudo netstat -ntlap | grep 62474

tcp 0 0 ::ffff:192.0.0.11:62474 :::* LISTEN 3623/java
tcp 0 0 ::ffff:192.0.0.10:62474 :::* LISTEN 1346/java
Alternatively you can use the lsof command.
$ sudo lsof -i :62474

COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
java 3623 jboss 266u IPv6 0x5d69a70 0t0 TCP [::192.0.0.11]:62474 (LISTEN)
java 1346 jboss 266u IPv6 0x5d7af30 0t0 TCP [::192.0.0.10]:62474 (LISTEN)
52.3.2. Check connected server

Be sure to be connected on the right server. To do so, issue a view command. This will display information on
the current context:
192.0.0.10> view
--------------------------------------------------------------------
UID: 2a13db70-f133-473c-9a90-6838d01610aa
Path: /
Type: Root
--------------------------------------------------------------------
Title: 2a13db70-f133-473c-9a90-6838d01610aa
Author: null
Created: null
Last Modified: null
--------------------------------------------------------------------
Description: 2a13db70-f133-473c-9a90-6838d01610aa
--------------------------------------------------------------------
52.3.3. Multi-machine case

When working with multi-machine installation, connect the Nuxeo Shell on the server running Nuxeo Core (i.e.
the stateful server on a bi-machine configuration).
52.4. Extending the shell

If you a need a new command (a new functionality) not provided by the Nuxeo Shell, you can add it very
simply by writing a Nuxeo plugin in exactly the same manner you would for a Nuxeo server instance. This is
done by writing a Java class for each new shell command and declaring (that is registering) each command in a
single XML file as a contribution to an extension point.
Here is an example of how to register two imaginary new custom commands addapplicants and
purgeobsoletedocs.
Nuxeo EP 5.3 327

The Nuxeo Shell
52.4.1. Registering New Custom Commands

This is how to register the new commands:
<component name="com.company.nuxeo.shellcommands" version="1.0">
<documentation>
Extra Nuxeo Shell commands shown as examples for the Nuxeo Book.
</documentation>
<extension target="org.nuxeo.ecm.shell.CommandLineService" point="commands">
<command name="purgeobsoletedocs" class="com.company.nuxeo.shellcommands.ObsoleteDocsPurgeCommand">
<description>
Purge obsolete documents considering based on predefined hard-coded logic.
</description>
<help>Purge obsolete documents</help>
</command>
<command name="addapplicants" class="com.company.nuxeo.shellcommands.ApplicantsAdderCommand">
<description>
Adds applicants by creating the right folders with the right permissions.
</description>
<params>
<param index="0" type="path" />
</params>
<help>Adds applicants</help>
</command>
</extension>
</component>
52.4.2. Java Code for the new commands

This is how to write a Java class for a new command:
public class ApplicantsAdderCommand extends AbstractCommand {

public static final String COMMAND_NAME = "addApplicants";
public void run(CommandLine cmdLine) throws Exception {
String[] elements = cmdLine.getParameters();
// parse command line
if (elements.length != 1) {
log.error("Usage: " + COMMAND_NAME + " file");
return;
}
File file = new File(elements[0]);
addApplicants([...]);
}
void addApplicants([...]) {
}
}
52.4.3. Building the shell plugin

Finally the pom.xml file for the plugin to the Nuxeo shell needs to at least contain the following dependency to
be able to build extend the AbstractCommand class. Building the plugin will generate a XXX.jar file. Note that
you should of course replace the version given as an example with the version suited for your need.
<dependencies>
[...]
Nuxeo EP 5.3 328

The Nuxeo Shell
<dependency>
<groupId>org.nuxeo.ecm.platform</groupId>
<artifactId>nuxeo-shell-commands-base</artifactId>
<version>5.1.7-SNAPSHOT</version>
</dependency>
[...]
</dependencies>
52.4.4. Deploying the shell plugin

1. Install or decide on using a nuxeo shell already installed program.
2. Copy the generated XXX.jar file into the bundles directory of the nuxeo shell installed program.
3. Delete the data directory, if there is any, of the nuxeo installed program. This is to purge any caching of
registered JARs.
The next time the nuxeo shell is restarted your new commands will be available.
Nuxeo EP 5.3 329

Chapter 53. Build Nuxeo distributions from sources
A few default distributions are available from download. You can either personalize them, either build your
own distribution from sources.
53.1. Requirements
In order to build Nuxeo sources, you need Ant, Maven 2.0.10, SubVersion (svn), Mercurial, Java Sun 5/6.
See core developer chapter in Nuxeo EP Book - The Reference for more details.
53.2. Limitations
Some of the available packages are still in development (GlassFish, Jetty, ...).
Acceptance tests and Continuous Integration are mainly focused on Nuxeo Document Management under
JBoss.
53.3. Download Nuxeo distribution sources
53.3.1. Download archive

Nuxeo distribution 5.2 ZIP archive
53.3.2. Download sources with Mercurial

hg clone http://hg.nuxeo.org/nuxeo/nuxeo-distribution#5.2
53.4. Build from sources

See README file at root of nuxeo-distribution for a short description and common usage examples.
53.4.1. Available packages
• nuxeo-platform-ear: Nuxeo Enterprise Platform EAR
• nuxeo-distribution-dm: Nuxeo Document Management EAR
• nuxeo-distribution-jboss: JBoss containing Nuxeo EP or DM EAR
• nuxeo-distribution-shell: Nuxeo Shell
• nuxeo-distribution-gf3: GlassFish distribution
• nuxeo-distribution-jetty:Jetty containing Nuxeo EP or DM
• nuxeo-distribution-tomcat: Tomcat distribution
• nuxeo-distribution-windows: Windows installer of nuxeo-distribution-jboss
Nuxeo EP 5.3 330

Build Nuxeo distributions from sources
53.4.2. Usage
With Ant: "ant distrib [-Ddistrib=PROFILE,BACKEND]".
With Maven: "mvn clean install package -PPROFILE -Dmaven.test.skip=true".
Nuxeo EP 5.3 331

Part VI. Core developer guide
Nuxeo EP 5.3 332

Chapter 54. Coding and Design Guidelines
54.1. Introduction
"Follow a common coding standard, so that all the code in the system looks as if it was written
by a single — very competent — individual. The specifics of the standard are not important:
what is important is that all the code looks familiar, in support of collective ownership."
—Ron Jeffries XProgramming.com
Coding Standards are a good idea. Every team should adopt a coding style and standard, and
stick to it. The code produced by that team should have a consistent look and feel that is devoid
of individual preferences and fetishes.
—"Uncle" Bob Martin ObjectMentor website
The primary goal of this chapter is to provide common conventions, as well as guidelines that aim at ensuring a
high level of quality (with respect to maintainability, extensibility, modularity, security, testability,
documentation, etc.) throughout the Nuxeo project.
As such, it is primarily written for the platform's developers, both "core" developers and contributors, and
developers that write extension modules that will someday find a place in the Nuxeo codebase.
If you're working on your own project with no plan to contribute code to the Nuxeo platform, you will probably
be still interested in reading this chapter, and adapt the conventions stated here to your company's or
organization's own coding standards.
54.2. External Coding Standards

Rewriting a whole coding standard for the Nuxeo project would be a poor use of our time, since there are
already several documents and books that do a fine job in this respect.
We've opted for a more pragmatic, two-pronged approach:

1. reference reputable external guides or books, and document any difference
2. propose default settings for common Eclipse tools (including the built-in code formatter and the
CheckStyle plugin), tuned to comply to these conventions.
The official coding standard for the project is: "The Elements of Java Style" [Vermeulen2000] which is a little
book that can be bought from Amazon or other book dealers.
If a PDF suits you better, you can download an earlier version of the book from here.
Note however that these guidelines have been written in 2000 (last century!) and some of the recommendations
need the be updated in light of this millenium's experience.
54.3. Some points that need attention
54.3.1. Java code formating

Readability counts.
—Tim Peters The Zen of Python
Java code should be formatted using Sun's Code Conventions for the Java Programming Language.
Nuxeo EP 5.3 333

Coding and Design Guidelines
Regarding code formatting (which is just one small part of the book and PDF mentioned above), we'll be using
the standard Eclipse default style, with a couple of minor tweaks (see this README.txt for how to configure
Eclipse to support this style).
The major points are:

• 4 spaces (no tabs!!!) indentation
• spaces before and after = signs and most binary operators
• spaces after ,
• no space after ( or before )
• regarding code block, we are using 1TBS ("One True Brace") style:
Bad:
if (xxx)
{
yyy
}
Good:
if (xxx) {
yyy
}
• make a block even for only one statement:
Bad:
if someThing() doSomething;
if someThing()
doSomething;
Good:
if someTest() {
doSomething;
}
• Don't prefix your instance variables by "this." when it's not mandatory.
Why? Because with modern IDEs, instance variables are typeset in a different color than local variables,
hence you don't need the extra information provided by the "this." prefix to recognize which is which.)
• etc.
54.3.2. XML code formatting

1. XML code should also be formatted, using 2 spaces for each indent level (not 4 spaces).
Badly formatted XML code can be reformatted using the Eclipse formatter.
Always check that the result is better than the original, and tweak afterwards if needed.
54.3.3. Design
Nuxeo EP 5.3 334

1. Use interfaces every time it is possible instead of concrete classes.
Ex: declare a variable or argument as a "Map", not as a "HashMap".
Why? Using interfaces makes it possible to use several different implementations. Actually, interfaces
are the basis of component-oriented programming.
2. But don't overdo it if it's not necessary.
Why? The more code we have, the more expensive maintainance is.
3. Avoid cyclic dependencies.
Why? This is a common design principle, called the "Acyclic Dependency Principle" or "ADP".
How? use JDepend or a JDepend plugin for you IDE (ex: http://andrei.gmxhome.de/jdepend4eclipse/) or
look at the JDepend report by Maven.
More info:
• How JDepend Changed My Java Packaging
• Managing Your Dependencies with JDepend
• Uncle Bob Martin's "Design Principles and Design Patterns" (pages 18-22, "The Acyclic
Dependencies Principle (ADP)")
54.3.4. Unit tests

If it's not tested, it's broken.
—Bruce Eckel
1. Write unit tests. A lot.
How? Learn how to use JUnit. Use tests in existing modules as examples. Remember that well-tested
modules have at least as many lines of test code than not test code.
2. Check that your unit tests have a coverage of most of the critical parts of your code.
How? Look at the Cobertura report by Maven, or use the TPTP or EMMA (http://www.eclemma.org/)
plugins for Eclipse or use the native code-coverage function of IDEA.
3. Design your API so as to make unit testing possible and easy.
See API Design As If Unit Testing Mattered
Some cosmetic remarks related to writing unit tests:

1. Use "assertEquals(constant, value)", not "assertEquals(value, constant)"
Why? Because one has to choose a convention and this one
2. Use "assertNull(value)", not "assertEquals(null, value)"
Why? Because code is shorter and looks cleaner this way.
54.3.5. Security
1. Read Graff and van Vyk's "Secure Coding" [Graff2003] book. More info on the securecoding.org
Nuxeo EP 5.3 335

website.
2. If you don't have access to the book, read at least Secure Coding: The State of the Practice (including the
Architectural Principles, the Design Ideas and the Java Tips sections) from one of the two authors.
3. Read these slides from JavaOne 2006.
54.3.6. Naming convention

1. Don't use underscores ("_") in variables, methods or class names, use camelCase notation instead.
Why? Because it is the Java convention.
2. Check some good articles on naming things, like Ottinger's Rules for Variable and Class Naming.
It is especially important that we all use the same words (in case there is an ambiguity) to refer to the
same concepts (like "fetch" vs. "retrieve", for instance).
54.3.7. Information hiding

1. Minimize the accessibility of classes and members (for instance by making them "private" unless you
have a reason to believe that they will be used from other classes, and more generally by using the
weakest access modifier ), so as to keep you API clean and easy to understand for other developers.
Reference: "Effective Java" [Bloch2001], item 12.
54.3.8. Use modern Java features

1. Use Java 5's "foreach" construct instead of explicit iterators whenever possible (which is not always the
case).
2. Use java 5's generics.
Why? This will improve the amount of static checks done by the compiler.
54.3.9. Logging
Follow this piece of advice from Alex Miller:
My opinion is that there are 4 log levels that matter for general program logging (specialized logs like audit and
performance have their own rules). I dont care what you call them so feel free to replace these with the names
of your choice.
• ERROR - an error has occurred in the program (usually an exception). All internal or unexpected failures
should be logged at ERROR level. Programmers should care about anything logged as an error. User
errors (like input validation) should generally NOT be logged at ERROR level. These are expected (if
invalid) inputs and you should respond to the user appropriately (another post altogether), but this is not
a program error. Exceptions may be made for things like repeated invalid password attempts that are
likely security problems.
• WARNING - an anomalous condition has been detected and the program will attempt to deal with it. No
action needs to be taken externally but you might be interested if things go down in flames 5 minutes
later. The conditions for warnings are relatively rare but an example would be reaching a warning
threshold on a connection pool or a loss of connectivity that can be repaired by reconnecting to the same
or different source.
• INFO - an interesting piece of information that helps to give context to a log, often when things are
Nuxeo EP 5.3 336

starting or stopping. INFO messages should never be printed on a per transaction (whatever that means
to you) path through the code. That is, INFO messages should be 1-time or very occasional messages.
• DEBUG - whatever your OCD programmer mind desires.
The first three levels (ERROR, WARNING, and INFO) should always be on. If your logs grow rapidly with
these levels on, something is wrong. You should be able to run in production with these levels for weeks
without a problem (but you should really use a rolling log writer just in case). DEBUG should be used only
during development for debugging.
54.3.10. Documentation: Comments and Javadoc

Reuse is something that is far easier to say than to do. Doing it requires both good design and
very good documentation. Even when we see good design, which is still infrequently, we won't
see the components reused without good documentation.
—D. L. Parnas The Mythical Man-Month: Essays on Software Engineering
1. Always use comments to document what is not obvious.
Why? Otherwise, it will be harder for others (even you!) to maintain or extend your code. Some people
may even end up refactoring your code under wrong assumptions.
See for instance item #28 of Bloch's "Effective Java" [Bloch2001] for more insight, including this most
important principle:
The doc comment for a method should describe succinctly the contract between the method
and its client. With the exception of methods in classes designed for inheritance, the contract
should say what the method does rather than how it does its job.
2. Write javadocs according to the javadoc manual and the official Sun javadocs guidelines.
Why? Because javadocs are compiled by a standard tool, you must conform to the syntax mandated by
this tool.
3. Common javadoc guidelines that are often forgotten include:
• Don't include XML tags without escaping the < and > characters.
• Remember that the first sentence (i.e. everything until the first dot) is used as a short description of
the package / class / method / etc. it documents. Hence end all your sentences with a dot.
• Use <p> for separating paragraphs, not <br> or
• Don't use </p> in the source though as it is useless and rather bad looking.
• If your javadoc starts with "This class" or "This methods", this is most probably wrong.
4. Proofread carefully (including checks for spelling and grammar errors) and check that your javadocs
provide useful information for third-party developers (or your teammates) by actually reading the
generated doc.
How? See either "Project -> Generate Javadocs" from Eclipse, or "mvn javadoc:javadoc" from the
project root and browse the docs.
Remember that you can see a preview of how your javadoc will look like from Eclipse by using the
"Javadoc" tab in the Java perspective.
5. Don't mix Javadoc comments with implementation comments.
Javadocs comments are intended to be read by clients of the API, implementation comments by people
Nuxeo EP 5.3 337

who need to review you code or who will end up maintaining it (including yourself).
For instance, don't put "TODO" markers in your javadoc because they are intended for yourself or other
people co-developing or maintaining your code, not clients of the API.
6. Start by documenting the most important and less obvious things.
If you don't have enough time to document everything, document first the API part of your code
(usually, the interfaces), because that's what third-party developers are going to use.
Also documenting the non-obvious (like giving an overview of a package or an important class) is more
important than writing for instance, that a "getTitle()" method "@returns the title".
7. Write package-level javadocs.
Package-level Javadoc (just package.html files in your source code) are the most important javadocs
you have to write, because that's what people reading the javadoc-generated site will read first, and
because that's where the information is usually the less obvious.
8. Sign your code (in the modules headers).
It is very important that people who will read / maintain your code know that you are the author, so that
they can ask you questions, give you feedback, etc.
9. When you've borrowed code from another open source project, always document it so that:
• we are sure that there is no license conflict with the original code
• we understand why the code in question doesn't follow our own coding conventions or isn't unit-tested
as it should (it should anyway, but this is another story)
10.Put markers as (inline) comments to document parts of your code that will need further work.
• use FIXME for really serious (like, release-blocking) issues.
• use the TODO for remaining tasks.
• don't use XXX which is usually associated with inappropriate content.
• use BBB to mark code used to ensure compatibility with a deprecated feature, that will be removed
after a certain release.
• do not leave TODO markers behind when they are not relevant (for instance for dummy classes used
in tests and auto-generated by the IDE from an interface or an abstract class).
11.Look critically at the javadoc-generated site and try to improve it.
Either go to http://maven.nuxeo.com/apidocs/ and check the apidoc for your project, or run mvn
javadoc:javadoc locally and browse the generated apidoc, and ask yourself the simple question: "if I was
a third-party developer, would I understand how to use the API by reading this".
54.3.11. Deprecation
1. Don't use deprecated features (= API), either from Java or third-party libraries, or from the Nuxeo
framework.
Hint: they should appear as stroked-out in your IDE.
2. Deprecate your own API when you have to, but make sure you write comments that explain to your
API's clients how to migrate from the old API to the new one. Use BBB markers (see above) if needed.
Nuxeo EP 5.3 338

3. Deprecated APIs should be maintained at least for 1 release cycle, at least for external clients of the
APIs, but we should strive to switch to the new APIs internally in 1 release cycle.
54.4. Methodology tips

Here are a few points and tips to keep in mind.
54.4.1. Use the power of your IDE (and its plugins)

Modern IDEs (+ adequate plugins, if necessary) include many code-checking functions that help find out
issues:
1. For Eclipse, the simplest plugin to use is TPTP.
How?
• Use the update manager to get the TPTP plugins.
• Right-click on your project, and select "Analysis".
• Enable all the rules, and run the analysis on your module.
• Fix the issues that appear serious (you still have to think).
2. You should also use the Checkstyle and FindBugs Eclipse plugins to ensure minimal bug count and
maximal coding style coherence.
See these great slides from JavaOne 2007 for instance.
3. Read Improving code with Eclipse plugins on developerWorks for more background information on the
subject.
From the article:
This article covers what I consider to be the "big five" code analysis areas:
• Coding standards
• Code duplication
• Code coverage
• Dependency analysis
• Complexity monitoring
These analysis areas can be uncovered using a number of the following slick Eclipse plugins:
• CheckStyle: For coding standards
• PMD's CPD: Enables discovering code duplication
• Coverlipse: Measures code coverage
• JDepend: Provides dependency analysis
• Eclipse Metrics plugin: Effectively spots complexity
NB: Coverlipse may or may not work correctly, an alternative is EclEmma which is very similar.
Nuxeo EP 5.3 339

54.4.2. Refactor
1. When something looks wrong in the code ("smell"), refactor it, but make sure you don't break anything.
How?
• Check that the code you are refactoring is covered by some unit tests.
• Refactor. (Tip: a modern IDE (Eclipse and IDEA for instance) has some functions that may help.)
• Check that the code still compiles (including dependent modules) and all the unit tests are still
passing, and commit.
54.5. Important references

Here is a list of useful stuff to read:
1. Joshua Bloch's "Effective Java" [Bloch2001] book. Highly recommended. Probably the best "advanced"
Java book.
2. Joshua Bloch's "Designing Effective API" slides and video.
3. ObjectMentor's design articles (click on "Design Principles"), the most important one being Principles
and Patterns.
Nuxeo EP 5.3 340

Chapter 55. Development Tools and Process
This chapter describes common development tools and useful complementary tools.
55.1. Mercurial usage

For installation procedure, see annexe "Installing Mercurial".
55.1.1. Overview and online documentation

See http://mercurial.selenic.com/wiki/UnderstandingMercurial.
Mercurial is a completely decentralized system. Every cloned repositories contain a working directory and a
store of complete project's history, thus allowing offline and parallel development.
The working directory contains a copy of the project's files at a given point in time, ready for editing.
The store contains a sufficient data to provide any file at any revision or tag from any branch.
Mercurial groups related changes to multiple files (commits) into single atomic changesets. Every commit
generates a changeset recording the state of the working directory relative to its parents, so merging is really
easier and more efficient than with other SCM.
55.1.1.1. Mercurial home site
http://mercurial.selenic.com/wiki/Mercurial.
There are “getting started” and “using Mercurial” documentations, even some help for developers used to other
SCM systems.
55.1.1.2. Nuxeo documentation
You will find useful tips and scripts in Nuxeo Wiki FAQ:
http://doc.nuxeo.org/xwiki/bin/view/FAQ/DownloadingNuxeoSources and some workarounds or guidelines for
specific cases.
55.1.1.3. Forest extension
Since the "nested repositories" came only with Mercurial version 1.3 and are still an experimental feature, we
chose to rely on the Forest extension when migrating from Subversion to Mercurial for replacing "svn
externals".
This is not mandatory for working with Nuxeo. This extension mainly provides easier way to run a command
on a "full" nuxeo repository including its sub-repositories, such as cloning full Nuxeo sources. For example,
those repositories have sub-repositories: nuxeo-addons, nuxeo, ...
55.1.2. Nuxeo common usage
55.1.2.1. Centralized repositories
Although Mercurial is decentralized, Nuxeo hosts “centralized” Mercurial repositories which are the
“reference” repositories, they are backed up and changesets made on local repositories must finally be pushed
on those remote repositories. The public "centralized" repository is https://hg.nuxeo.org/.
55.1.2.2. Server-side hooks
Nuxeo EP 5.3 341

Development Tools and Process
We've set some “hooks” on the central repositories filtering changesets according to whether they comply to the
following rules:
• Changesets must not be blacklisted.
• Even with the Mercurial's two-steps committing process (commit then push), it may happen to push
erroneous changesets with really no interest or making trouble in code history. In such cases, it's a
good thing to "strip" these changesets, removing them from history.
• We usually blacklist a changeset after having stripped it, to be sure nobody will push it again in case it
has been pulled before being stripped.
• Error message is:

ABORTED: changeset %s has been blacklisted,
please strip it from your repository after making sure you don't depend on it:
hg strip %s
• Changesets are in an allowed branch.
• We make an extra use of branches: for long-time developments, prototype or spike solutions, ease
parallel changes and give each developer merging responsibility of its code. Branches have
"stable/main", "maintenance/release" or "development/test" purpose.
• Depending on the project we use white or black lists for branch names.
• On some projects, for instance, we blacklist the “default” branch to avoid confusion or lack of
information about current version.
• Error message:
ABORTED: changesets with branch "%s" are not allowed.
The only allowed branches are: %s
Tip
Existing branches are given by this command:
hg branches [-a]
• Changesets do not result in two heads for the same branch.
• Changesets that have a given branch tag, but have no child changesets with that tag are called branch
"heads". Mercurial identifies branches depending on their history so there may be two separate
branches with the same name in case of concurrent changes made on a branch which were based on
different parents. Of course, such situation is abnormal and must be fixed. This hook will prevent a
developer from pushing changesets resulting in homonym branch heads.
• Rule is: always pull before trying to push. If your local changes drive to multiple heads with same
branch name, you must merge them before pushing.
• Error message:
ABORTED: branch %s has several heads (%s), you must merge them before pushing.
Tip
Existing heads are listed with this command:
hg heads [branchName]
Nuxeo EP 5.3 342

• User for changesets must be valid.
• For code history readability, usernames must be formatted like “John Doe <[email protected]>”.
• Error message:
ABORTED: changesets with user "%s" are not allowed.
You need to specify your user name in $HOME/.hgrc as follows:
[ui]
username = John Smith <[email protected]>
• Notifications
This hook will generate a mail to the public mailing list <[email protected]> for every
changeset.
• Build trigger
This hook launches a build in our continuous integration system: http://qa.nuxeo.org/. Using a trigger ran
at every commit is saving a lot of bandwidth compared to regularly pulling the repository to check for
code changes.
Setting such hooks was not mandatory but they guarantee the developers are following a few basic rules and
prevent them from simple mistakes.
It is sometimes possible to force a push in spite of the hooks, when you know the hook message is not an error
but a warning and it can be securely circumvented.
55.1.2.3. Branch layout and policy
We usually define stable, maintenance and development branches.

• Stable, next to release branch
Often called "main" branch, this named branch is hosting the most-recent code.
Stable branch is of course under continuous integration. Merge and commits must be double-checked; as
much as possible, changes have been firstly tested and validated on a development branch or in
developer's working directory.
Nuxeo uses two stable branches: 5.1 and 5.2. New features, eventually breaking API, are developed on
5.2. There's quite no new feature on 5.1 which has both stable and maintenance purpose and is gathering
fixes from 5.1.x releases.
I.e. 5.2 branch is hosting 5.2-SNAPSHOT code which will lead to 5.2.x release.
Special case of 5.1 branch: it is hosting 5.1.X-SNAPSHOT code and may lead to 5.1.x release.
• Maintenance, patch branch
When releasing, a dedicated branch is created and then tagged. This branch is used for creating minor
versions releases.
Fixes done on it will be merge on stable branch; fixes from stable branch may be backported on this
maintenance branch to generate patches or minor releases.
Maintenance branch are rarely under continuous integration as there is no more work on them except
fixes and backports.
I.e. 5.1.6 branch is hosting 5.1.6 code, tagged as release-5.1.6, and may lead to minor versions releases
Nuxeo EP 5.3 343

such as 5.1.6.x
• Development branches
Developers are strongly encouraged to use as much branches as they need (one per JIRA issue or per
development iteration). Those branches may or not be automatically tested, their purpose is code
isolation while it is unstable: they are merged to stable branch after being fully tested.
I.e. 5.2-NXP-9999-some_user_story will host code linked to implement some user story until the end of
the iteration (or some point the code is considered stable and usable).
55.1.3. Best practices

Here are some recommended practices using Mercurial at Nuxeo.
• Update and commit often. It will ease future merge tasks.
• Always reference a Jira issue at the beginning of commit comments: i.e. “NXP-9999 – sample task,
remove code using deprecated API”.
• Long time work should be done in a separate branch; named with the associated Jira issue and a short
description: i.e. “NXP-9999_longtime_work”
• Check what you've changed before committing and what you've committed before pushing.
hg status
hg diff
hg outgoing
• Never “force” a push unless being sure it has to be done.
55.1.4. Useful scripts, commands and tips

The following Mercurial commands are given with useful parameters into brackets, other parameters may be
available. See “hg help [COMMAND]” for available commands listing or help on a specific command.
55.1.4.1. Nuxeo shell and batch scripts
They are mainly used for Nuxeo repositories which are constructed as a forest of sub-repositories. Forest
extension provides quite equivalent functions but both are complementary.
hgf function runs a hg command into current and nuxeo-* subdirectories:

hgf() {
for dir in . nuxeo-*; do
if [ -d "$dir"/.hg ]; then
echo;echo "[$dir]"
(cd "$dir" && hg "$@")
fi
done
}
hgf.bat:
@echo off
set PWD=%CD%
echo [.]
hg %*
for /d %%D in (nuxeo-*) do (
echo [%%D]
cd %PWD%\%%D
hg %*
Nuxeo EP 5.3 344

)
cd %PWD%
hgx function is a little more complex and tied to nuxeo repositories as it runs a hg command into current and
nuxeo-* subdirectories managing with the two version numbers we have on nuxeo (i.e. 5.2/1.5). It uses inverted
polish notation.
hgx() {
NXP=$1
NXC=$2
shift 2;
if [ -d .hg ]; then
echo $PWD
hg $@ $NXP
# NXC
(echo nuxeo-common ; cd nuxeo-common; hg $@ $NXC || true)
(echo nuxeo-runtime ; cd nuxeo-runtime; hg $@ $NXC || true)
(echo nuxeo-core ; cd nuxeo-core; hg $@ $NXC || true)
# NXP
(echo nuxeo-theme ; cd nuxeo-theme; hg $@ $NXP || true)
[ -d nuxeo-shell ] && (echo nuxeo-shell ; cd nuxeo-shell; hg $@ $NXP || true) || (echo ignore nuxeo-shell)
[ -d nuxeo-platform ] && (echo nuxeo-platform ; cd nuxeo-platform && hg $@ $NXP || true) || (echo ignore nux
[ -d nuxeo-services ] && (echo nuxeo-services ; cd nuxeo-services && hg $@ $NXP || true) || (echo ignore nux
[ -d nuxeo-jsf ] && (echo nuxeo-jsf ; cd nuxeo-jsf && hg $@ $NXP || true) || (echo ignore nuxeo-jsf)
[ -d nuxeo-features ] && (echo nuxeo-features ; cd nuxeo-features && hg $@ $NXP || true) || (echo ignore nux
[ -d nuxeo-dm ] && (echo nuxeo-dm ; cd nuxeo-dm && hg $@ $NXP || true) || (echo ignore nuxeo-dm)
[ -d nuxeo-webengine ] && (echo nuxeo-webengine ; cd nuxeo-webengine; hg $@ $NXP || true) || (echo ignore nu
[ -d nuxeo-gwt ] && (echo nuxeo-gwt ; cd nuxeo-gwt; hg $@ $NXP || true) || (echo ignore nuxeo-gwt)
(echo nuxeo-distribution ; cd nuxeo-distribution; hg $@ $NXP || true)
fi
}
hgx.bat:
@echo off
set PWD=%CD%
set NXP=%1
set NXC=%2
echo [.]
hg %3 %NXP%
for /d %%D in (nuxeo-platform nuxeo-distribution nuxeo-theme nuxeo-shell nuxeo-
webengine nuxeo-gwt nuxeo-services nuxeo-jsf nuxeo-features nuxeo-dm) do (
echo [%%D]
cd %PWD%\%%D
hg %3 %NXP%
)
for /d %%D in (nuxeo-core nuxeo-common nuxeo-runtime) do (
echo [%%D]
cd %PWD%\%%D
hg %3 %NXC%
)
cd %PWD%
55.1.4.1.1. Check incoming changes

hg in [-p] [-r REVISION]
55.1.4.1.2. Check uncommitted changes

hg st [--rev REVISION]
This gives you modified (M), added (A), removed (R) and uncontrolled files (?).
Use “hg add”, “hg rm”, “hg addremove” and/or “hg ci” to commit these changes.
55.1.4.1.3. Check current branch, working directory status

hg id [-inbt]
This gives you current revision (with a “+” if it has been locally modified but not yet committed), current
branch name and, if you current revision is the latest modified head, the “tip” keyword.
Nuxeo EP 5.3 345

hg parents [-r REVISION]
Show the parents of the working directory or revision.
55.1.4.1.4. Show latest changeset, existing heads, branches and tags

hg tip [-p]
This gives you the log of the latest modified head, aka “tip”.
hg branches [-a]
Branches marked as “inactive” are not considered as “heads”, they haven't been modified since they were
merged into another branch (i.e. Nuxeo 5.1 branch is always “inactive” as we ask the developers to always
merge — forward port — their changeset from 5.1 to 5.2).
hg heads [-r REVISION] [REVISION|BRANCH_NAME]
This is useful for example to identify multiple heads with same name that must be merged.
hg tags
Gives all available tags and their corresponding revision and branch.
55.1.4.1.5. Follow changesets history

hg log [-r REVISION] [-l LIMIT] [-p]
Show revision history of entire repository or files.

hg glog [-r REVISION] [-l LIMIT] [-p]
Same as log but with a graphic view (requires GraphLog extension).

hg ann [-r] [-f] [-u] [-d] [-n] [-l]
Show changeset information per file line. Useful when you need to know who changed a specific part of a file.
55.1.4.1.6. Undo commands

hg strip REVISION
Strip a revision and all later revisions on the same branch.

hg unbundle FILE...
Apply one or more changegroup files. Used to revert a strip.

hg backout
Reverse effect of earlier changeset. Contrary to strip, backout only removes one changeset, not the children
revisions.
hg rollback
Nuxeo EP 5.3 346

Roll back the last transaction.

hg revert [-a] [-r REVISION] FILE...
Restore individual files or directories to an earlier state.
55.1.4.1.7. Remarks
Don't use “hg pull -u” but “hg pull && hg up”, there are issues with the first one. Also, check your current
branch with “hg id” after “hg clone” as it goes by default on “tip” branch.
55.1.5. Advanced usage and specific use cases
55.1.5.1. Merging policy from stable to development branch
Merge stable branch on your development one as much as possible. It can be automated at morning and then
manually done day by day each time there is some work merged on stable.
hg pull && hg up -C devbranch
hg merge stablebranch && hg ci -m”automated merge from stablebranch” [-u...] && hg push
See http://svn.nuxeo.org/nuxeo/tools/mercurial/automerge.sh.
55.1.5.2. Merging policy from development to stable branch
It happens at the end of a development iteration, when code to merge is implementing a group of User
Stories/Use Cases.
Unit tests are up-to-date to valid the new code (see test-driven development recommendations).
Functional tests are up-to-date to cover the new functionalities.
The development branch to merge must have been fully tested:

• developers have successfully run Unit Tests
• developers have functionally validated last developments
• automated builds have run on development branch
At this moment, development branch can be merged on stable one:

hg pull && hg up -C stablebranch
hg merge devbranch && hg st
hg ci -m”merge from devbranch – NXP-9999 ...”
hg push [-f]
Use “-f” only if stablebranch was no more a head.
55.1.5.3. Managing multiple heads
If two developers worked on the same branch with different parents, it may result in two simultaneous branches
with the same name (see server-side hooks).
$ hg push
pushing to https://hg.nuxeo.org/somerepository
searching for changes
abort: push creates new remote heads!
(did you forget to merge? use push -f to force)
Nuxeo EP 5.3 347

In such case, the developers won't be able to push their changesets until they have merged the two branches.
"hg heads branchname" will show the multiple heads and their changeset identifiers.
Simplest way is to switch his working directory to the other developer's revision and merge his own code:
hg up -C otherRevision
hg merge ownRevision
hg st
hg ci -m”merge two heads”
hg push
55.1.5.4. Checks before pushing
In case of doubts, before pushing, you can check what you've done with multiple commands:
hg out [-p] [-r REVISION]
hg glog [-l LIMIT] [|less]
hg heads someBranch
55.1.5.5. Saving bandwidth
Thanks to Mercurial which is decentralized, even if Nuxeo's repositories are not, you can pull from Internet to a
local repository and then pull from this repository. Then, you can update the .hg/hgrc file to bind it on the
central repository or continue using the local one, pushing on it and then pushing changesets from it to the
remote one.
hg clone https://hg.nuxeo.org/somerepository/ ~/repo-remote/
hg clone ~/repo-remote/ ~/repo-local/
cd ~/repo-local/
# some work…
hg ci -m”NXP-9999 - some work” && hg push
cd ~/repo-remote/ && hg pull
# usual checks (heads, merge, …)
hg push
Later, to update ~/repo-local/ for instance:

cd ~/repo-remote/ && hg pull
cd ~/repo-local/ && hg pull && hg up
55.1.5.6. Fetch
“hg fetch” can be used to pull, merge, commit but it is for experienced users, it's recommended to first being
familiarized with unitary commands.
55.1.5.7. Mercurial Queues
Mercurial Queues are an advanced group of Mercurial functions. Whereas not very easy to apprehend, they are
powerful tools.
You can for instance transform a group of changesets made on a wrong branch to patches being then re-applied
on the right branch, while editing and changing anything in those changesets (user, comments, ...).
See http://mercurial.selenic.com/wiki/MqExtension or Mercurial: The Definitive Guide by Bryan O'Sullivan.
55.2. Maven usage

For installation procedure, see annexe "Installing Maven".
55.2.1. Overview and online documentation
Nuxeo EP 5.3 348

See http://maven.apache.org/users/index.html.
Maven is a software tool for Java project management and build automation, similar in functionality to the
Apache Ant tool coupled to a dependency manager such as Ivy, but Maven is based on different concepts.
Maven uses a construct known as a Project Object Model (POM) to describe the software project being built,
its dependencies on other external modules and components, and the build order. It comes with pre-defined
targets for performing certain well defined tasks such as compilation of code and its packaging.
Maven is designed to be network-ready. It dynamically downloads libraries and plugins from one or more
repositories. A local cache of downloaded artifacts acts as the primary means of synchronizing the requirements
and outputs of projects on a local system.
55.2.1.1. Online documentation
http://www.sonatype.com/books/maven-book/reference/
http://maven.apache.org/guides/
http://maven.apache.org/guides/introduction/
http://maven.apache.org/ref/2.1.0/maven-settings/settings.html
55.2.1.2. Nuxeo documentation
How to debug test run with Maven: http://doc.nuxeo.org/xwiki/bin/view/FAQ/DebugMavenTest.
55.2.2. Generate a new project with the nuxeo-archetype-start archetype

The goal of the nuxeo-archetype-start template is to setup a development environment to work on a Nuxeo EP
plugin.
The default code provides: a maven layout for sources, tests and dependencies, a Ant target for deployment. It
also customizes the web application a litte bit.
To create a project named my-project in the com.company.sandbox.myproject package:

mvn
org.apache.maven.plugins:maven-archetype-plugin:1.0-alpha-7:create \
-DartifactId=my-project \
-DgroupId=com.company.sandbox.myproject \
-DarchetypeArtifactId=nuxeo-archetype-start \
-DarchetypeGroupId=org.nuxeo.archetypes \
-DarchetypeVersion=5.1.6 \
-DremoteRepositories=http://maven.nuxeo.org/nuxeo-release
You can see that you need to supply six arguments:
• artifactId : the name of your project, usually with '-' to separate the words if there are many.
• groupId : the domain name of your project. Usually it is the package parent name of your classes, you
should use '.' to separate the words ('-' is not supported here).
• archetypeArtifactId : the maven archetype artifact id. To generate a new project, Nuxeo provides you
with nuxeo-archetype-start
• archetypeGroupId : unique for all nuxeo maven archetypes : org.nuxeo.archetypes
• archetypeVersion : the version of the archetype which is equivalent to the version of Nuxeo EP without
the GA or RC part. (5.1.6, 5.1.5 ...).
• remoteRepositories : the repository location to download the archetype.
Nuxeo EP 5.3 349

55.3. Code Quality with Eclipse Plugins

Eclipse can benefit for several plugins for improving code quality, in both adherence to the project's coding
standard and in removing bugs.
55.3.1. Using Checkstyle

TODO
55.3.1.1. The Short Story
If you are already familiar with the Checkstyle Eclipse plugin, just configure it to use the checkstyle.xml at
the root of the nuxeo sources: http://hg.nuxeo.org/nuxeo/file/5.2/checkstyle.xml.
55.3.1.2. Longer Story: installation and Configuration
TODO
55.3.1.3. Notes on Reported Issues
TODO
55.3.2. Using TPTP

TODO
55.3.3. Using FindBugs

TODO
55.4. Profiling with NetBeans Profiler

IDEA doesn't provide an integrated profiler and Eclipse's profiler, provided by the TPTP project, doesn't
currently work on Mac OS, one can use NetBeans to profile the Nuxeo platform.
Here is how to do it:

1.
55.5. NXPointDoc Documentation tool

Nuxeo heavily uses extension points. In order to manage them nxPointDoc tool has been created. Its purpose is
to explore all XML files and build the documentation of each explored components. Cross links and indexes are
also built to ease the navigation.
The NxPointDoc pages are available at http://svn.nuxeo.org/nxpointdoc/
The tool is written in Python and the following libraries are needed:
• Genshi for templating
• ElementTree for XML processing
Nuxeo EP 5.3 350

• Pygments for code highlighting
55.5.1. Documenting a component

A component XML file is structured as follow:
<component ...>


<implementation>...</implementation>

<property name="..." value="..."/>
...
<property name="..." value="..."/>


<extension-point ...>
...
</extension-point>
...


<extension ...>
...
</extension>
...
</component>
We can see that the only required element is the component element (although it is useless to have an empty
component). So there are 3 main sections (any of these sections are optional).
• Component configuration: This section defines the component implementation class and some properties
to initialize the component (This section content may be modified in future especially when aligning
nuxeo components with OSGi services).
• Extension points: This sections contains all the extension point declared by the component.
• Contributions (extension tag): This section contains all the contributions made by this component to
other components.
To add documentation to these elements a <documentation> tag will be used. An element may have different
content depending on what it is documenting. While some information is already available in other XML
elements in the file, there is no need to duplicate these information inside the documentation provided though
the element. For example the name of the component can be retrieved from the name attribute of the
component element, the implementation class name from the implementation element etc.
To format the description text, we can use XHTML tags and javadoc-like markers such as @property, @schema
etc. Javadoc-like links are also supported: @see points on the javadoc, @component points on another
component documentation. For example, {@see org.nuxeo.ecm.core.schema.types.Type} will point on the
http://maven.nuxeo.org/apidocs corresponding page while {@component
org.nuxeo.ecm.webapp.directory.DirectoryTreeService} will explicitly insert a link to the related
NxPointDoc page. Code colorization is also supported through the <code language='xml'> ... </code> tags.
If no language is given, xml is taken by default. Java (language='java') and many other languages are
supported (see Pygments pages).
Regarding <component> documentation, the following elements are available:

• @author: may be duplicated for multiple authoring
• @version
• @property
Nuxeo EP 5.3 351

• @see: points to Javadoc
• @component: points to nxpointdoc
• @deprecated
• component@name attribute: the component name
• component/implementation tag: the implementation class
• component/require tag: required elements
• component/documentation tag: the description
For <extension-point> the following elements have to be used:

• @schema
• @deprecated
• @see
• @component
• component/extension-point@name attribute: the name
• component/extension-point/documentation tag - the description
• If the extension point is using object sub-elements, the DTD should be extracted from the XMap
annotated class, otherwise the user may specify the DTD using the @schema marker inside the
documentation element
For <extension>, describing contributions to an extension-point, we have

• @see
• @component
• @deprecated
• component/extension@target attribute - rendered as a link to the component documentation
• component/extension@point - rendered as a link to the extension point documentation
• component/extension-point/documentation description
Here is a short example of what a component xml file may look like.
<component name="org.nuxeo.ecm.MyService">
<documentation>
My demo service
<p/>
This service does nothing
@property home home directory to be used to create temp files
@property timeout the time interval in seconds
@version 1.0
@author Bogdan
</documentation>
Nuxeo EP 5.3 352

<require>org.nuxeo.ecm.Service1</require>
<require>org.nuxeo.ecm.Service2</require>
<implementation class=”org.nuxeo.ecm.core.demo.Service2”/>
<property name=”home” value=”/home/bstefanescu”/>
<property name=”interval” value=”20” type=”Integer”/>
<extension target="org.nuxeo.ecm.SchemaService" point="schema">
<documentation>Common and Dublin Core schemas</documentation>
<schema name="dublincore" src="schema/dublincore.xsd" />
<schema name="common" src="schema/common.xsd" />
</extension>
<extension-point name="repository">
<documentation>Register new repositories</documentation>
<object class="org.nuxeo.ecm.RepositoryDescriptor"/>
</extension-point>
</component>
Feel free to browse the NxPointDoc site and teh corresponding xml file to go deeper. The systematic link to the
source code svn repository may help you.
55.5.2. Creating the NxPointDoc site

nxpointdoc is a command line program that creates the whole site from a source repository SOURCE_DIR to a
target publication directory TARGET_DIR. Each component is analyzed and all related pages created. Index pages
are then created.
$ ./nxpointdoc.py -h
usage: nxpointdoc.py [options]
options:
--version show program's version number and exit
-h, --help show this help message and exit
--source=SOURCE_DIR Source root directory containing xml component files
--target=TARGET_DIR Target directory for the generated documentation
--template=TEMPLATE Genshi template for component html file
--template-index=TEMPLATE_INDEX Genshi template for index html file
--allow-xhtml-comment=ALLOW_XHTML_COMMENT 'no' to not interpret xhtml tags in comment
--color=COLOR_CODE 'no' to not color <code> contents
Valid SOURCE_DIR and TARGET_DIR are mandatory. Template files have to exist. The one delivered have the
.template extension and can be used as is.
55.5.3. Browsing NxPointDoc

NxPointDoc generates 3 indexes that are the entry points; The documentation is accessible at
http://svn.nuxeo.org/nxpointdoc/ with 3 indexes related to components, extension points and
contributions. Each one is an entry point for the documentation. The Indexes give the name and the first line of
the documentation. An hyperlink allows to see the detail of the examinated item.
The statistic gives some rough indicators on the documentation coverage, globally or for each component file.
The G.D.C stands for Global Documentation Coverage while the I.D.C stands for Individual Documentation
Coverage. They show the ratio between all the information/documentation that is written over all the entries
that are considered as mandatory (like author, documentation, etc.). The higher these indicators are, the better it
is.
55.6. Quality Assurance with continuous integration

"Continuous Integration is a software development practice where members of a team integrate
their work frequently, usually each person integrates at least daily - leading to multiple
integrations per day. Each integration is verified by an automated build (including test) to
detect integration errors as quickly as possible. Many teams find that this approach leads to
Nuxeo EP 5.3 353

significantly reduced integration problems and allows a team to develop cohesive software
more rapidly."
—Martin Fowler - Continuous Integration (an introduction)
See http://en.wikipedia.org/wiki/Continuous_Integration
It's as important to follow quality processes on development as to maintain this quality among time. Nuxeo is
involved in such practices that will guarantee or reinforce its products quality.
55.6.1. Rules and means

Nuxeo products and tools are continuously built over time, at each change and against multiple environments.
Nuxeo QA team sets and maintain a QA environment applying CI rules and so providing to developers means
to check their code quality and being warned in case of any problem.
• Maintain a code repository
Nuxeo sources repositories hg.nuxeo.org and svn.nuxeo.org are under continuous integration.
This includes Nuxeo EP, Nuxeo addons, Nuxeo RCP, Nuxeo WebEngine, Nuxeo Books, tools and
plugins and of course all our customers' projects.
• Builds are automated
This is done by Hudson on Nuxeo QA Unit, Functional and Integration tests.
• Every commit on mainline is integrated
When code is committed, target project is built, as all projects depending on it. The full chain is verified,
from build to deployment.
Mainlines on Nuxeo EP and addons are the main branches in development: 5.1 and 5.2 (resp. 1.4 and 1.5
for associated subtrees). For projects under SubVersion, that means the trunk and, if exists, 5.1 branch.
• Everyone can see the results of the latest build
Hudson plugins ensure to warn potential responsible(s) of build fail by mail and jabber, so they can react
quickly.
Moreover, every build fail is sent on ECM QA mailing list.
• Make it easy to get the latest deliverables
Nightly builds are done. Produced artifacts are published on our Maven repositories maven.nuxeo.org.
Currently managed with Nexus, our repositories store all released artifacts and recent snapshots.
• Keep the build fast
Continuous Integration is done on multiple servers, more or less powerful, using slaves in order to
distribute the load.
Thanks to Maven and to Nuxeo modularity, each module is built separately and as a consequence,
quickly.
• Test in a clone of the production environment
We have two integration levels: unit and functional.
First level checks code compilation and runs Unit tests. A lot of Unit tests simulate target environments
(with mock objects). Dependent projects/modules are then added to the CI chain.
Second level runs packaging tools and automated deployment against multiple environments (we aim at
Nuxeo EP 5.3 354

covering JVM versions, SQL backends, OS, browsers, performance, ...). Finally we use Selenium tests to
check functional integrity. This also indirectly provides a continuous integration on our tools (packaging,
convenient scripts, ...).
55.6.2. Quality directives for Nuxeo developers

These practices apply on every script, project or module. They should be strictly followed.
• Code must be under continuous integration.
Except for prototype and spike solutions (sandbox projects or temporary branches), all projects must be
under CI. If not, ask for it to the QA team, providing the informations mentioned in the following
Hudson part.
• Automate the build
Think about QA tools that will have to test the project without any human intervention. Provide Maven,
Ant or, in the worse case, Shell autonomous configuration.
• Make your build self-testing
Think "test-driven development". Simply building a project/module and running its Unit tests should be a
valuable measurement of the code stability. Unit tests code coverage often needs to be increased.
• Commit every day
Smaller are the commits, lower is the risk of conflicting changes and easier is the bug analysis.
• Stay tuned
Be aware of CI builds, particularly failed builds.
Log on http://qa.nuxeo.org/hudson/ and check your profile's informations, especially your jabber address.
Hudson will then be able to contact you via Jabber when you are suspected of having broken something.
Subscribe to ECM QA mailing list. Use mail filters to quickly catch and fix problems. Hudson will send
you a mail if it detects one of your commits between succeed and failed tests.
If you're used to, RSS feeds are also available.
Check regularly your projects health on our QA sites. Inform QA team if you notice any issue.
Always consider a build failed as an emergency.
55.6.2.1. Maven parent POM
Maven Parent POM file gives a lot of useful information. Take care to fill in you project's pom.xml file:
• main tags
<name>Nuxeo ECM Projects</name>
<description>Nuxeo ECM Platform and related components</description>
<organization>
<name>Nuxeo SA</name>
<url>http://www.nuxeo.com/</url>
</organization>
<licenses>
<license>
<name>GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</name>
<url>http://www.gnu.org/copyleft/lesser.txt</url>
</license>
</licenses>
<mailingLists>
Nuxeo EP 5.3 355

<mailingList>
<name>Nuxeo ECM list</name>
<subscribe>http://lists.nuxeo.com/mailman/listinfo/ECM</subscribe>
<unsubscribe>http://lists.nuxeo.com/mailman/listinfo/ECM</unsubscribe>
<archive>http://lists.nuxeo.com/pipermail/ecm/</archive>
</mailingList>
</mailingLists>
<issueManagement>
<system>jira</system>
<url>http://jira.nuxeo.org/browse/NXP</url>
</issueManagement>
<ciManagement>
<system>Hudson</system>
<url>http://qa.nuxeo.org/hudson/</url>
</ciManagement>
• "scm" tag
<scm>
<connection>scm:hg:http://hg.nuxeo.org/addons/nuxeo-samples</connection>
<developerConnection>scm:hg:https://hg.nuxeo.org/addons/nuxeo-samples</developerConnection>
<url>http://trac.nuxeo.org/nuxeo/browser/nuxeo_samples</url>
</scm>
• "developers" tag (there's no rule for tags within the "developer" tag, feel free to add useful information
such as "role", "url", "organization" or "module")
<developers>
<developer>
<name>John Doe</name>
<email>[email protected]</email>
</developer>
</developers>
• You also have to add <repositories> section in the project's parent POM in order to make your project
fully autonomous.
<repositories>
<repository>
<id>public</id>
<url>http://maven.nuxeo.org/public</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>public-snapshot</id>
<url>http://maven.nuxeo.org/public-snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
All these tags are intelligently inherited so that, if you're project's Maven parent is nuxeo-ecm or one of its
children, you don't have to repeat informations such as "organization", "licenses", "mailingLists",
"issueManagement". Also, when working on a project with sub-modules, it's only necessary to set "scm" on the
parent POM.
55.6.2.2. Hudson configuration
Adding a project under continuous integration in Hudson requires:

• SCM URL
• Build command
In case of Maven, it's the goals to run (usually, it will be "clean install"). Consider using Maven
"Profiles" to manage different behaviors like development versus production environment.
Nuxeo EP 5.3 356

In case of Ant, you may need to provide some parameters on the command line (equivalent to what can
be set by a human user in a build.properties).
In case of Shell (avoid it as much as possible), it's a simple command with working default values in case
of required parameters. If needed, some environment constants may be set.
• Notification target(s): eg, the team mailing list.
55.7. Release process
55.7.1. Overview
Release process is managed and tested by multiple tools:
• Hudson continuous integration which generates a candidate release every night based on snapshots.
• nx-builder
• Selenium tests
• Funkload tests
• IZPack for jar packaging
• Wine and Inno Setup Script for Windows packaging
When a release is wanted, all continuous integration chain must be satisfied, nightly builds are manually tested
to complete automated tests and candidate release is "promoted" to public release (code is tagged, artifacts are
uploaded to the maven repository and packages are published on Nuxeo web site.
55.7.2. Continuous integration coverage

For now, continuous integration covers those configurations:
• Nuxeo DM.
• Linux Ubuntu (Debian).
• Sun Java 5, Sun Java 6.
• JBoss application server.
• VCS backend on H2.
• VCS backend on PostgreSQL.
Not automatically tested at integration level (full deployment and tests):

• Nuxeo EP.
• Nuxeo-shell and scripts.
• JCR backend with various databases: H2, Derby, PostgreSQL, MySQL, Oracle, ...
• VCS backend with various databases: Derby, MySQL, Oracle, ...
• Various application servers: Jetty, GlassFish (GF3) and Tomcat.
Nuxeo EP 5.3 357

• Various Windows OS.
• Various Java providers.
55.7.3. Help testing release candidates

You can download nightly candidate releases from http://qa.nuxeo.org/hudson/view/NX Deployments/, test and
send feedback on our ECM mailing list or, in case of bugs confirmed, in our Issue Tracker (Jira).
Nuxeo EP 5.3 358

Chapter 56. Packaging Nuxeo EAR
56.1. Introduction
Goal of this chapter is to help creating projects over Nuxeo. How to create a project structure including a
packaging module that builds one or more Enterprise ARchive (EAR), ready for deployment. Ant scripts,
Maven profiles and Nuxeo assemblies allow defining simple commands to build packages that will fit each
target environments.
56.2. Basic project structure

Good practice is to define a parent pom at project root and set a module-ear. Beside that, you may have as
many modules and sub-modules as you want. We recommend to split your code according to some
development and deployment criteria: API, web or core contributions, stateful or stateless services, ...
Following this main rule, you have to create multiple modules where to dispatch your code and resources.
Maven will manage the dependencies between modules and our assembly files will package EAR with all
required libraries.
Following multi-module project template is available here

|-- README.txt
|-- build.properties.sample ❶
|-- build.xml ❷
|-- fixeclipse ❸
|-- pom.xml ❹
|-- .project.ok ❺
|-- template-api ❻
|-- template-core ❼
|-- template-web ❽
|-- template-ear ❾
| |-- pom.xml
| `-- src
| `-- main
| |-- assemble ❿
| | |-- template-dev.xml
| | |-- template-ldap-pg.xml
| | |-- template-stateful.xml
| | `-- template-stateless.xml
| |-- resources_template_common (11)
| | `-- README.txt
| |-- resources_template_dev
| | `-- README.txt
| |-- resources_template_ldap_pg
| | |-- config
| | | |-- default-repository-config.xml
| | | |-- jdbc-compass-connection-config.xml
| | | `-- sql.properties
| | |-- datasources
| | | `-- unified-nuxeo-ds.xml
| | `-- system
| | `-- nuxeo-platform-search-compass-plugin-5.1.7-SNAPSHOT.jar
| | `-- compass.cfg.xml
| |-- resources_template_stateful
| `-- resources_template_stateless
|-- template-stateful-services (12)
|-- template-stateless-services (13)
`-- template-test (14)
❶ Ant sample properties. Copy this file to build.properties and personalize it to fit your installation.
❷ Ant script. It's aimed to ease the use of maven, giving targets to automatize common tasks on project (test,
compile, deploy, package, ...).
❸ OS dependent, will only work on Linux/Unix and Mac OS X. Copy it from Nuxeo EP root. It's a shell
utility script that calls maven-eclipse-plugin to create or update Eclipse's .project and .classpath files,
taking care of setting different build directories for Maven and Eclipse. The script gives precedence to any
present .project.ok or .classpath.ok.
❹ Maven project parent file.
❺ Required to import this project into eclipse as a whole resources project (each module will also be
individually imported as a java project).
❻ This module contains common code usable in all other modules, such as interfaces, adaptors, constants,
Nuxeo EP 5.3 359

Packaging Nuxeo EAR
data transfer objects, ...

❼ This module contains all contributions to Nuxeo Core.
❽ This module contains all JSF, Seam, WebEngine contributions, components and templates.
❾ This module provides packaging of Nuxeo EP following assembly descriptors.
❿ Assembly descriptors. Here are some samples.
11 Resources directory sample.
12 This module gathers all Message Resolved Beans that modify some data and all services that define their
own persistence source.
13 This module contains all services that are not going into template-stateful-services.
14 This module is for use in unit tests from other modules.
56.3. The EAR module

Describe packaging with assembly descriptors
56.3.1. Assembly descriptor
Example 56.1. Sample of customized assembly for a standard EAR, configured for development

<assembly>

<assemble>
<set>resources</set>
<outputFile>/</outputFile>
</assemble>
<zipEntrySet id="resources">
<artifact>
org.nuxeo.ecm.platform:nuxeo-platform-ear:${nuxeo.platform.version}:zip:resources-mono
</artifact>
</zipEntrySet>

<assemble>
<set>root-artifacts</set>
</assemble>
<artifactSet id="root-artifacts">
<import>**</import>
<includeDependencies>false</includeDependencies>
<includes>
<artifact name="nuxeo-platform-webapp" />
<artifact name="nuxeo-platform-webapp-core" />
</includes>
</artifactSet>
<assemble>
<outputFile>system</outputFile>
<set>system</set>
</assemble>
<artifactSet id="system">
<import>**</import>
<includeDependencies>true</includeDependencies>
<includes>
<artifact group="org.nuxeo.*" category="runtime,jboss4"
includeDependsOnCategory="false" />
<artifact group="org.nuxeo.*" category="core,search,web" />

</includes>
<excludes>
<artifact group="!org.nuxeo*" />
<artifact group="org.nuxeo.common" />
<artifact name="nuxeo-runtime-jboss-extensions" />
<artifact name="nuxeo-platform-audit-facade" />
<artifact name="nuxeo-platform-placeful-facade" />
<artifact name="nuxeo-platform-search-compass-plugin" />
<artifact name="nuxeo-platform-ear" />
<artifact name="nuxeo-apt-extensions" />
<artifact group="org.nuxeo.projects.template" />
</excludes>
</artifactSet>
<assemble>
Nuxeo EP 5.3 360

Packaging Nuxeo EAR
<unpack>true</unpack>
<unpackInNewDirectory>true</unpackInNewDirectory>
<set>nuxeo-platform-unpacked</set>
</assemble>
<artifactSet id="nuxeo-platform-unpacked">
<import>**</import>
<includes>
</includes>
</artifactSet>

<assemble>
<outputFile>lib</outputFile>
<set>nuxeo-fixed-libs</set>
</assemble>
<artifactSet id="nuxeo-fixed-libs">
<artifacts>
<artifact group="org.freemarker" name="freemarker" version="2.3.11" />
<artifact group="org.osgi" name="osgi-core" version="4.1" />
<artifact group="commons-collections" name="commons-collections"
version="3.1" />
<artifact group="commons-io" name="commons-io" version="1.2" />
<artifact group="commons-lang" name="commons-lang" version="2.2" />
<artifact group="commons-fileupload" name="commons-fileupload"
version="1.1.1" />
<artifact group="cssparser" name="cssparser" version="0.9.4-fix" />
<artifact group="net.sf.ehcache" name="ehcache" version="1.2.3" />
<artifact group="net.sf.ezmorph" name="ezmorph" version="0.9" />
<artifact group="org.hibernate" name="hibernate" version="3.2.0.ga" />
<artifact group="org.hibernate" name="hibernate-annotations"
version="3.2.0.ga" />
<artifact group="org.hibernate" name="hibernate-entitymanager"
<artifact group="jboss" name="jboss-cache-jdk50" version="1.4.0.SP1" />
<artifact group="org.jboss.seam" name="jboss-seam" version="1.1.5.NX3" />
<artifact group="jboss" name="jbpm" version="3.1.2" />
<artifact group="jboss" name="jgroups" version="2.2.9" />
<artifact group="net.sf.json-lib" name="json-lib" version="0.9" />
<artifact group="org.apache.lucene" name="lucene-core" version="2.0.0" />
<artifact group="net.sf.opencsv" name="opencsv" version="1.7" />
<artifact group="org.slf4j" name="slf4j-api" version="1.3.0" />
<artifact group="org.slf4j" name="slf4j-log4j12" version="1.3.0" />
<artifact group="org.apache.myfaces.tomahawk" name="tomahawk"
version="1.1.5" />
<artifact group="org.apache.myfaces.tomahawk" name="tomahawk-sandbox"
version="1.1.5" />
<artifact group="org.apache.myfaces.trinidad" name="trinidad-api"
version="1.0.1-incubating-NXEP51M2" />
<artifact group="org.apache.myfaces.trinidad" name="trinidad-impl"
<artifact group="org.apache.directory.server"
name="apacheds-protocol-shared" version="1.5.1" />
<artifact group="org.apache.directory.shared" name="shared-ldap"
version="0.9.7" />
<artifact group="com.sun.facelets" name="jsf-facelets" version="1.1.11" />
<artifact group="org.nuxeo.ecm.platform" name="nuxeo-jbossws-wrapper"
version="4.0.5.GA" />
</artifacts>
</artifactSet>

<assemble>
<outputFile>plugins</outputFile>
<set>template-plugins</set>
</assemble>
<artifactSet id="template-plugins">
<import>**</import>
<includes>
</includes>
</artifactSet>

<assemble>
<set>template-resources</set>
</assemble>
<fileSet id="template-resources">
<directory>src/main/resources_template_common</directory>
<excludes>
<exclude>README.txt</exclude>
</excludes>
</fileSet>
<assemble>
<set>template-resources-dev</set>
</assemble>
<fileSet id="template-resources-dev">
<directory>src/main/resources_template_dev</directory>
Nuxeo EP 5.3 361

Packaging Nuxeo EAR
<excludes>
</excludes>
</fileSet>
</assembly>
Create an XML file in template-ear/src/main/assemble/ that will describe the EAR to build. Here's the file
content:
• assembly: the main tag. For now, you can only define one assembly per file (meaning one packaging
definition by assembly descriptor file).
• assemble: part of an assembly. An assemble must be associated with a set (different sets are available:
zipEntrySet, fileSet, artifactSet).
• set: string. Id of associated set.
• outputFile: output directory string. "/" represents the building EAR root.
• unpack: true or false. Whether the set content should be unpack.
• unpackInNewDirectory: true or false. if unpack is true, whether to create new directories or not in the
output directory.
• zipEntrySet
This set allow to retrieve artifacts from outside the project dependencies and unzip them.
• id: required set id.
• artifact: group:name:version:type:classifier of an artifact to retrieve from maven resolution, even if not

present in the project's dependency tree. Will be unzipped if necessary.
• profile: if specified, will only be treated if the given maven profile is active.
• artifactSet
This set retrieves all artifacts from the project's dependencies tree, depending on conditions
• import: "**" is required for inheriting project's dependencies.
• includeDependencies: true or false. If true, all dependencies of selected artifacts by this set will be
added to the set.
• excludeDependencies: true or false. If true, all dependencies of selected artifacts by this set will be
removed from the set.
• extends: deprecated. Was aimed to allow assemblies inheritance and sets overriding.
• includes (or excludes): artifacts list to include (resp. exclude). Each artifact accept these parameters:
• group: artifact's group id. Accept wildcards '*' and negative '!' to match multiple artifacts.
• name: artifact's id. Accept wildcards '*' and negative '!' to match multiple artifacts.
• type: artifact's type (pom, jar, ejb, ...).
• version: artifact's version.
Nuxeo EP 5.3 362

Packaging Nuxeo EAR
• scope: artifact's scope (test, compile, provided, ...).
• classifier: artifact's classifier.
• file: artifact's filename. Accept wildcards '*' and negative '!' to match multiple artifacts.
• category: artifact's category. Concept introduced by Nuxeo to "tag" an artifact with a "category".
This is done in the artifact's Manifest as "Bundle-Category". Multiple categories, comma separated,
is interpreted as an union of matching artifacts.
• includeDependsOnCategory: true or false. In case of category specified, whether to include or not

any artifact which has at least one dependency matching the specified category.
• profile: if specified, the artifact will only be treated (included or excluded) if the given maven
profile is active.
• fileSet
This set is for manipulating local resources.
• directory: root directory of resources to copy. For now, only one directory per set is allowed
• includes: files and directories list to include.
• include: string. File, directory or pattern file/directory to include. "**" means multiple directories.
• excludes: files and directories list to exclude. By default, these patterns are already excluded: "**/.svn"
and "**/.hg".
• exclude: string. File, directory or pattern file/directory to exclude. "**" means multiple directories.
56.3.2. Add some resources

With this assembly descriptor file, you can configure your local resources to be copied into the packaged EAR.
The above template gives some usual resources folders.
• resources_template_common where you put your resources that should always be added or overwrite the
default ones.
• resources_template_dev where you put your resources configured for development purpose (filesystem
backend, ...).
• resources_template_ldap_pg is an example where you can put resources parameterized to configure

Nuxeo with LDAP users and/or groups and a PostgreSQL backend.
• resources_template_stateful and resources_template_stateless are to be used for a bi-machine packaging,

explained later in this chapter.
56.4. Improve usability

It is important to give simple and stable ways to use these assembly descriptors. Maven will allow to configure
profiles and parameters. Ant will then give possibility to call multiple maven and shell commands, OS
independent.
56.4.1. Thanks to Maven
Nuxeo EP 5.3 363

Packaging Nuxeo EAR
The module-ear pom.xml file must have in its dependencies all wanted artifacts that will then be filtered by the
assembly descriptor. Including nuxeo-platform-ear bring all its dependencies, there's no need to copy Nuxeo's
artifacts list.
In order to call the assembly descriptor, it must contain the following plugin declaration.
"template.ear.assembly" is used to parameterize the assembly descriptor name. Set a default value with a
property.
<properties>

<template.ear.assembly>template-dev</template.ear.assembly>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-nuxeo-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<runPreprocessor>false</runPreprocessor>
<format>directory</format>
<outputDirectory>../target</outputDirectory>
<targetFile>${template.ear.assembly}</targetFile>
<descriptor>
${basedir}/src/main/assemble/${template.ear.assembly}.xml
</descriptor>
</configuration>
<executions>
<execution>
<id>assemble-ear</id>
<phase>package</phase>
<goals>
<goal>assembly</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Maven parameters may be set in command-line. For example, in the above template, "mvn clean package" will
package a Nuxeo EAR for developers and "mvn clean package -Dtemplate.ear.assembly=template-ldap-pg"
will call template-ldap-pg.xml instead of template-dev.xml and so package a Nuxeo EAR configured for LDAP
and PostgreSQL.
You can also use Maven profiles with "-P" argument.
56.4.2. Thanks to Ant

Using Ant, we will automatize lot of common tasks. Here's the output of command "ant -projecthelp" on
template-project:
$ ant -projecthelp
Buildfile: build.xml
Main targets:
copy Replace ear and copy libs to jboss
copy-2parts Copy Nuxeo-EP in two parts
copy-3parts DEPRECATED: Copy Nuxeo-EP in three parts
copy-ldap-pg Copy template on LDAP and Postgres
deploy Build and copy to JBoss
deploy-2parts Build 2parts and copy to two patched JBoss
deploy-ldap-pg Build for LDAP and Postgres and copy to JBoss
install Run mvn install
package Package Nuxeo-EP
package-2parts Package Nuxeo-EP in two parts
package-3parts DEPRECATED: Package Nuxeo-EP in three parts
package-ldap-pg Package for LDAP and Postgres
web Copy web files to a live JBoss
Default target: usage
Example 56.2. build.xml sample
Nuxeo EP 5.3 364

Packaging Nuxeo EAR
<project name="template" default="usage" basedir=".">

<property file="build.properties" />
<property name="jboss.dir" value="/opt/jboss" />
<property name="jboss.config" value="default" />
<property name="mvn.opts" value="" />
<property name="javac.debug" value="true" />
<property name="javac.deprecation" value="false" />

<property name="build.dir" value="${basedir}/target" />
<property name="deploy.dir" value="${jboss.dir}/server/${jboss.config}/deploy" />
<property name="template.ear.root" value="template-ear" />
<property name="nuxeo.ear" value="nuxeo.ear" />
<property name="deploy.lib.dir" value="${jboss.dir}/server/${jboss.config}/lib" />
<property name="build.lib.dir" value="lib" />


<target name="set.jboss.home" unless="jboss.home">
<property name="jboss.home" value="${jboss.dir}" />
</target>
<target name="set.assembly.name" unless="assembly.name">
<property name="assembly.name" value="template-dev" />
</target>
<target name="setproperties" unless="jboss.server" depends="set.jboss.home, set.assembly.name">
<property name="assembly.ear" value="${assembly.name}" />
<property name="jboss.server" value="${jboss.home}/server/${jboss.config}" />
<property name="jboss.deploy" value="${jboss.server}/deploy" />
<property name="jboss.lib" value="${jboss.server}/lib" />
<property name="jboss.nuxeo.ear" value="${jboss.deploy}/nuxeo.ear" />
<property name="template.ear.build" value="${template.ear.root}/target/${assembly.ear}" />
</target>
<target name="usage">
<echo message="usage: ant [package|deploy|web|package-2parts|deploy-2parts|package-ldap-pg|deploy-ldap-p]" /
<echo message="ant package => Package template to ${build.dir}/${nuxeo.ear}" />
<echo message="ant deploy => Package template and copy to ${deploy.dir}" />
<echo message="ant deploy-Nparts => Package template and copy to ${deploy.dir} relative to the ${jbossN.di
<echo message="ant web => Copy web files to a live JBoss (${deploy.dir})" />
</target>
<condition property="osfamily-unix">
<os family="unix" />
</condition>
<condition property="osfamily-windows">
<os family="windows" />
</condition>
<target name="deploy" depends="install,package,copy,copy-lib" description="Build and copy to JBoss">
<echo message="Deployed ${ant.project.name} to ${deploy.dir}" />
</target>
<target name="deploy-ldap-pg" depends="install,package-ldap-pg,copy-ldap-pg" description="Build for LDAP and P
</target>
<target name="deploy-2parts" depends="install,package-2parts,copy-2parts" description="Build 2parts and copy t
</target>
<target name="package-ldap-pg" description="Package for LDAP and Postgres">
<antcall target="package">
<param name="assembly.name" value="template-ldap-pg" />
</antcall>
</target>
<target name="package-2parts" description="Package Nuxeo-EP in two parts">
<param name="jboss.home" value="${jboss1.dir}" />
<param name="assembly.name" value="template-stateful" />
</antcall>
<param name="assembly.name" value="template-stateless" />
</antcall>
</target>
<target name="package-3parts" description="DEPRECATED: Package Nuxeo-EP in three parts">
<param name="assembly.name" value="nuxeo-core" />
</antcall>
<param name="assembly.name" value="nuxeo-indexing" />
</antcall>
<param name="assembly.name" value="nuxeo-webplatform" />
</antcall>
</target>
<target name="package" depends="setproperties,package-unix,package-windows" description="Package Nuxeo-EP" />
<target name="package-unix" if="osfamily-unix">
<echo message="assembly NAME ${assembly.name}" />
<exec executable="mvn" failonerror="true">
<arg value="clean" />
<arg value="package" />
Nuxeo EP 5.3 365

Packaging Nuxeo EAR
<arg value="-Dmaven.test.skip=true" />

<arg value="-f" />
<arg value="${template.ear.root}/pom.xml" />
<arg value="-Dtemplate.ear.assembly=${assembly.name}" />
<arg value="${mvn.opts}" />
</exec>
<echo message="Packaged ${ant.project.name} into ${template.ear.build}" />
</target>
<target name="package-windows" if="osfamily-windows">
<exec executable="cmd" failonerror="true">
<arg value="/c" />
<arg value="mvn.bat" />
<arg value="package" />
<arg value="-f" />
<arg value="${template.ear.root}/pom.xml" />
<arg value="-Dtemplate.ear.assembly=${assembly.name}" />
</exec>
</target>
<target name="install" depends="install-unix,install-windows" description="Run mvn install" />
<target name="install-unix" if="osfamily-unix">
<exec executable="mvn" failonerror="true">
<arg value="install" />
</exec>
</target>
<target name="install-windows" if="osfamily-windows">
<exec executable="cmd" failonerror="true">
<arg value="/c" />
<arg value="mvn.bat" />
<arg value="install" />
</exec>
</target>
<target name="web" description="Copy web files to a live JBoss">
<copy todir="${deploy.dir}/nuxeo.ear/nuxeo.war">
<fileset dir="${basedir}/template-platform/src/main/resources/nuxeo.war/" />
</copy>
</target>
<target name="rename">
<delete dir="${build.dir}/${nuxeo.ear}" failonerror="false" />
<move file="${build.dir}/template.ear" tofile="${build.dir}/${nuxeo.ear}" />
</target>
<target name="copy-lib">
<delete failonerror="false">
<fileset dir="${deploy.lib.dir}/">
<include name="nuxeo*.jar" />
</fileset>
</delete>
<copy todir="${deploy.lib.dir}/" failonerror="true">
<fileset dir="${build.dir}/${build.lib.dir}/" />
</copy>
</target>
<target name="copy-ldap-pg" description="Copy template on LDAP and Postgres">
<antcall target="copy">
<param name="assembly.name" value="template-ldap-pg" />
</antcall>
</target>
<target name="copy-2parts" description="Copy Nuxeo-EP in two parts">
<param name="assembly.name" value="template-platform-stateful" />
</antcall>
<param name="assembly.name" value="template-web-stateless" />
</antcall>
</target>
<target name="copy-3parts" description="DEPRECATED: Copy Nuxeo-EP in three parts">
<param name="assembly.name" value="nuxeo-core" />
</antcall>
<param name="assembly.name" value="nuxeo-indexing" />
</antcall>
<param name="assembly.name" value="nuxeo-webplatform" />
</antcall>
</target>
<target name="copy" depends="delete-ear,copy-ear,copy-lib" description="Replace ear and copy libs to jboss" />
<target name="delete-ear" depends="setproperties">
Nuxeo EP 5.3 366

Packaging Nuxeo EAR
<delete dir="${jboss.nuxeo.ear}" failonerror="false" />

</target>
<target name="copy-ear" depends="setproperties">
<mkdir dir="${jboss.nuxeo.ear}" />
<copy todir="${jboss.nuxeo.ear}">
<fileset dir="${template.ear.build}" />
</copy>
</target>
<target name="copy-jars">
<copy todir="${deploy.dir}/${nuxeo.ear}/plugins" overwrite="true" flatten="true">
<fileset dir="${basedir}">
<include name="*/target/*.jar" />
<exclude name="*/target/*-sources.jar" />
</fileset>
</copy>
</target>
</project>
56.5. Recommended multi-machine packagings
56.5.1. Bi-machine: stateful/stateless
56.5.1.1. Introduction
Stateful/Stateless packaging gives a good solution to a lot of production requirements. Principle is to split
Nuxeo in two parts: one that contains the core and every services that persist data, and another that provides
web services. Stateless part may be duplicated.
56.5.1.2. Packaging
Bi-machine packaging is done by two assembly descriptors, each one building an EAR to deploy on a separate
server.
To build your own bi-machine packaging, copy the template-project structure. Copy and adapt Ant, Maven and
descriptor files. Then, configure artifactSet and fileSet that will deploy your project's artifacts into the plugin
directory and the wanted resources to replace those deployed by default.
Example 56.3. Sample of customized assembly for a stateful EAR

<assembly>

<assemble>
</assemble>
<artifact>
org.nuxeo.ecm.platform:nuxeo-platform-ear:${nuxeo.platform.version}:zip:resources-platform-stateful
</artifact>
</zipEntrySet>

<assemble>
<set>system</set>
</assemble>
<import>**</import>
<includes>
<artifact group="org.nuxeo.*" category="core,stateful" />

Nuxeo EP 5.3 367

Packaging Nuxeo EAR
</includes>
<excludes>
</excludes>
</artifactSet>
<assemble>
<unpack>true</unpack>
<unpackInNewDirectory>true</unpackInNewDirectory>
<set>nuxeo-platform-unpacked</set>
</assemble>
<artifactSet id="nuxeo-platform-unpacked">
<import>**</import>
<includes>
</includes>
</artifactSet>
<assemble>
</assemble>
<artifacts>
version="3.1" />
version="1.1.1" />
version="1.1.5" />
version="1.1.5" />
version="0.9.7" />
</artifacts>
</artifactSet>
<assemble>
</assemble>
<import>**</import>
<includes>
<artifact name="template-core" />
<artifact name="template-stateful-services" />
</includes>
Nuxeo EP 5.3 368

Packaging Nuxeo EAR
<excludes>
<artifact group="!org.nuxeo.projects.template" />
</excludes>
</artifactSet>
<assemble>
</assemble>
<excludes>
</excludes>
</fileSet>
<assemble>
<set>template-resources-stateful</set>
</assemble>
<fileSet id="template-resources-stateful">
<directory>src/main/resources_template_stateful</directory>
</fileSet>
</assembly>
Example 56.4. Sample of customized assembly for a stateless EAR

<assembly>

<assemble>
</assemble>
<artifact>
org.nuxeo.ecm.platform:nuxeo-platform-ear:${nuxeo.platform.version}:zip:resources-web-stateless
</artifact>
</zipEntrySet>

<assemble>
<set>root-artifacts</set>
</assemble>
<artifactSet id="root-artifacts">
<import>**</import>
<includes>
</includes>
</artifactSet>
<assemble>
<set>system</set>
</assemble>
<import>**</import>
<includes>
<artifact group="org.nuxeo.*" category="stateless" />

</includes>
<excludes>
<artifact name="nuxeo-apt-extensions" />
</excludes>
</artifactSet>
<assemble>
Nuxeo EP 5.3 369

Packaging Nuxeo EAR
</assemble>
<artifacts>
version="3.1" />
version="1.1.1" />
version="1.1.5" />
version="1.1.5" />
version="0.9.7" />
</artifacts>
</artifactSet>
<assemble>
</assemble>
<import>**</import>
<includes>
<artifact name="template-web" />
<artifact name="template-stateless-services" />
</includes>
<excludes>
<artifact group="!org.nuxeo.projects.template" />
</excludes>
</artifactSet>
<assemble>
</assemble>
<excludes>
</excludes>
</fileSet>
<assemble>
<set>template-resources-stateless</set>
</assemble>
<fileSet id="template-resources-stateless">
<directory>src/main/resources_template_stateless</directory>
</fileSet>
</assembly>
56.5.1.3. Network configuration
Nuxeo EP 5.3 370

Packaging Nuxeo EAR
Stateful is identified in configuration files as nxplatformserver and nxjmsserver. Stateless is known as

nxwebserver. You can set this in your hosts files.
If you deploy multiple stateless servers, the unique (for now it cannot be duplicated) stateful server only need to
know one stateless server. Stateless servers do not need to communicate between each other.
Note
There is misconfiguration in Nuxeo EP 5.1.6 and 5.2.M3 (http://jira.nuxeo.org/browse/NXP-2838).
Replace in nuxeo-web-stateless.ear/datasources/core-events-ds.xml
java.naming.provider.url=${jboss.bind.address}:1099
with
java.naming.provider.url=nxjmsserver:1099
Nuxeo EP 5.3 371

Chapter 57. Release Management
57.1. Introduction
Nuxeo EP and related components can use the maven release plugin to prepare and perform releases of Nuxeo
components.
The release of a project usually consists in those operations:

• perform a clean checkout and launch the tests
• change version numbers
• tag sources in the source control system (ex: SVN)
• update version number of the trunk to start the new development cycle
• publish software and related information
The maven release plugin streamlines and automates the release process of software components.
To get more background about maven release, you can read following pages:
• mini-guide on Maven Release
• maven release main site
57.2. Let's release!

When your software is ready to be released, you want to launch the release process. :-)
This process has to be as easy as possible. You will be able to find bellow the basic process.
57.2.1. Remove all dependencies on SNAPSHOT versions

To enforce that the build is reproducible, maven refuses to create a new release if there are dependencies on
SNAPSHOT versions.
The first step is then to remove all dependencies on SNAPSHOT versions. Of course, as you may not be able to
release all your dependencies as long as your software, you can create specific versions of your dependencies
for the release.
Here is the fastest way:
$ mvn deploy:deploy-file -DrepositoryId=central \ ❶

-Durl=scpexe://amour.nuxeo.org/home/nexus/repositories/vendor-release \ ❷
-DgroupId=org.apache.myfaces.trinidad \ ❸
-DartifactId=trinidad-impl \ ❹
-Dversion=1.0.1-incubating-NXEP51M2 \ ❺
-Dpackaging=jar \ ❻
-Dfile=trinidad-impl-1.0.1-incubating-NXEP51M2.jar ❼
❶❷ Informations of the repository you are using. For Nuxeo's software, use:
• repositoryId: central
• url: scpexe://amour.nuxeo.org/home/nexus/repositories/vendor-release>
Nuxeo EP 5.3 372

Release Management
Of course, you will need write permission on the repository. You can request it from your repository's
manager.
❸❹❺❻
• groupId: the group id for the artifact, you should get it for the pom of this artifact
• artifactId: idem
• packaging: usually jar (or pom if you are only deploying a pom file)
❼ Point to the file (usually jar or pom) you want to upload.
57.2.2. Checkout the code and clean your repository

First, you need to get a fresh copy of the components you are about to release.
$ mvn scm:checkout svn:http://server/yoursoftware/trunk
To be sure that everything is clean and that you will test in the same environment as new users, remove your
repository. On windows, remove your repository using your preferred tool. On Linux/Unix/MacOS, you can
perform:
$ rm ~/.m2/repository
to remove your entire maven repository.
57.2.3. Test the release

Let's try to build and test the software before launching a dry run of the release process.
mvn install
This should download all required dependencies (since you've clean your maven repository in the previous
paragraph) and build the software.
We now can test the release preparation process.

mvn release:prepare -DdryRun=true
Answer, now to the questions maven will ask about version numbers and tag name. This will simulate a release
preparation, especially the svn tags.
If everything went well until that point, we can actually perform the release...
57.2.4. Perform the release

For each component you want to release, do:
mvn release:prepare release:perform
This will tag your sources in the SCM, build the software, build the site upload your artifact to the defined
repository and deploy your site.
In Nuxeo's case, you need to release first the global master POM before releasing other component, if the
master POM is using a SNAPSHOT version. To achieve this, go to a checkout of the master POM and do a
non-recursive release using:
mvn -N release:prepare release:perform
Then you can set master POM's new version number into each component you want to release and start the
release process.
Nuxeo EP 5.3 373

Release Management
57.2.5. You're done

Now you're done. You have released your software using maven release and you can happily use your new
component in your projects or deliver your customer! :-)
Nuxeo EP 5.3 374

Part VII. Add-ons
Nuxeo EP 5.3 375

Chapter 58. Add-ons
58.1. Introduction
Add-ons are modules you can add to a Nuxeo instance and that provide additional functionalities. To install an
add-ons, download the modules from http://download.nuxeo.org/ and copy them in the /plugins directory of
your Nuxeo instance. For additional set-up, refer to the specific add-on's documentation.
Nuxeo EP 5.3 376

Chapter 59. Nuxeo Annotation Service
59.1. Introduction
59.1.1. W3C Annotea

Nuxeo Annotation service is based on Annotea W3C specification. It is compliant with the specification
published at Annotea Protocol .
However the annotea specification is quite old and does not handle all use cases for annotating documents in
the context of Nuxeo ECM. Therefore, we propose to provide some extensions to annotea. Using the repository
plugin, it provides a plugable system to be able to keep track of the relationship between an annotated URL and
the underlying nuxeo document.
Inside Nuxeo EP we need to be able to annotate the HTML preview of a document. This preview may include
images. This images are annotable as the rest of the document, but it requires an extension to the Xpointer
specification since user may want to annotate just a portion (zone) of the image.
59.1.2. Logical architecture overview

This section provides an overview of the logical architecture of the Nuxeo Annotation service.
• Annotation Service API nuxeo-platform-annotations-api
Provides Java API and all the needed Java artifacts needed to call the Annotation service remotely.
• Annotation Service Core nuxeo-platform-annotations-core
Provides the Nuxeo Service that exposes the required annotation Java Interface. This service is
implemented as a Nuxeo Runtime component and will provide the needed extension points .
• Annotation Service Facade nuxeo-platform-annotations-facade
Provides the service EJB3 facade for remote (RMI) access.
• Annotation Service Http gateway nuxeo-platform-annotations-http
The HTTP Gateway implements the Annotea HTTP protocol. It is implemented as a servlet that enable
access to the annotation service via http GET/POST requests as defined in the W3C Annotea
specification.
• Annotation Service Web Interface nuxeo-platform-annotations-web
The web interface provides ways to annotate document.
59.1.3. XPointer integration and extension.

Annotea uses XPointer to annotates part of a web pages. We added a image-range function to XPointer to be
able to annotates part of an image. A XPointer using image-range looks like:
"http://example.com/foo.html#xpointer(image-range(/html[1]/body[0]/img[0],[79,133],[123,159]))". The form
is "image-range(location-set , [tlX,tlY], [brX,brY])", with the location-set defined in the XPointer
documentation, pointing to an image. tlX, tlY, brX and brY are integer for the top left X, top left Y, bottom
right X and bottom right Y coordinates of a square within the annotated original image (as stored on the server).
That is, if the size of the image is dynamically modified using Javascript, an image-range should always point
to the same area of the image.
Nuxeo EP 5.3 377

Nuxeo Annotation Service
59.2. Annotation Service Core
59.2.1. Overview
This is the main component of NXAS, the one that contains all the logic for managing RDF based annotations.
The Core Service is not document aware and manages only URIs.
URI, URL and URN

A URL is "http://foo.com/index.html", a URN doesn't use a protocol: "nuxeo:default:12345678". A
URI is a URL or a URN.
This component is also responsible for exposing all the needed extension points that will be used for
configuration and integration.
59.2.2. Implementation
The service is implemented as a Runtime service on top of a Nuxeo Runtime component. The runtime
component provides the extension point mechanisms. The API provided by the service will target managing
annotations on URLs.
As any Nuxeo Service, the Annotation Service is accessible via the Runtime lookup method :
Framework.getLocalService(AnnotationService.class)
Implementation Note
The core function of the annotation service is to add/remove/query annotations from the RDF
Graph. It also has to provide security and add configurability. The implementation separates those
2 functions in 2 classes: The AnnotationServiceProxy class implements all the configuration, event
management and security function and let the AnnotationServiceImpl provides the core RDF
service.
59.2.3. Storage
The Annotation service stores the annotations as a RDF graph. Nuxeo Relation Service is responsible for
storing and managing the RDF data. The service uses a graph named "annotations". The default contribution is:
<component name="org.nuxeo.ecm.annotations.graph">
<require>org.nuxeo.ecm.platform.relations.jena</require>
<extension target="org.nuxeo.ecm.platform.relations.services.RelationService"
point="graphs">
<graph name="annotations" type="jena">
<option name="backend">sql</option>
<option name="databaseType">${org.nuxeo.ecm.sql.jena.databaseType}</option>
<option name="databaseTransactionEnabled">
${org.nuxeo.ecm.sql.jena.databaseTransactionEnabled}
</option>
<option name="datasource">java:/nxrelations-default-jena</option>
<namespaces>
<namespace name="rdf">http://www.w3.org/1999/02/22-rdf-syntax-ns#</namespace>
<namespace name="dcterms">http://purl.org/dc/terms/</namespace>
<namespace name="nuxeo">http://www.nuxeo.org/document/uid/</namespace>
</namespaces>
</graph>
</extension>
</component>
Refer to the Relation Service documentation ( Chapter 24, Relations ) for more information on configuration
options.
Nuxeo EP 5.3 378

59.2.4. uriResolver
The uriResolver extension point allows to contribute a class that is responsible for resolving uri. It maps URI
sent by the client to URI stored in the graph. It also allows to translate a URI in a list of URIs when querying
the graph.
This allows to consider annotations on different URLs to be considered as annotations on the same document,
therefore being able to see those annotations on both URLs.
To contribute a uriResolver contribute to the extension point a class that implements the UriResolver interface.
<extension
target="org.nuxeo.ecm.platform.annotations.services.AnnotationsService"
point="uriResolver">
<urlResolver
class="org.nuxeo.ecm.platform.annotations.service.DefaultUriResolver"/>
</extension>
The DefaultUriResolver maps URI without changing them, unless it includes "nuxeo/Annotations" in its URL.
In such a case, it transform the URL in a URN of the form "urn:annotation:***".
59.2.5. urlPatternFilter
The urlPatternFilter extension point allows to contribute regular expression pattern to the list of allowed URL
pattern or disallowed URL pattern. When a request is made to get/set annotations on an URL, the server check
the list.
The check is done before any transformation on the URL. Because the check on URL is done very early in the
processing of a request, to increase performance, it is recommended to use it whenever possible.
The filter follows Apache's mod_access convention to filter URL. The default contribution is:
<extension
point="urlPatternFilter">
<urlPatternFilter order="Deny,Allow">
<deny>.*</deny>
<allow>.*</allow>
</urlPatternFilter>
</extension>
59.2.6. metadata
The metadata extension point allows to add metadata to an annotations when it is created. The contribution
needs to implement the MetadataMapper interface. It is passed the annotation to which it can add the metadata.
The default contribution:
<extension
point="metadataMapper">
<metadataMapper
class="org.nuxeo.ecm.platform.annotations.service.DefaultMetadataMapper">
</extension>
This contribution adds the date and creator to the annotation. Note that you can add metadata and modify the
annotation before sending it to the service. You could choose to add the creation time using the local time of
the client and add it to the annotation without using the metadatMapper.
59.2.7. permissionManager and permissionMapper
Nuxeo EP 5.3 379

The permissionManager extension point allows to contribute a class that checks before CRUD operations. The
permissionMapper will maps permission name with operation.
The permissionMapper extension point allows to contribute the name of the permission to check before a
CRUD operation. The default contribution is:
<extension
point="permissionMapper">
<permissionMapper>
<createAnnotation>createAnnotation</createAnnotation>
<readAnnotation>readAnnotation</readAnnotation>
<updateAnnotation>updateAnnotation</updateAnnotation>
<deleteAnnotation>deleteAnnotation</deleteAnnotation>
</permissionMapper>
</extension>
The permissionManager extension point allows to contribute a class to check before CRUD operations. The
default permission manager allows all operations to everybody:
<extension
point="permissionManager">
<permissionManager
class="org.nuxeo.ecm.platform.annotations.service.DefaultPermissionManager"/>
</extension>
59.2.8. annotabilityManager
The annotabilityManager extension point allows to contribute a class to fine grain which documents can be
annotated. An implementation needs to implement the interface AnnotabilityManager . The default
annotability manager is:
<extension
point="annotabilityManager">
<annotabilityManager
class="org.nuxeo.ecm.platform.annotations.service.DefaultAnnotabilityManager"/>
</extension>
It allows annotations on all URL.
59.2.9. UID Generation

When an annotation is created it is given a UID. This extension point allows to contribute a UID generator. The
default contribution is:
<extension
point="annotationIDGenerator">
<IDGenerator class="org.nuxeo.ecm.platform.annotations.service.DefaultIDGenerator"/>
</extension>
This default contribution create a UID using java java.util.UUID.randomUUID() .
59.2.10. Event management

The eventManager extension point allows to contribute a listener class to handle annotation related events. The
listener class has to implement the interface. EventListener . There is one method for each CRUD operation,
before and after the operation. The calls are made synchronously. There is no default contribution to this
extension point.
59.3. NXAS Repository Plugin
Nuxeo EP 5.3 380

59.3.1. Overview
NXAS core offers an implementation of an Annotea Server. It is "pure" RDF and relies on URI for resource
identification. However, Nuxeo deals with versionned document. The repository plugin allows to contribute to
the core module using Nuxeo's object of DocumentModel, ACP and Version.
The repository plugin contribute to Core NXAS, replacing most of the default contribution. You can then
contribute to the repository plugin to tune security, annotability and more.
Querying using a DocumentModel

The Annotation Service uses URI exclusively, if you need to query using a DocumentModel, you
need to obtain the URN for this document:
URNDocumentViewTranslator translator = new URNDocumentViewTranslator();

String documentId = documentModel.getId();
String serverName = coreSession.getRepositoryName();
URI uri = translator.getNuxeoUrn(serverName, documentId);
You can then use the uri for the query method.
59.3.2. Default contribution

This section describes the default contribution made to the annotation service. You should not change them if
you use the repository plugin. To modify the repository plugin behavior, use its extension point (
Section 59.3.3.1, “ documentAnnotability ” ).
59.3.2.1. permissionMapper
The permission are mapped to the document that is being annotated:

<extension
point="permissionMapper">
<permissionMapper>
<createAnnotation>updateDocument</createAnnotation>
<readAnnotation>viewDocument</readAnnotation>
<updateAnnotation>updateDocument</updateAnnotation>
<deleteAnnotation>deleteDocument</deleteAnnotation>
</permissionMapper>
</extension>
59.3.2.2. uriResolver
The defaultNuxeoUriResolver transform the URI if it points to a Nuxeo document. The URI becomes a URN
using the docId and repository name.
59.3.2.3. metadataMapper
In addition to the default mapper, the DefaultNuxeoMetadataMapper add the company of the user.
59.3.2.4. permissionMapper
The name of permission are the same as the document permission.
59.3.2.5. annotabilityManager
The contribution to the annotability manager will call the documentAnnotabilityManager.
Nuxeo EP 5.3 381

59.3.2.6. eventListener
The contribution to the eventListener will call the corresponding AnnotatedDocumentEventListener.
59.3.3. Extension Point
59.3.3.1. documentAnnotability
The documentAnnotability extension point allows to choose which document are annotable. To contribute to
this point, create a class that implement DocumentAnnotability . The default implementation is (
DefaultDocumentAnnotability ), allows annotations on all documents.
59.3.4. documentEventListener
The documentEventListener allows to contribute class that would be notify when an annotation is create,
updated, read and deleted. Notification comes synchronously before and after the event. It is passed as
parameter the annotation and the DocumentLocation of the the document being annoted.
A default contribution notify the JMS bus.
59.3.5. securityManager
The security manager extension point allows to contribute a class that implements the SecurityManager
interface. It fine grains security using NuxeoPrincipal, the permission checked and the DocumentMode.
59.3.6. jcrLifecycleEventId and graphManagerEventListener

The jcrLifecycleEventId and graphManagerEventListener allows to modify the RDF graph when an event
happens in the repository. The jcrLifecycleEventId list the jms event we listen to. The
graphManagerEventListener extension point allows to contribute a class that would be called when such event
are received.
The default implementation is DocumentVersionnedGraphManager. It listens to the documentCheckedIn event.

This event is sent when a new UUID is created for a document. The manager add, to each annotation that
annotates the old UID, a new annotates statement with the new UID. The result is that when you version a
document, the old version will have the same annotation than the new version, but annotation on the new
version will not be seen in the old version.
59.4. NXAS Web
59.4.1. Overview
The NXAS HTML Client is the a web interface that can be used by the end user. It is written in GWT. It can be
configured in two ways. The "normal" Nuxeo way of extension point, or adding attribute or object to the html
page to be read by the gwt module.
Implementation Note
59.4.2. Extension Point

The WebAnnotationConfigurationService allows to contribute:
Nuxeo EP 5.3 382

• the different types of annotations you want to manage in your application. The default contribution
provides the 6 annotea protocols types: SeeAlso, Question, Explanation, Example, Comment, Change
and Advice.
• the filters you may want to use in your application. They are displayed as button on the left side. The
default contribution shows no filter.
• the displayed fields: fields you want to display in the annotations list in addition to the icon and the date.
• a class implementing the UserInfoMapper interface to add to the WebConfiguration some informations
about the current user.
• a class implementing the WebPermission interface to let know to the client if annotations are allowed or
not on the current document.
For more informations and examples, see the files web-configuration-service-contrib.xml and
web-configuration-service-framework.xml located in the nuxeo-platform-annotations-web project.
59.4.3. Configuration
59.4.3.1. Panel Element
The client uses a div with id "display" to add the annotation application to the current page.
59.4.3.2. Preview setting
To allow integration with the preview module, additional configuration is possible via a div with an id of
"preview-setting". Each configuration is an attribute of the div.
• imageOnly value should be true or false. If only the image should be annotated in the frame.
• multipleImageAnnotation should be true or false. If more than one image should be annotated.
• The annotation module uses 2 functions to transform the xpointer gotten from clicking on an image, and
to transform a xpointer to a xpointer that make sens in the previewed image. It get the function from
top[xPointerFilterPath] and top [pointerAdapter]. xPointerFilterPath and pointerAdapter are the value of
the same named attribute.
59.5. Annotation Service Facade

The facade provides the integration of the service into JEE infrastructure. EJB3 Stateless Session Bean facade
on top of the runtime service. This makes the Annotation Service remotable and accessible via the standard
Nuxeo Lookup facility :
Framework.getService(AnnotationService.class)
59.6. Annotation Service HTTP Gateway
59.6.1. Overview
The Annotation Service HTTP gateway provides the http API on top of the java APi of the Annotation Service
It is a servlet that implements the annotea protocol.
Nuxeo EP 5.3 383

59.7. References
• W3C Annotea Protocol
• Nuxeo preview addon
• XPointer
Nuxeo EP 5.3 384

Chapter 60. Virtual Navigation
60.1. Virtual Navigation

This section is speaking about a Nuxeo addon that provides a new way to navigate in documents.
60.1.1. Virtual Navigation presentation

Virtual navigation is opposed to the physical navigation. The physical navigation is the intuitive way to browse
your documents as you created them, folders contain documents. Virtual Navigation is based on meta-data
linked with every documents. In Nuxeo 5 each document has a set of meta-data that make him more precise and
rich. The Virtual Navigation can provide a navigation tree built on meta-data and more precisely on every
vocabulary based data.
Now the basic Virtual Navigation configuration offers a navigation through coverage and through subjects. For
each document it is possible to determine a country that is relative to the document and one or many subjects
that corresponds well to it.
To activate the Virtual Navigation you have to add the Virtual Navigation addon in the plugin extension folder
of your JBoss server. After restarting the server you can see a new widget in the left hand corner of Nuxeo 5.
You can switch between navigation style easily.
The standard physical navigation is still here and the two Virtual Navigation are selectable on the right. As you
can see the Virtual Navigation keeps a folder based navigation but this tree browsing is built from vocabularies
defined in your Nuxeo 5 instance. Coverage and Subjects are 2 vocabularies that exist in the basic Nuxeo 5
configuration. You may know that tree based vocabularies are not limited in depth and you can have 2 or more
level in your vocabulary, for example Coverage allows to select a continent and a country.
To have good results with Virtual Navigation you have to fill meta-data linked to documents. The Meta-Data
view allows the user to provide his own meta-data. Select a country and/or subjects to make your Virtual
Navigation efficient. See below to view the Meta-Data configuration screen.
When selecting a node in a Virtual Navigation tree it will execute a request to find every documents that
contain the wanted meta-data. See the screen below for an example: if you select the Art/Architecture couple in
the Subjects navigation tree, every documents that contains Art/Architecture in their Subjects meta-data will be
displayed on screen.
60.1.2. Virtual Navigation configuration

The basic Virtual Navigation configuration, as seen above, offers 2 way to navigate through meta-data in
addition to the classic physical navigation, by coverage and by subjects. Here is a complete walkthrough to add
a new virtual navigation to a customized project.
60.1.2.1. Required precondition
You have to create a vocabulary that will be used for the new Virtual Navigation, keep in mind that you can set
up a multi-level vocabulary, so you can imagine a vocabulary with parent and children. There is no limitation
on this side.
You have to select the element in a schema that will store your vocabulary data. In the basic Nuxeo 5
configuration it is dublincore:coverage and dublincore:subjects that store vocabularies data for Virtual
Navigation. If fact, when you select a country (coverage) in a document's meta-data, the country is stored in the
dublincore:coverage element. It's not mandatory to select a dublincore element, you can select an element
coming from your own schemas.
Nuxeo EP 5.3 385

Virtual Navigation
60.1.2.2. Set up your vocabulary
If you have a "only-one-level" vocabulary you can create a file to store it like this :
Example 60.1. Example to create your own vocabulary
id, label, obsolete

"art","label.directories.topic.art","0"
"human sciences","label.directories.topic.humanscience","0"
"society","label.directories.topic.society","0"
"daily life","label.directories.topic.dailylife","0"
"technology","label.directories.topic.technology","0"
If you have a "multi-level" vocabulary you have to split him in sub vocabulary, and keep in mind that you have
to indicate which vocabulary element is the child of which parent vocabulary element, here is an example, the
full example can be found in Nuxeo 5 sources, check topic.csv and subtopic.csv:
Example 60.2. Example to create your own multi-level vocabulary
CONTENT OF THE FIRST FILE (parents)

id, label, obsolete
"art","label.directories.topic.art","0"
"human sciences","label.directories.topic.humanscience","0"
"society","label.directories.topic.society","0"
"daily life","label.directories.topic.dailylife","0"
"technology","label.directories.topic.technology","0"
CONTENT OF THE SECOND FILE (with a "parent" parameter added)

id, label, parent, obsolete
"architecture","label.directories.subtopic.architecture","art","0"
"comics","label.directories.subtopic.comics","art","0"
"rights","label.directories.subtopic.rights","human sciences","0"
"economy","label.directories.subtopic.economy","human sciences","0"
...
When you have created your different files for vocabularies you have to register them in an extension point as
new vocabularies. In an xml file that you won't forget to place in a OSGI-INF directory and won't forget to
register in the MANIFEST.MF file of the package, you have to contribute the following extension point.
For a full example you can check the nxdirectories-contrib.xml file of the webapp-core package. Don't forget
to use the xvocabulary schema if your vocabulary is a child of another, if the vocabulary is the first parent or is
alone just use the vocabulary schema. Don't forget to indicate the parent if your vocabulary has more than one
level with the following tag <parentDirectory></parentDirectory>.
Example 60.3. How to register new vocabularies
//here your new vocabularies contribution
</extension>
60.1.2.3. Set up a new Document Type for search purpose
The query based search service of Nuxeo 5 requires that you create a document type that will be a base for a
Nuxeo EP 5.3 386

Virtual Navigation
document model to register data handled by the query. To understand it more here is an example:
You are browsing your documents by coverage. You are selecting the path Europe/France in the tree. The data
Europe/France is the base of the query and need to be registered in a document model created from a document
type. In this case the document type can be very simple, cause the query must register only one data at a time.
Creating a document type with only one schema that contains one field will be enough.
This document type will be referenced as query document type in this walkthrough. Create it and register it as
a normal document type. See Nuxeo Book part 6 to get more informations about document type creation.
60.1.2.4. Set up new navigation tree
Now you must contribute to another extension point to create a new navigation tree based on vocabularies you
contributed just before. See below for an example of the file you have to create. For a full example you can see
the directorytreemanager-contrib.xml file in the virtualNavigation package.
The new tree contribution needs many informations, a queryModel to indicate the query you will use to get
your documents, a schema and a field coming from the query document type you just set up in part 3, an
outcome that indicates the page where documents will be displayed after the request and a list of vocabularies
you can indicate with the tag <directory></directory>.
Example 60.4. How to register new navigation trees
<require>
org.nuxeo.ecm.webapp.directory.DirectoryTreeService
</require>
<extension
target="org.nuxeo.ecm.webapp.directory.DirectoryTreeService"
point="trees">
//here your new navigation tree contribution
</extension>
60.1.2.5. Set up the queryModel and the Result Provider
Now you need to contribute to 2 extension points that will set up the query and the results provider. Here are
the 2 extension point you will need to contribute. For a full example see the file querymodel-contrib.xml and
resultsprovider-contrib.xml in the virtualNavigation package.
The query model contribution needs many information. In the docType parameter you have to put the name of
the documentType you created in part 3. In the <predicate></predicate> tag you must set up the name of the
element (field) that is the field storing the data used for virtual tree construction.
EXAMPLE :
You want to browse documents by coverage, each of your document have a coverage registered in dc:coverage
field. You have to use the dc:coverage parameter.
If there is no prefix set the name like this schema:field, if there is a prefix set it up like this prefix:field. In the
operator param put the value STARTSWITH. In the <field/> tag put the schema and the name of the field
coming from the query document type you set up in part 3.
Example 60.5. How to register query model and results provider
<extension
target="org.nuxeo.ecm.core.search.api.client.querymodel.QueryModelService"
point="model">
//Here your new query model
Nuxeo EP 5.3 387

Virtual Navigation
</extension>
<extension
target="org.nuxeo.ecm.webapp.pagination.ResultsProviderService"
point="model">
//Here your new result provider
</extension>
60.1.2.6. Set up the search service
Now you need to register a new indexing configuration in the search service. You will index the field that
register the data you want to apply the search on, it is the same data as saw at the end of part 5 . Here is the
extension point you have to contribute. For a full example see the nxsearch-contrib.xml file in the
search-core package.
You will have to create a new <resource></resource> tag if it doesn't exist for your schema. For the name
parameter you have to put the name of your schema, type param must be "schema" and indexAllFields param
must be "true". In a <field/> tag you have to indicate the indexing strategy, the type param must be "Path", if
the field that register your vocabulary is a complexType (list of String for example) you can add the parameter
multiple and set it at "true".
Example 60.6. How to register the search configuration
<extension
target="org.nuxeo.ecm.core.search.service.SearchServiceImpl"
point="resource">
//Here your new search configuration
</extension>
60.1.2.7. Other details
You must not forget to add some navigation cases in a deployment-frgament.xml file. Those navigation cases
must correspond at each outcome you set up in part 3. Each page named in navigation cases shall display
search result so you have to customize those pages with the good queryModel call. For a full example see
coverage_virtual_navigation.xml .
All theme contributions and tree navigation widget already exist in webapp-core and virtualNavigation
package, you can take a look for information purpose.
Indeed you have to add vitualNavigation to Nuxeo 5 plugin if you want a fully fonctional Virtual Navigation
immediatly.
Nuxeo EP 5.3 388

Chapter 61. Metadata Extraction Service
61.1. Introduction
There are cases when some informations could be retrieved from attached files and keep this info as regular
Document properties. This info is referred to as metadata as it is a descriptive info referring the document (file)
from which it is extracted. For example given a MS Word document (file) we could retrieve info (metadata)
like author, title, creation date etc, simply by reading document headers with an appropriate library (that knows
how to parse and keep a MS Word document internal structure).
61.2. Metadata extraction module

The metadata extraction feature is composed of several projects:
- nuxeo-platform-metadataext-api
- nuxeo-platform-metadataext-core
- nuxeo-platform-metadataext-facade
- nuxeo-platform-metadataext-plugins
The core part defines the metadata extraction component with a MetaDataExtractionManager implementation:
org.nuxeo.ecm.platform.metadataext.services.MetaDataExtractionService.
The service is normally invoked by a dedicated CoreListener that passes a DocumentModel for which an
extraction could be defined. Also the metadata could be extracted by direct invocation from a client code
through existing EJB3 facade.
The plugin part provides a plugin (more to come) which is specific to the MS-Word document type. The plugin
is a Transformation Plugin (as defined by the Transformation service) and gets invoked as part of a defined
transformation chain. The appropriate transformation will be called by the metadata extraction service if there
is a contribution for the given Document type, etc.
61.2.1. Defining a contribution for metadata extraction

A contribution can be defined by adding an XML file with the following structure:
<extension
target="org.nuxeo.ecm.platform.metadataext.services.MetaDataExtraction"
point="extractions">
<meta-data-extraction inputField="file:content"
transformationName="MSWordMDExt">
<outputParams>
<param propertyName="dc:title">title</param>
<param propertyName="dc:description">comments</param>
<param propertyName="dc:created">creationDate</param>
<param propertyName="dc:modified">creationDate</param>
<param propertyName="dc:contributors">authors</param>
</outputParams>
<coreEvent>documentCreated</coreEvent>
<coreEvent>documentModified</coreEvent>
<docType>File</docType>
</meta-data-extraction>
</extension>
The important aspects for MetaDataExtraction service are:
Nuxeo EP 5.3 389

Metadata Extraction Service
- specification of a source (blob) from where metadata will be extracted. This is defined by the value
inputField which should be a blob document property.
- the mapping of output parameters. This defines a correspondence between the map entries returned as the
result of transformation (extraction) and the Document properties names to which the results will be written
back.
- the list of core events for which the extraction will be performed.
- the list of document types for which the extraction can be applied.
61.2.2. Specifying input parameters

If the extraction is requiring additional information aside from the provided blob, we can add input parameters
to an extraction definition like this:
<inputParams>
<param propertyName="dc:title">title</param>
</inputParams>
A map with input parameters will be passed to the extraction plugin having the key the value of tag param (in
this case 'title').
61.2.3. Chaining extractions

In extreme cases the extractions of metadata could be performed in several steps. That is using the extracted
parameters in phase as input parameters for the next phase. This could be achieved by specifying the input
params whose values could have been set by a previous extraction (transformation).
61.2.4. Creating a plugin for metadata extraction

We first define a class implementing org.nuxeo.ecm.platform.transform.interfaces.Plugin interface like:
public class MSWordMDExtractorPlugin extends AbstractPlugin {

@Override
public List<TransformDocument> transform(Map<String, Serializable> options,
TransformDocument... sources) throws Exception {
...
}
...
}
Overriding the transform method is a must and in this case we will have only one TransformDocument as
source.
The blob from which metadata could be extracted can be retrieved from TransformDocument like: Blob
srcBlob = sources[0].getBlob().
After the useful information is extracted the properties should be set to a TransformDocument that will be
returned:
TransformDocumentImpl res = new TransformDocumentImpl();

res.setPropertyValue("title", extractedTitle);
61.2.5. Using a metadata extraction plugin

Having a plugin class defined that knows how to extract information from a specific type of file (MS Word
document, MS Excel, PDF, OO doc etc) we can add the contributions necessary for the metadata extraction to
Nuxeo EP 5.3 390

Metadata Extraction Service
take place.
We need to define first the transformation plugin and the transformation contributions. After that the defined
transformation can be referred in the metadata extraction specific contribution.
Step 1: define the transformation plugin:
<extension
target="org.nuxeo.ecm.platform.transform.service.TransformService"
point="plugins">
<documentation>
Set of default transformation plugins for metadata extraction.
</documentation>
<plugin name="MSWordMDExtPlugin"
class="org.nuxeo.ecm.platform.metadataext.plugins.MSWordMDExtractorPlugin"
destinationMimeType="application/msword">
</plugin>
</extension>
Step 2: define the transformation:
<extension
target="org.nuxeo.ecm.platform.transform.service.TransformService"
<documentation>
Set of default transformation chains for metadata extraction.
</documentation>
<transformer name="MSWordMDExt"
<plugins>
<plugin name="MSWordMDExtPlugin" />
</plugins>
</transformer>
</extension>
Step 3: define the metadata extraction specific contribution
<extension
target="org.nuxeo.ecm.platform.metadataext.services.MetaDataExtraction"
point="extractions">
<meta-data-extraction inputField="file:content"
transformationName="MSWordMDExt">
...
This last one is refering to the above defined transformation.
Nuxeo EP 5.3 391

Chapter 62. Unicity Service
The Unicity service sends a new Message on the JMS bus every time you upload a file already on the server.
62.1. How does it works ?

When creating or updating a file, a digest is computed using the whole file and an encoding algorithm. Next
step is an nxql query wich gets every Document with the same Digest. If such documents exist, there references
will be forwarded on JMS bus.
62.2. What you need:

The message's eventID is duplicatedFile. You need it to catch the event. The documentLocation list is available
in the info map of the CoreEvent using duplicatedDocLocation key.
62.3. Configuration
How to configure unicity extension point. TODO: needs to be made clearer.
<enabled>
Default value is false. Use true if you want to enable this service.
</enabled>
<algo>
Default encoding algorithm is sha-256. You can choose every algorithm supported by java.security.MessageDigest.
</algo>
<field>
A field is an xpath expression giving a particular field of your schema.
It's the reference of a file on the server.
The type's field must be nxs:content.
You can use as many field as you want.
</field>
62.4. Snippets
Some code to get you started.
Example 62.1. Sample unicity extension point contribution to the FileManager service.
<component name="org.nuxeo.ecm.platform.filemanager.service.FileManagerService.Plugins">
<extension
target="org.nuxeo.ecm.platform.filemanager.service.FileManagerService"
point="unicity">
<unicitySettings>
<enabled>true</enabled>
<algo>sha-256</algo>
<field>content</field>
</unicitySettings>
</extension>
</component>
Example 62.2. Sample code to retrieve DocumentLocations.
public void onMessage(Message message) {

try {
Serializable obj = ((ObjectMessage) message).getObject();
if (!(obj instanceof DocumentMessage)) {
Nuxeo EP 5.3 392

Unicity Service
return;
}
DocumentMessage doc = (DocumentMessage) obj;
String eventId = doc.getEventId();
if ("duplicatedFile".equals(eventId)){
Object[] documentLocations = (Object[]) doc.getEventInfo().get("duplicatedDocLocation");
for (Object documentLocation: documentLocations) {
log.debug(((DocumentLocation)documentLocation).getDocRef());
}
}
}
}
Nuxeo EP 5.3 393

Chapter 63. Nuxeo Mail Service
63.1. Presentation
Nuxeo mail service enables users to send and receive mail. It also makes it possible to apply a series of actions
on messages located in folders.
The service is a wrapper around JavaMail . Knowledge of this API is necessary for advance use of the service.
63.2. Basic Use
Use of the mail service is done via session. You need to configure a session factory that will be able to find the
correct server parameter to connect to. Then, the session can use the mail server. The simplest scenario is to
have mails sent and received using the credential of one user (see property fetcher for more complex use).
To pass the server parameter in your extension point, use a simple properties fetcher. For a server using TLS
connection with SMTP and IMAP, a configuration could look like:
<extension target="org.nuxeo.ecm.platform.MailService"
point="sessionFactory">
<sessionFactory name="mysession" fetcherName="simple">
<properties>
<property name="mail.store.protocol">imap</property>
<property name="mail.transport.protocol">smtp</property>
<property name="mail.smtp.port">587</property>
<property name="mail.host">mail.mycompany.com</property>
<property name="mail.smtp.host">mail.mycompany.com</property>
<property name="mail.imap.starttls.enable">true</property>
<property name="mail.imap.ssl.protocols">TLS</property>
<property name="mail.smtp.ssl.protocols">TLS</property>
<property name="mail.user">[email protected]</property>
<property name="mail.from">[email protected]</property>
<property name="mail.imap.port">143</property>
<property name="password">myuserpassword</property>
<property name="user">[email protected]</property>
</properties>
</sessionFactory>
</extension>
With such a configuration you can send mails using the mail service, passing the text of the mail as a String.
MailService mailService = Framework.getService(MailService.class);
mailService.sendMail("My interesting mail.", "The subject of the mail",
"mysession", new Address {internetAddress});
To process mails in mail folders, you need to create a pipe and add actions to it. Each action in the pipe will be
applied to each mail in the folder. A typical pipe will include action to set the delete flag so the mail is deleted
when the pipe exits, transforms the mail, stores it, and maybe answers it. For all those actions to communicate
with each other, you can pass objects into the context. Context is passed from action to action.
The package org.nuxeo.ecm.platform.mail.action contains a set of Action classes you can use or extend.
Note that some actions expect objects to be in the map.
A MessageAction is an action done on a message:

public interface MessageAction {
boolean execute(ExecutionContext context) throws Exception;
void reset(ExecutionContext context) throws Exception;
}
Message message = context.getMessage();

String infoFromPreviousAction = context.get("info.from.previous.action");
context.put("info.for.next.action", "don't save this message");
Nuxeo EP 5.3 394

Nuxeo Mail Service
If the returned value of an action is false, then the processing of this message is stopped and the next message
will be processed.
The MailBoxAction enables using those service in a simple way, a typical use would be:
MailBoxActions mba = mailService.getMailBoxActions("mySimpleFactory", "INBOX");
mba.addAction(new ConvertToDocumentModelAction());
mba.addAction(new StoreDocumentModelAction());
mba.addAction(new SendMailReplyAction());
mba.execute();
63.3. Advanced Use

The Mail Service provides access to JavaMail object for advanced use:
Store getConnectedStore(String name) throws MessagingException;
Store getConnectedStore(String name, Map<String, Object> context) throws MessagingException;
Transport getConnectedTransport(String name) throws MessagingException;
Transport getConnectedTransport(String name, Map<String, Object> context) throws MessagingException;
Session getSession(String name);
Session getSession(String name, Map<String, Object> context);
The mail service comes with a simple fetcher. The simple fetcher enables passing the configuration for the mail
server using key/value pair. If you need more complex configuration, such as having specific properties for
each user fetched from a directory, you can contribute a new fetcher using the propertiesFetcher extension
point.
<extension target="org.nuxeo.ecm.platform.MailService"
point="propertiesFetcher">
<propertiesFetcher name="simple"
class="org.nuxeo.ecm.platform.mail.fetcher.SimplePropertiesFetcher"/>
</extension>
To test your mail service, jes mail server is a simple, light weight mail server you can use locally. You can
either start it manually or use the nuxeo-platform-mail-test bundle to do it.
Nuxeo EP 5.3 395

Chapter 64. Imaging
64.1. Introduction
Nuxeo Platform Imaging provides picture management to Nuxeo Web Platform and RCP. It offers minor
picture transformation like rotation or resizing.
There are several Imaging addons for the Nuxeo platforms. They are listed in the following sections.
64.2. Imaging API

This addon provides a pluggable adapter for picture manipulation. It makes it possible to manipulate images
resources that are not documents (in the document type sense) themselves. Concretely, it makes it possible to
still use the Seam component that deals with images for some processings (for example rotation and resizing)
but adapted to a specific schema.
64.3. Imaging transform

This addon is where the available transformations are stored. Available transformations are rotation, resizing
and cropping for the following image types: JPEG, GIF, BMP, TIFF. PNG is sadly not supported yet.
64.4. Imaging web

This addon provides Picture and PictureBook document types as well as drag'n drop plugin, slideshows or
thumbnails.
64.5. Imaging core

This core addon provides services for common picture processing operation, metadata extraction and
mime-type detection. With this addon, one can choose the picture processing library to use through the library
selector service. Right now the available libraries are Mistral and ImageJ.
Nuxeo EP 5.3 396

Chapter 65. Nuxeo Preview Addon
The nuxeo-platform-preview addon provides services, transformers and adapters to generate HTML previews
from of a Nuxeo DocumentModel.
65.1. Overview
The preview addon is composed of several layers:
• UI part
Adds a Preview tab that displays the preview inside an IFRAME.
• Transformer part
The Preview addon contributes transformers that are dedicated to generating HTML out of most file
formats.
• Service and Adapters
The Preview addon includes services that allow you to define PreviewAdapters for each type of
Document. These adapters are responsible for defining how the preview will be generated:
• define the field(s) used for preview
Because a Nuxeo document contains a lot of different fields, the adapter must determine what are the
default fields used to generate the preview.
• define how preview is generated
Basically preview can be generated using some transformers or using some fields that already contains
pre-generated HTML preview
The services provided by the Preview addon let you configure the PreviewAdapter depending on your
document types and manage some cache for transformer based previews.
65.2. Installing the Preview Addon

Installing the Preview addon is fairly simple.
65.2.1. Deploy the Addon

Since Nuxeo 5.3, the nuxeo-platform-preview-5.X.jar is already deployed in the nuxeo.ear/system/
directory.
65.2.2. Configure Transformers

The preview service relies on HTML transformers that uses external tools to achieve the transformation. You
need to have them installed and configured before the preview addon will work.
The preview service comes with two HTML transformers:

• PDF2Html
This transformer generates HTML from PDF files.
Nuxeo EP 5.3 397

Nuxeo Preview Addon
This transformer relies on the command line tool pdftohtml This tool can be found as package for most
linux distrib (for instance, included in poppler-utils in Ubuntu). This tool can also be installed on MS
Windows platform, see http://sourceforge.net/projects/pdftohtml/
Once you have installed pdftohtml on your server, you must configure Nuxeo to let him know where is
the command line tool. For this, you can use a extension point to define what is the temporary directory
to use and where is pdftohtml command.
Default settings should be ok for most Linux, but you will have to do the configuration if you use a MS
Windows box.
To do this configuration, create a file named pdftohtml-config.xml in the nuxeo.ear/config directory

<component name="myproject.pdftohtml.config.contrib">
<extension target="org.nuxeo.ecm.platform.preview.transformers.CLTransformerPluginParameterManagerComponent"
point="cltpParameters">
<CLTranformerPluginParameters name="Pdf2HtmlParams" targetTransformerPlugin="Pdf2Html">
<parameters>


<parameter name="commandString">C:\\Program files\\pdftohtml\\pdftohtml.exe</parameter>
<parameter name="tmpDir">C:\\Temp\\</parameter>
</parameters>
</CLTranformerPluginParameters>
</extension>
</component>
• Any2Html
This Transformer is in fact a chain using Any2pdf and PDF2html. This means you need to have PDF2html
working but also OpenOffice.org in listen mode (this is documented earlier in this book).
65.3. Extensions and Pluggability

The Preview addon provides several extension solutions.
65.3.1. Pluggable Adapters

Preview AddOn uses the standard DocumentModelAdpater system. For that it defines a HtmlPreviewAdapter
interface that must be implemented by each adapters. In order to let you choose the Adapter implementation
according to the Document type, the DocumentAdapterFactory used for the HtmlPreviewAdapter is pluggable.
This factory uses the PreviewAdapterManager service to determine what implementation of the
HtmlPreviewAdapter should be returned when you use
doc.getAdapter(HtmlPreviewAdapter.class)
Defining custom preview adapter is done via a dedicated extension point: you register a Factory for a given
DocumentType. This factory will be used to create the implementation of the HtmlPreviewAdapter from the
DocumentModel. Here is example of such a contribution:
<component name="org.nuxeo.ecm.platform.preview.adapter.contrib">
<extension target="org.nuxeo.ecm.platform.preview.adapter.PreviewAdapterManagerComponent"
point="AdapterFactory">
<previewAdapter name="notePreviewAdapter" enabled="true">
<typeName>Note</typeName>
Nuxeo EP 5.3 398

Nuxeo Preview Addon
<class>org.nuxeo.ecm.platform.preview.adapter.factories.NotePreviewAdapter</class>
</previewAdapter>
</extension>
</component>
This contribution defines the Adapter factory for the Note Document type. Contributed factories must
implement the PreviewAdapterFactory interface (that contains only one method!).
The implementation returned by the factory can be based on one of the 2 base classes provided inside the
addon.
• TransformerBasedHtmlPreviewAdapter
This base class provides all the build in features to create a preview adapter that uses the Transformation
Services to generate the html preview.
Default usage in Nuxeo is the generic adapter for the all the documents that contains the file schema.
• PreprocessedHtmlPreviewAdapter
This base class provides all the build in features to create a preview adapter that uses pre-processed
HTML preview that is stored inside the document.
Default usage in Nuxeo is the adapter for the Note Document type.
For most usages, you just be able to contribute a factory that create a new
PreprocessedHtmlPreviewAdapter with the good arguments.
65.3.2. Pluggable HTML Transformers

The Preview addon contributes some command line based transformers.
It also provides you with a base class AbstractCommandLineBasedTransformer that can be used to easily make
another CommandLine based Transformer.
We also provide a CLTransformerPluginParameterManager service that is used by the base class to extact the
configurable parameters.
65.4. Previews and URLs

The preview addon includes a restlet.
This restlet provides a RESTful access to the preview service. This means that you can retrieve the preview of a
document by just using a simple GET URL.
Preview URLs have this form :

http://{server}:{port}/nuxeo/restAPI/preview/{document_uuid}/{previewfield}/
where:
• document_uuid
is the the document uuid that is already present in all Nuxeo urls
• previewfield
is the xpath of the field that should be used as main file for the preview
Nuxeo EP 5.3 399

Nuxeo Preview Addon
Depending on the underlying adapter implementation, this field may or may not be relevant. Use 'default'
to let the adapter implementation choose the right field for you.
Please note that the last / is important. As HTML preview can contain nested images, the base URL must end
with a /. The Restlet system handles a cache to avoid refetching the preview data at each call.
Nuxeo EP 5.3 400

Chapter 66. Nuxeo Tiling service Addon
The nuxeo-platform-imaging-tiling addon provides a service and adapters to generate picture tiles from a
DocumentModel containing a picture or from a blob.
Tiling picture is useful when you want to display in a web browser a very big image : according to the display
settings and to the zoom level, the picture tiling service will generate you the needed picture tiles.
66.1. Overview
The Tiling Service addOn is composed of several layers :
• REST API part
Provides a rest API to get the picture tiles from the server.
Depending of the URL, this API could be used to get the actual tiles (ie: picture), or to get information
about the picture and the tile grid (XML or JSON).
• Adapter part
An DocumentModelAdapter is provided to adapt the DocumentModel interface to an interface dedicated

to picture tiling.
Default adapter simply extract the blob from the DocumentModel using either the default file schema, or
using a provided xPath.
Other adapters can be provided to implement specific logic for source picture retrieval (like
multi-view-pictures) or even extract pre-computed tiles from the DB.
• Tiling Service
This service is responsible for :
• managing tiles cache
Because picture tiling can be long, this service maintains a FileSystem based cache of the input
pictures, the generated tiles, and also some temporary resources used by the tiling process.
The service also manage a configurable garbage collector to clean up this cache.
• manage PictureTilers
A PictureTiler is a Java Class that can extract a tile from a picture.
Current implementation provides ImageMagick based and Gimp based PictureTiler.
Default configuration requires ImageMagick :
• because it is faster
• because some treatments can not be done via gimp
• because setup is easier
66.2. How tiles are defined and computed

In order to define a tiling you will need to define 4 input parameters:
Nuxeo EP 5.3 401

Nuxeo Tiling service Addon
• The input picture.
This input is represented by the ImageResource className in the API.
This ImageResource is usually provided via a DocumentModel adapter that will encapsulate the logic to
find the input picture and will create a DocumentImageResource.
You may also directly create a BlobResource from a simple Blob.
• The tiles width in pixel
• The tiles height in pixel
• The maximum number of tiles X/Y
This parameter represents the maximum number of tiles on the X or Y axis, that are needed to display the
complete picture.
Basically it represent the grid size you will need to display the complete image using this tiling.
As you may have noticed the zoom factor is not an input parameter. In fact it is an output parameter : the
service will compute the zoom factor that correspond to the tiling definition.
This choice may seem strange, but in most of the case, this is easier to use : you don't always know the size of
the underlying image, but you know the space you have to display the tiled image (total width/height and
number of tiles) and you know that you want to start with an image that is fully displayed.
Here is a quick explanation on how the tiling service work.
• compute needed picture size.
From the tiling grid definition, the service will compute the needed input picture size.
• find a scaled down picture if available
When the needed picture size is really smaller that the real input image, it may be interesting to generate
a scaled down image.
This will slow down the process for the computation of the first tile, but will speed up the computation of
all other tiles.
This is particularly true for format like JPEG that support to easily extract from them a smaller image.
This speed up the reading part (less bytes to read from DB/Hard Drive) and speed up the final scaling.
When scaling down the input picture is possible, the resulting image will be stored into the cache.
• select the tiler
• let the tiler do it's job
Depending on the tiler implementation, it may generate one tile at a tile (default for ImageMagick based
tiler) or 9 tiles at a time (default for gimp tiler) or all tiles (possible for gimp tiler).
This behavior is transparent for the caller since, all generated tiles are cached.
66.3. Installing the picture tiling Addon
66.3.1. Requirements
Nuxeo EP 5.3 402

ImageMagick 6.3.7 or later is needed : the Tiling Service uses the ImageMagick stream command that is not
available in 6.2 (associated packages are libmagick and imagemagick).
Current implementation has only be tested under Linux.
If you want to use the Gimp tiler, you will need Gimp 2.x with python extensions.
66.3.2. Deploy the addon

Since Nuxeo 5.3, the nuxeo-platform-imaging-tiling-XXX.jar is already deployed in the
nuxeo.ear/system/ directory.
Configuration can be done using a extension point. Just create a file called pictures-tiles-config.xml in
nuxeo.ear/config.
Use this extension point contrib to :

• define the imagemagick command path (if default is not ok)
• define the directory that will be used for cache
• define the cachesize
• define the GC parameters

NB : default config should be ok for any linux based system where imagemagick is setup via the package
manager
Here is an example of a configuration file :

<component name="my.projects.tiles.config">
<require>org.nuxeo.ecm.platform.pictures.tiles.default.config</require>
<extension target="org.nuxeo.ecm.platform.pictures.tiles.service.PictureTilingComponent"
point="environment">
<environment>
<parameters>

<parameter name="GimpExecutable">gimp</parameter>

<parameter name="IMConvert">convert</parameter>
<parameter name="IMIdentify">identify</parameter>
<parameter name="IMStream">stream</parameter>

<parameter name="WorkingDirPath">/tmp/</parameter>

<parameter name="MaxDiskSpaceUsageForCache">50000</parameter>

<parameter name="GCInterval">10</parameter>
</parameters>
</environment>
</extension>
</component>
66.4. Testing the tiling service

The tiling service can be very easily tested.
66.4.1. URL and restAPI

The Rest API for the tiling service use the following url pattern :
Nuxeo EP 5.3 403

http://{server}/nuxeo/restAPI/getTiles/{repoId}/{docUUID}/{tWidth}/{tHeight}/{maxTiles}?format={format}&x={x}&y=
where
• {server}
is the server DNS name of IP
• {repoId}
is the id of the core repository that is used (use default if you don't know what it is).
• {docUUI}
The uuid of the document that contains the image. If you use the default adapter, this document must use
the fileschema and contain an image.
• {tWidth}
the width in pixel of the tiles.
• {tHeight}
the height in pixel of the tiles.
• {maxTiles}
maximum number of tiles X/Y for the full image
• {format}
the format of the tile information (JSON/XML)
this is used only if x and y are not supplied
• {x}
x of the tile to be generated (starting from 0)
• {y}
y of the tile to be generated (starting from 0)
Here are some examples :

http://server/nuxeo/restAPI/getTiles/default/950b0d27-2ca4-43e4-bb12-598ad6d64e86/200/150/2
Will send you the tiling information in XML for the picture contained in the doc
950b0d27-2ca4-43e4-bb12-598ad6d64e86 with a tile size of 200x150x2.
http://server/nuxeo/restAPI/getTiles/default/950b0d27-2ca4-43e4-bb12-598ad6d64e86/200/150/2?format=JSON
Will send you the tiling information in JSON for the picture contained in the doc
950b0d27-2ca4-43e4-bb12-598ad6d64e86 with a tile size of 200x150x2.
http://server/nuxeo/restAPI/getTiles/default/950b0d27-2ca4-43e4-bb12-598ad6d64e86/200/150/2?x=1&y=1
Will send you the tile (1,1) for the picture contained in the doc 950b0d27-2ca4-43e4-bb12-598ad6d64e86 with
a tile size of 200x150x2.
Nuxeo EP 5.3 404

66.4.2. simple test client

The RestAPI provide a very basic test client. This test client was used during the development : this client is not
pretty, not IE compliant, not dummy user proof.
You can access this test client via the rest API, just add the test=true to the URL.
http://server/nuxeo/restAPI/getTiles/default/950b0d27-2ca4-43e4-bb12-598ad6d64e86/200/150/2?test=true
Nuxeo EP 5.3 405

Chapter 67. Nuxeo DocumentLink Addon
The nuxeo-platform-documentLink addon provides services, and adapters to handle "application level"
proxies pointing to DocumentModels.
67.1. Overview
There are several use cases that require having the same document available from several places. Typical use
cases include publication (same document visible in multiple sections), personal workspaces (user want to have
some document into his workspace without copying them) ... Nuxeo Core provides a build-in feature called
Proxies that can be used in most cases. The current limitations of proxy system in Nuxeo Core 1.4.x include :
• A proxy can only point to a checked-in DocumentModel (ie : a version)
• A proxy is always totally equivalent to the target DocumentModel (ie : same schemas and field values)
DocumentLink provides a proxy system implementation on top of the Core using the DocumentModel adapter
system. DocumentLink extends the Core proxy system to provide some additional features :
• A DocumentLink can point to a checked-in or checked-out DocumentModel
• A DocumentLink can have it's own schemas and fields.
• A DocumentLink can mask some of the schemas/fields of the target DocumentModel

As an example, if you have a DocumentModel DocA with title "Document A" and description "description A",
you can create a DocumentLink DLA that will point to DocA and have title "DocLink A" but will always return
the description contained in DocA.
67.2. How does it work

The DocumentLink system uses DocumentModelAdapter to adapt the default DocumentModel implementation
to a specific implementation that handles the logic for dispatching attributes access across the DocumentLink
and the target Document.
The DocumentLink adapter (DocumentLinkAdapter)implements the DocumentModel interface and will by

default have the felowing behavior :
• get internal DocumentModel value if the target schema/field is available.
• return the value stored inside the target DocumentModel otherwise.
The reference of the target DocumentModel is stored in a dedicated schemas (named documentLink).
This specific schema contains :

• target DocumentRef
• target DocumentRepository
• list of schema that will never be masked by the DocumentLink
This means that for this schema the DocumentLink will always return the values stored in the target
DocumentModel even if the DocumentLink it self has these schemas.
• list of fields xPaths that will never be masked by the DocumentLink
The DocumentLink package also provides a indexing wrapper that will be used during indexing. This allows
the DocumentLink to be indexed as expected.
Nuxeo EP 5.3 406

Nuxeo DocumentLink Addon
67.3. DocumentLink and Repository

In implementation projects using DocumentLink, we usually don't really care to know where the real (target)
DocumentModel will be stored, because the user will probably always manipulate the DocumentModel through
DocumentLinks.
In a way, it means that the real DocumentModels are "somewhere is space" and the user navigate via a
hierarchy of DocumentLinks.
For that purpose, the documentLink package provide a DocRepository service that will manage the storage of
the real DocumentModel.
"Real DocumentModel" won't be stored "in space" but in a hidden folder structure that will dispatch the
DocumentModels in a hidden tree.
The repository storage is pluggable so you can define :

• the sub directory tree structure
• how rights are set
67.4. Using DocumentLink

In order to use DocumentLink feature you need to install the nuxeo-platform-documenntlink packages into
your nuxeo. For that, just copy the jars into nuxeo.ear/plugins and restart your server.
On a stock Nuxeo EP, documentLink won't give you much visible features : it provides some new API, but
since the default Web Application does not use it, it won't be really useful. The DocumentLink Addon must be
considered as a new API.
One of the DocumentLink package is dedicated to unit tests (nuxeo-platform-documentlink-tests), it can be

used as a good sample of code for using all DocumentLink APIs.
Nevertheless, here are some simple examples :
67.4.1. Using the adapter

The DocumentLinkAdapter is available on any DocumentModel that has the DocumentLink Schema. Using the
adapter you can define the target DocumentModel and the masked schemas, but you can also have a full access
to the DocumentModel API .
String startPath="/default-domain/ws1";
// create a simple DocumentModel
DocumentModel doc = coreSession.createDocumentModel(startPath, "file", "File");
doc.setProperty("dublincore", "title", "MyDoc");
doc.setProperty("dublincore", "coverage", "MyDocCoverage");
doc = coreSession.createDocument(doc);
// create a DocumentModel with the DocumentLink type
DocumentModel link = coreSession.createDocumentModel(startPath, "link","DocumentLink");
link.setProperty("dublincore", "title", "MyLinkToDoc");
link = coreSession.createDocument(link);
// get the DocumentLinkAdapter

DocumentLinkAdapter adaptedLink = link.getAdapter(DocumentLinkAdapter.class);
// set the target DocumentModel
adaptedLink.setTargetDocument(doc);
// check property access
// check property accessor pass-throught
String cover1 = (String) link.getProperty("dublincore", "coverage");
String cover2 = (String) adaptedLink.getProperty("dublincore","coverage");
assertNotNull(cover2);
assertEquals("MyDocCoverage", cover2);
Nuxeo EP 5.3 407

Nuxeo DocumentLink Addon
// check automatic override (title)

String title0 = (String) doc.getProperty("dublincore", "title");
String title1 = (String) link.getProperty("dublincore", "title");
String title2 = (String) adaptedLink.getProperty("dublincore", "title");
// adapter and documentModel direct Access return the same value
assertEquals(title1, title2);
// DocumentLink do not return the title of the target since it's overridden
assertFalse(title1.equals(title0));
67.4.2. Using the DocRepository

DocumentLink provides static helpers to help you create DocumentLinks and use the DocRepository.
DocumentModel dm = coreSession.createDocumentModel("File");
dm.setProperty("dublincore", "title", "testme");
// create a new DocumentLink of type DocumentLink
// create it in / path
// make it point to the dm DocumentModel that will be stored somewhere in the DocRepository
DocumentLinkAdapter adaptedLink = DocumentLinkHelper
.createDocumentInCentralRepository(coreSession, dm, "/",
"DocumentLink");
coreSession.save();
// get the create target DocumentModel
DocumentModel targetDoc = adaptedLink.getTargetDocument();
// get the Repository
DocRepository repo = DocRepositoryHelper.getDocumentRepository(coreSession);
// get all the DocumentLinks
DocumentModelList proxies = repo.getProxiesForDocument(targetDoc.getRef());
assertTrue(proxies.size()==1);
// create a second DocumentLink pointing to the same target
DocumentLinkAdapter secondLink=DocumentLinkHelper.createDocumentLink(targetDoc, "/");
coreSession.save();
// get all the DocumentLinks
proxies = repo.getProxiesForDocument(targetDoc.getRef());
assertTrue(proxies.size()==2);
Nuxeo EP 5.3 408

Chapter 68. Nuxeo Search Center
This chapter presents the architecture of the nuxeo-searchcenter GWT client to the Search Service (new in
Nuxeo 5.2).
68.1. Overview
The Nuxeo Search Center is a standalone GWT application that can be deployed on a Webengine site in order
to provide an AJAX interface to perform queries on the document repository.
TODO: add a screenshot here
68.2. Installing and testing the search center
68.2.1. Building from source

First of all, Nuxeo Search Center depends on nuxeo-gwt modules, so the first thing to do is to build and install
the nuxeo-gwt projects.
hg clone https://hg.nuxeo.org/nuxeo/nuxeo-gwt
cd nuxeo-gwt
mvn clean install
Then you need the Nuxeo Search Center projects.
hg clone https://hg.nuxeo.org/nuxeo-searchcenter
cd nuxeo-searchcenter
mvn clean install
68.2.2. Deploying on a Nuxeo server

To get the Nuxeo Search Center working on Nuxeo, only those 3 jars are needed:
• nuxeo-gwt-server-5.2-xxx.jar
• nuxeo-searchcenter-gwt-app-5.2-xxx.jar
• nuxeo-searchcenter-service-5.2-xxx.jar
To deploy it, drop these 3 jars:
• in nuxeo.ear/plugins on JBoss.
• in bundles on Webengine standalone (Jetty).
Restart your server, and you can access Nuxeo Search Center at the following urls:
• http://localhost:8080/nuxeo/site/searchcenter on JBoss.
• http://localhost:8080/searchcenter on Webengine standalone (Jetty).
The Nuxeo Search Center application is also listed with the others Webengine applications at
Nuxeo EP 5.3 409

Nuxeo Search Center
http://localhost:8080/nuxeo/site or http://localhost:8080/.
68.2.3. Using the Search Center

TODO: go to http://localhost:8080/site/ and ... .
68.2.3.1. Save/Load FilterSet
The current search can be saved from the graphical interface. It will send the current FilterSet, which contains
all the FilterWidgets descriptions and their values, to the SearchCenterService. The FilterSet is saved as a
DocumentModel on the user personnal Workspace (cf. nuxeo-platform-userworkspace add-on).
A ComboBox lists all the available FilterSets : the contributed ones and the saved ones which the current user
can access. When a FilterSet is selected and the load button pressed, the list of FilterWidgets is rebuild, their
default values are setted and the query is regenerated and executed.
68.2.3.2. TODO
TODO: Explain how to customize the list of available filter widgets (from the user interface).
68.3. How does it work

The Nuxeo Search Center application is composed of 3 different parts.
68.3.1. The GWT client

The UI part is built upon Google Web Toolkit, and particularly with SmartGWT
The client part lies in the nuxeo-searchcenter-gwt-app project.
68.3.2. The JAX-RS server

The JAX-RS part of Nuxeo Search Center lies in the class SearchCenterModule located in
nuxeo-searchcenter-gwt-app/src/main/java/org/nuxeo/ecm/searchcenter/module.
Here are the main methods, defined in SearchCenterModule, used by Nuxeo Search Center:
• getVocabulary, used to get the values list of a given simple vocabulary. It returns the list in a JSON
format understandable by the SmartGWT widgets.
• getHierarchicalVocabulary, used to get the values list of a given hierarchical vocabulary. It returns the
list in a JSON format understandable by the SmartGWT widgets.
• execQuery, used to create the Query from the list of filtering values, and execute it by calling the
SearchCenterService. It returns a document list in a JSON format understandable by the SmartGWT
widgets.
• getFilterSet, used to get a FilterSet by its name or id. It returns a FilterSet description in a JSON
format used to build the different widgets.
• getFilterSets, used to get all the available FilterSets. It returns a list of FilterSet descriptions in a
JSON format used to fill the FilterSet load ComboBox.
• saveFilterSet, used to save the current search. It takes in parameter the JSON representation of the
current FilterSet.
68.3.3. The SearchCenterService
Nuxeo EP 5.3 410

Nuxeo Search Center
The SearchCenterService is defined in the project nuxeo-searchcenter-service. Its purpose is to manage the
FilterSets and FilterWidgets and generate and execute the QueryModel from the values entered by the user.
A helper class (SearchCenterHelper) is used to call the service methods and serialize the results in JSON
format. This helper is called by some of the JAX-RS methods like execQuery and getFilterSet.
68.4. How to customize the list of available filters
68.4.1. FilterWidgets
To register a FilterWidget, you need to write a contribution with an extension to the SearchCenterService like :
<extension target="org.nuxeo.ecm.searchcenter.service.SearchCenterService" point="filterWidget">
<filterWidget
name="dc_subjects"
index="dc:subjects"
title="Subjects"
type="hierarchicalVocabulary"
vocabulary="topic" />
</extension>
• The name attribute specifies a unique name for the FilterWidget. This name is used in FilterSet
registrations.
• The index attribute specifies the field in the associated where clause of the query.
• The title attribute specifies the displayed title in the UI.
• The type attribute specifies the type of the widget. The available widget types are :
• string
• date
• vocabulary
• hierarchicalVocabulary
• The maxValues attribute is optional and specifies the number of maximum values the user can enter.
• The operator attribute is optional and specifies the operator used in the corresponding where clause of
the generated QueryModel. Default operator depends of the widget type :
• string : if maxValues == 1, default operator is = else it is IN
• date : default operator is BETWEEN
• vocabulary and hierarchicalVocabulary : default operator is IN
• The vocabulary attribute is only used by widgets of type vocabulary and hierarchicalVocabulary. It
specifies the vocabulary which the values of the widgets are fetched from.
68.4.2. FilterSets
To register a FilterSet, you need to write a contribution with an extension to the SearchCenterService like :
<extension target="org.nuxeo.ecm.searchcenter.service.SearchCenterService" point="filterSet">
<filterSet name="myFilterSet" title="My FilterSet" enabled="true">
<filterSetItem widgetName="dc_creator" />
<filterSetItem widgetName="dc_modified" />
</filterSet>
<fixedPart>ecm:primaryType != 'FilterSet' AND ecm:isCheckedInVersion = 0</fixedPart>
</extension>
Nuxeo EP 5.3 411

Nuxeo Search Center
• The name attribute specifies a unique name for the FilterSet.
• The title attribute specifies a display title for the FilterSet.
• The enabled attribute is optional and allows to disable the FilterSet if set to false. Default value is true.
• The filterSetItem tags designate the list of FilterWidgets the FilterSet contains.
• The widgetName attribute refers to a FilterWidget name.
• The hidden optional attribute allows to hide the specified widget. Default value is false.
• The fixedPart tag can be used to add a fixed part to the generated where clause of the query.
68.5. How to build new GWT filter widgets
68.5.1. Setting up a GWT eclipse development environment

Inside the nuxeo-searchcenter directory, first run
mvn eclipse:eclipse
to setup the required files needed by eclipse to import the projects, then import the 2 projects in your
workspace.
The simplest way to run and debug Nuxeo Search Center while developing is to use the GWT hosted mode.
• Deploy Nuxeo Search Center on either JBoss or Jetty, and start the server.
• inside the nuxeo-searchcenter-gwt-app, execute:

mvn gwt:eclipse
This will create an Eclipse launcher, org.nuxeo.ecm.searchcenter.gwt.SearchCenter.launch.
• add -noserver to the arguments list of the new configuration.
Finally, run the configuration. After the connection was refused to http://localhost:8888, just put the url of
the deployed Nuxeo Search Center: http://localhost:8080/nuxeo/site/searchcenter for JBoss, or
http://localhost:8080/searchcenter for Jetty.
In order to write your own JAX-RS components in Groovy you might want to also install the Groovy eclipse
plugin from the following update site: http://dist.codehaus.org/groovy/distributions/update/ although
you can also write them in plain old Java too.
68.5.2. Existing filter widgets

There are 4 filter widgets bundled with Nuxeo Search Center:
• StringFilterWidget: filter documents through arbitrary text entered by the user.
• DateFilterWidget: filter documents via a Date interval
• VocabularyFilterWidget: filter documents by selecting one or more value(s) among the configured
simple vocabulary values.
Nuxeo EP 5.3 412

Nuxeo Search Center
• HierarchicalVocabularyFilterWidget: filter documents by selecting one or more value(s) among the

configured hierarchical vocabulary values.
Each widget instance is bound to a field in the Nuxeo documents. For instance, a String Filter Widget can be
bound to the ecm:fulltext field, and a Date Filter Widget to the dc:created field.
These 4 widgets all extend VLayoutFilterWidget abstract class. This class is a convenient base class for the
filter widgets you will develop. The VLayoutFilterWidget class provides:
• a defaut layout for the widget composed of a title, a display list of the selected values and a form used to
add new values.
TODO: screenshot of a simple filter widget.
• useful methods to add or remove filtering values with their associated rows in the display list.
• a method refreshFilterSet which updates the current FilterSet and asks the application to refresh the
documents list.
Your new filter widget class can extend VLayoutFilterWidget but it is not required. The only requirement is
that your class extends FilterWidget so that it can be used by the different FilterView of the application.
The widgets are all built upon JSON Objects which contain at least the following attributes: type, name, title,
hidden, all setted from the registered values in the FilterWidget and FilterSet definition.
Each widget extending VLayoutFilterWidgetcan be configured to accept a maximum number of values

through the maxValues parameter.
68.5.3. TODO: layout and extension points

TODO
Nuxeo EP 5.3 413

Part VIII. Annexes
Nuxeo EP 5.3 414

Appendix A. Frequently Asked Questions
A.1. Deployment and Operations
Nuxeo supports and certifies the following hardware and software:
Hardware:
• Intel/AMD 32-bit & 64-bit
• SPARC 32-bit & 64-bit
Operating Systems:
• RedHat 3.x, 4.x, 5.x
• Debian 4.0, Ubuntu Server 6.06 LTS and 7.04
• Solaris 10
• Windows Server 2003
• MacOS X 10.4.x
RDBMS:
• PostgreSQL 8.x
• MySQL 5.x
• Oracle Database 9i, Oracle Database 10g
Java Runtime Environment (JRE):

• Java 5 aka 1.5.0 (update 11 recommended)
• Java 6 aka 1.6.0 (update 11 recommended)
Java EE application servers:

• JBoss AS 4.0.4 GA and 4.0.5 GA
• JBoss AS 4.2.0 GA (in progress)
• Glassfish v2 (in progress)
• BEA WebLogic 10 (in progress)
The most used configuration is JBoss AS 4.0.4 GA using JRE 1.5.0_11 on RedHat AS 4.x running on Intel x86
hardware.
Intel-based hardware (bi-Dual Core, Quad Core or bi-Quad Core), 4GB of RAM. The required disk space only
depends on the data volume to store (raw requirements to be secure: size of files to manage * 2).
Each release (major and minor) is delivered with an upgrade procedure, new features list, improvements list,
fixed bugs list and known bugs/limitations list. Moreover the issue tracker is public (it allows everybody to see
the status of the software, known/ongoing bugs and issues, features/improvement roadmap, etc.).
Nuxeo EP 5.3 415

FAQs
An installation guide is available. Upgrade procedures are delivered along each release.
An administration guide is available and updated with each release.
A User Guide is delivered with each release.
A developer guide is delivered and constantly improved.
The reference manual assembles all the documentation available for users, developers, operation teams, etc.
Nuxeo provides several other documents/resources such as the API (Javadoc), some tutorials, specific
Archetypes for Maven 2 (useful to quickly bootstrap new plugins / projects), etc.
The documentation is available in the English language. Translation to French, Spanish, German and Italian are
supported/provided by the community (if you require a specific language, you can order it from Nuxeo).
The documentation of included software are either included in the reference documentation if it's useful for
common operations, either linked if not. All the documentation of Nuxeo EP and bundled software packages is
freely available.
Yearly major release and quarterly minor release. The high-level roadmap is published by Nuxeo and updated
frequently. Detailed roadmap is available from the issue tracker (all details are available on each issue such as
comments, status, votes, related commit in the SCM, etc.).
See installation procedure. XXX Add link.
The "Administration and Operation Guide" describes available monitoring points. In short, Nuxeo EP offers a
set of JMX services to monitor all critical points of the application (standard Java EE applications monitoring
system). Moreover, logs can be broadcasted using log4j capabilities (SNMP, email, etc.). Both should be usable
by all major monitoring software.
Nuxeo EP is fully based on Java EE 5 and supports related clustering and HA features. JBoss Clustering is the
recommended clustering and HA solution for Nuxeo EP's services. Nuxeo EP services can be configured for
performance clustering and/or HA clustering (depending on the capabilities and requirements of each service).
This is possible through configuration of the application server (ex: JBoss AS / Tomcat). Nuxeo EP relies on
the application server for all the network configuration.
Nuxeo EP entirely depends on the Java EE application server for all network related configuration. It is not
bind in any way to the physical network configuration of the server. Hence it is possible to change the
hostname of the server and restart the machine without causing any problem to Nuxeo EP.
Fail-over relies on JBoss Clustering for Nuxeo EP services. Here is the HA system used for each category of
services:
• Nuxeo Core (Content Repository): HA clustering only. It relies on the native RDMBS replication system
(Oracle RAC or PostgreSQL replication solutions). Data integrity has to be trustable and enforced.
• Nuxeo Search (Search Engine): HA and performance clustering. It can use a shared filesystem (if indexes
are stored on the filesystem) or can rely on the RDMBS replication solution. If data integrity is corrupt, a
reindexing of the content is be sufficient to restore it.
• EJB3-based Services: HA and performance clustering. Use native EJB3 clustering and load-balancing
from JBoss Clustering. Services using data persistence rely on RDMBS replication (for HA) that needs
to be trustable and enforced.
• Web Client/App: can use HA and performance clustering (using JBoss Clustering). Does not need data
sync.
To achieve the highest level of data integrity, Nuxeo recommends storing binary files as BLOBs directly in the
database (hence use a RDBMS offering optimized BLOBs storage (such as Oracle or PostgreSQL). Using this
mechanism, Nuxeo EP can store all its data into the RDBMS (including request/search engine indexes) and
Nuxeo EP 5.3 416

FAQs
relies on it to enforce data integrity. Moreover, Nuxeo EP is fully transactional and relies on JTA (+ XA) for
transaction management (that enforce data integrity across data sources).
Nuxeo EP has been designed to completely rely on RDBMS data integrity (that can be considered trustable
nowadays). One can use RDBMS tools to check data integrity/consistency and data failure if any. If the data
model is corrupted, Nuxeo EP warns about it when the repository starts. Indexes (from Nuxeo Search) can be
verified and easily be rebuilt by reindexing the content if any problem occurs.
The maximal impact is service downtime and data restoration from backups. Data integrity errors are reported
in the logs and can then be sent via email notifications, SNMP and any log4j capabilities.
Nuxeo EP offers an applicative data import/export service (using XML serialization of documents) that can be
used as an incremental backup/restore system. For an efficient backup system, Nuxeo recommends using native
RDBMS tools (that can offer incremental backups, snapshots, hot restore, etc.).
The restoration speed is the native database write performances. We do not have more statistics yet (but should
be available by July 2007, benchmark are in progress on this point).
When all datasources for storage are using the same database (the recommended setup), the RDBMS can
achieve a consistent backup (usually at low cost for the user service). Restore can only be launched when the
system is stopped.
Content object restore can be done using the import/export service. Here is the procedure to achieve this:
1. Get IDs of content object to restore using, for example, the audit service/log (ex: get all DocIds from
"CreateObject" log entries for a particular user).
2. Get those document from a backup (done via the export service) and copy them in a directory (the
standard export format use one directory per content object which is easing a lot this operation).
3. Use a command line import/export client to (re-)import document in this directory.
4. You're done.
RDBMS backup can be handled as usual using legacy backup scripts for this RDBMS. Applicative backups can
be launched using the import/export client CLI. There is not supported scripts at the moment (but they could
easily be written).
Nuxeo EP 5.3 417

Appendix B. Detailed Development
Software Installation Instructions
This chapter is provided to help you install the software needed to work on your Nuxeo projects.
[TODO: refactor this chapter as in many cases, the packages may be installed using some package management
system (for instance on Mac OS: port install apache-ant maven2).]
B.1. Installing Java

Nuxeo EP uses the latest generation of Java technologies and thus requires a Java 5 or 6 VM such as the
reference implementation by Sun (the OpenJDK VM is not yet supported).
You may already have the right Java development kit install can enter in the command line:
javac -version
. This should return something like:

javac "1.5.0_10"
If the java version is 1.5.x or 1.6.x, you can skip the "Installing java" section.
Note
Java 5 is also sometimes called Java 1.5 or 1.5.0.
B.1.1. Using the Sun Java Development Kit (Windows and linux)
Sun Microsystems provides freely downloadable version of the Java Development Kit (JDK), that is needed to
compile the Nuxeo platform.
For the purpose of Nuxeo development, you should download the latest release of the JDK 5 or 6 from
http://java.sun.com/javase/downloads/index.jsp
B.1.2. Using a package management systems (Linux)

Some Linux distributions now include Java 5 in their official repositories.
For instance with Ubuntu (Edgy and later):

• enable "multiverse" (2 lines to uncomment) in your /etc/apt/sources.list
• update your package indexes:

$ sudo apt-get update
• install the full Java 6 stack (probably not all is necessary):

$ sudo apt-get install "sun-java6-*"
• ensure Java 6 is now the default JVM on your system (instead of gcj and friends by default):
$ sudo update-alternatives --set java /usr/lib/jvm/java-6-sun/jre/bin/java
Nuxeo EP 5.3 418

Detailed Development Software Installation Instructions
(TODO: add similar instructions for Fedora Core and Debian)
B.1.3. Manual installation (Linux)

You can also manually install Java by following the instructions of this page:
http://www.java.com/en/download/linux_manual.jsp
B.1.4. Setting up JAVA_HOME (Windows, Linux, Mac OS)

This will be required by tools such as Maven (see later).
B.1.4.1. Windows
Follow these instructions:

• type 'windows' +'pause'
• click on advanced tab
• click on "environment variables" (at the bottom)
• click on new and enter "JAVA_HOME" for variable name and "C:\Program Files\Java\jdk1.5.0_10"
(adapt to your own JDK install)
• don't forget to click on ok to close the environment variables window.
B.1.4.2. Linux
In your .bashrc (or .zshrc, ...) add something like:

export JAVA_HOME=/usr/lib/jvm/java-1.5.0-sun
B.1.4.3. Mac OS
Under Mac OS X, if you have properly installed a JDK (XXX: check how), you will need to put in your your
.bashrc (or .zshrc, ...) add something like:
export JAVA_HOME=/Library/Java/Home
B.2. Installing Ant

Ant will be used for building process. If you didn't set it up already on your computer, you can download it
here.
Then need to have Ant setup and on your PATH environment variable.
For linux:
Add something like the following in your .bashrc:
export PATH=/opt/apache-ant-1.7.1/bin:$PATH
For Windows:
Nuxeo EP 5.3 419

• type 'windows' +'pause'
• click on advanced tab
• click on "environment variables" (at the bottom)
• click on path variable and click modify
• add something like this at the end of the PATH definition: ;c:\program files\apache-ant-1.7.1\bin
• don't forget to click on OK to close the environment variables window.

You can then check that your installation is correct by typing:
ant -version
B.3. Installing Maven
B.3.1. What is Maven?

Quoting the Wikipedia entry for Maven:
Maven is a software tool for Java programming language project management and automated
software build. It is similar in functionality to the Apache Ant tool, but has a simpler build
configuration model, based on an XML format. Maven is hosted by the Apache Software
Foundation, where it was formerly part of the Jakarta Project.
Maven uses a construct known as a Project Object Model (POM) to describe the software
project being built, its dependencies on other external modules and components, and the build
order. It comes with pre-defined targets for performing certain well defined tasks such as
compilation of code and its packaging.
A key feature of Maven is that it is network-ready. The core engine can dynamically download
plugins from a repository, the same repository that provides access to many versions of
different Open Source Java projects, from Apache and other organizations and developers. This
repository and its reorganized successor the Maven 2 repository are the de facto distribution
mechanism for Java applications. Maven provides built in support not just for retrieving files
from this repository, but to upload artifacts at the end of the build. A local cache of
downloaded artifacts acts as the primary means of synchronizing the output of projects on a
local system.
Nuxeo is now fully "maven managed".
Nuxeo holds a Maven repository here: http://maven.nuxeo.org/.
B.3.2. Installing Maven

You should then install Maven 2 on your development box by downloading the latest tarball from
http://maven.apache.org/download.html and then untar the archive in /opt (for instance).
We recommend that you use one of the following versions of Maven: 2.0.9, 2.0.10, 2.2.1.
As usual, you have to put the mvn executable into the path of your environment (cf. Ant)
Then add the bin/ subdir in your PATH by adding something like the following in your .bashrc:
export PATH=/opt/maven-2.0.9/bin:$PATH
Nuxeo EP 5.3 420

In a new shell you can then test:

$ mvn --version
Maven version: 2.0.9
B.4. Installing JBoss AS
B.4.1. JBoss documentation

Nuxeo README included into JBoss distribution.
Original JBoss README.
B.4.2. Enable EJB3 support

Nuxeo EP default target is the JBoss application server with EJB3 support enabled. To enable the EJB3
support, you should install JBoss with the latest version of the JEMS installer:
$ sudo java -jar jems-installer-1.2.0.GA.jar
While executing the installation wizard, you must select ejb3 install. You can leave all other parameters to their
default values.
You would get PermGenSpace errors if you run JBoss without this configuration:
• Linux:
Edit /opt/jboss/bin/run.conf and add the following line at the end of the file
JAVA_OPTS="$JAVA_OPTS -XX:MaxPermSize=128m"
Restart JBoss.
• Windows:
Edit $JBOSS/bin/run.bat and add the following line after the line : set JAVA_OPTS=%JAVA_OPTS%
-Dprogram.name=%PROGNAME%
set JAVA_OPTS=%JAVA_OPTS% -XX:MaxPermSize=128m
Restart JBoss.
B.4.3. JBoss AS listening ports customization

The common task for JBoss users is making it to communicate over a single HTTP server. This is quite useful
for network administration, making it easier to go through firewalls. This section describes the necessary steps
to make JBoss communicate primarily over HTTP.
B.4.3.1. Tomcat Web server
JBoss is shipped with built-in Tomcat web server. This server is configured in
'deploy/jbossweb-tomcat55.sar/server.xml' By default only two connectors are enabled: HTTP connector (port
8080) and AJP connector (port 8009). Generally speaking you need only one of them. The former connector is
needed if standalone HTTP server built in JBoss is used. You may want to configure it to listen the default
HTTP port 80. The latter connector is needed only if you want to couple JBoss server with external web server
Nuxeo EP 5.3 421

like Apache, in this case it is reasonable, for security issues to change the binding address to 'localhost' (of
course if Apache runs on the same host).
B.4.3.2. HTTP invoker web application
The JBoss default configuration deploys a special service that can be used to expose different JBoss services in
the HTTP server. It is located in 'deploy/http-invoker.sar'. The configuration file
'deploy/http-invoker.sar/META-INF/jboss-service.xml' may be tweaked to tune the AS to specific needs. By
default the service provides HTTP invoker MBean for EJB ('jboss:service=invoker,type=http') and two HTTP
proxy MBeans that marshal the requests to the Naming service MBean
('jboss:service=invoker,type=http,target=Naming' and
'jboss:service=invoker,type=http,target=Naming,readonly=true'). If you need to provide HTTP interface to
another MBeans, you also may specify the proxy services in
'deploy\http-invoker.sar\META-INF\jboss-service.xml'. For instance the SRP service for JBoss authentication
may be exposed here.
The service also deploys web application 'deploy/http-invoker.sar/invoker.war', that configures the servlets that
convert HTTP requests into invocation of MBeans/EJB methods. If you add HTTP proxies to MBeans, you
may need to add servlets that handle the corresponding URI.
Important note. If HTTPS protocol is used the configuration should not use the default host name because the
virtual host name used in the URL (say 'www.nuxeo.org') and exposed in SSL certificates usually differs from
the computer name where JBoss is running. To accomplish this get rid of the following attributes:
InvokerURLPrefix, InvokerURLSuffix, UseHostName, replacing them with a single InvokerURL attribute, like
this:
<mbean code="org.jboss.invocation.http.server.HttpProxyFactory"
name="jboss:service=invoker,type=https,target=Naming">

<attribute name="InvokerURL">
https://www.nuxeo.org/invoker/JMXInvokerServlet
</attribute>
<attribute name="ExportedInterface">
org.jnp.interfaces.Naming
</attribute>
<attribute name="JndiName"></attribute>
<attribute name="ClientInterceptors">
<interceptors>
<interceptor>org.jboss.proxy.ClientMethodInterceptor</interceptor>
<interceptor>org.jboss.proxy.SecurityInterceptor</interceptor>
<interceptor>org.jboss.naming.interceptors.ExceptionInterceptor</interceptor>
<interceptor>org.jboss.invocation.InvokerInterceptor</interceptor>
</interceptors>
</attribute>
<depends>jboss:service=invoker,type=https</depends>
</mbean>

B.4.3.3. JNDI service
This is the core service of JBoss and should never be disabled. Nevertheless this service does not need own
listening port (1099,1098), so just change the '1099' to '-1':
<mbean code="org.jboss.naming.NamingService"
name="jboss:service=Naming"
xmbean-dd="resource:xmdesc/NamingService-xmbean.xml">

<attribute name="CallByValue">false</attribute>

<attribute name="Port">-1</attribute>

<attribute name="BindAddress">localhost</attribute>

<attribute name="RmiPort">1098</attribute>

<attribute name="RmiBindAddress">localhost</attribute>

<depends optional-attribute-name="LookupPool"
proxy-type="attribute">jboss.system:service=ThreadPool</depends>
</mbean>
B.4.3.4. Default JBoss EJB invokers
You may deinstall the JRMP and Pooled invokers completely. Just comment out the MBeans that provide the
corresponding services in 'conf/jboss-service.xml'.
Important note. The JBoss specifies the invokers for EJB in 'conf/standardjboss.xml' file. The default is
'jboss:service=invoker,type=jrmp' invoker. To change it to HTTP invoker you need to add invoker bindings for
all EJB types deployed in your applications. Generally it means you need to copy all "*-rmi-invoker" bindings
into "*-http-invoker" bindings, replacing
"<invoker-mbean>jboss:service=invoker,type=jrmp</invoker-mbean>" with
"<invoker-mbean>jboss:service=invoker,type=http</invoker-mbean>" for the new bindings. Also you will
need to make the HTTP invoker default for all EJB container configurations replacing
"<invoker-proxy-binding-name>*-rmi-invoker</invoker-proxy-binding-name>" with
"<invoker-proxy-binding-name>*-http-invoker</invoker-proxy-binding-name>" correspondingly.
The easiest (but probably not the right) way for JBoss 4.0.x is to replace the string
'jboss:service=invoker,type=jrmp' with 'jboss:service=invoker,type=http' in this file by any text editor. It may
be not correct if you want to mix both invokers for your EJBs.
B.4.3.5. JBoss EJB3 invoker
The EJB3 invoker which is specified in 'deploy/ejb3.deployer/META-INF/jboss-service.xml' uses JBoss

remoting mechanism. By default it is bound to socket with a connector listening TCP/IP port 3873. This should
be changed to the servlet locator:
<mbean code="org.jboss.remoting.transport.Connector"
name="jboss.remoting:type=Connector,name=DefaultEjb3Connector,handler=ejb3">
<depends>jboss.aop:service=AspectDeployer</depends>
<attribute name="InvokerLocator">
servlet://${jboss.bind.address}/invoker/Ejb3InvokerServlet
</attribute>
<attribute name="Configuration">
<handlers>
<handler subsystem="AOP">org.jboss.aspects.remoting.AOPRemotingInvocationHandler</handler>
</handlers>
</attribute>
</mbean>
The corresponding servlet should be added to invoker web application descriptor

('http-invoker.sar/invoker.war/WEB-INF/web.xml'):
<servlet>
<servlet-name>Ejb3InvokerServlet</servlet-name>
<description>
The ServerInvokerServlet receives requests via HTTP protocol
from within a web container and passes it onto the
ServletServerInvoker for processing.
</description>
<servlet-class>
org.jboss.remoting.transport.servlet.web.ServerInvokerServlet
</servlet-class>
<init-param>
<param-name>locatorUrl</param-name>
<param-value>
servlet://${jboss.bind.address}/invoker/Ejb3InvokerServlet
</param-value>
<description>
The servlet server invoker locator url
</description>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Ejb3InvokerServlet</servlet-name>
<url-pattern>/Ejb3InvokerServlet/*</url-pattern>
</servlet-mapping>
Nuxeo EP 5.3 423

B.4.4. Affected JBoss services

As JRMP invoker is used in many other JBoss services, so it should be replaced. The affected MBeans are
"jboss:service=ClientUserTransaction" (conf/jboss-service.xml),
"jboss.jmx:type=adaptor,name=Invoker,protocol=jrmp,service=proxyFactory".
B.4.4.1. Client User Transaction
The Client User Transaction service depends on two JRMP Proxy Factories described in the nested MBeans.
Every JRMP proxy factory should be replaced with HTTP proxy factory:
<mbean
code="org.jboss.tm.usertx.server.ClientUserTransactionService"
name="jboss:service=ClientUserTransaction"
xmbean-dd="resource:xmdesc/ClientUserTransaction-xmbean.xml">
<depends>
name="jboss:service=proxyFactory,target=ClientUserTransactionFactory">
<attribute name="InvokerName">jboss:service=invoker,type=http</attribute>
<attribute name="JndiName">UserTransactionSessionFactory</attribute>
org.jboss.tm.usertx.interfaces.UserTransactionSessionFactory
</attribute>
<interceptors>
</interceptors>
</attribute>
<depends>jboss:service=invoker,type=http</depends>
</mbean>
</depends>
<depends optional-attribute-name="TxProxyName">
name="jboss:service=proxyFactory,target=ClientUserTransaction">
<attribute name="InvokerName">jboss:service=invoker,type=http</attribute>
<attribute name="JndiName"></attribute>
org.jboss.tm.usertx.interfaces.UserTransactionSession
</attribute>
<interceptors>
</interceptors>
</attribute>
<depends>jboss:service=invoker,type=http</depends>
</mbean>
</depends>
</mbean>
Note that JRMP Proxy factory attributes differ from attributes of HTTP proxy factory.
B.4.4.2. JMX adaptor
The JMX adaptor is adapted for HTTP as following ('deploy/jmx-invoker-service.xml'):

name="jboss.jmx:type=adaptor,name=Invoker,protocol=http,service=proxyFactory">
<attribute name="InvokerURL">https://www.nuxeo.org/invoker/JMXInvokerServlet</attribute>
<depends optional-attribute-name="InvokerName">jboss.jmx:type=adaptor,name=Invoker</depends>
<attribute name="ExportedInterface">org.jboss.jmx.adaptor.rmi.RMIAdaptor</attribute>
<attribute name="JndiName">jmx/invoker/HttpAdaptor</attribute>
</mbean>
and ('deploy/console-mgr.sar/META-INF/jboss-service.xml'):
<mbean code="org.jboss.console.manager.PluginManager"
name="jboss.admin:service=PluginManager">
<depends>jboss.jmx:type=adaptor,name=Invoker,protocol=http,service=proxyFactory</depends>

</mbean>
B.4.4.3. Datasource adaptors
Nuxeo EP 5.3 424

You need to set the invoker explicitly for all deployed data sources. The element <jmx-invoker-name> should
be added to all <local-tx-datasource> and <xa-datasource> elements. Otherwise the server will complain about
missing JRMP invoker which is used by default:
<datasources>
...
<local-tx-datasource>

<jmx-invoker-name>jboss:service=invoker,type=https</jmx-invoker-name>

...
</local-tx-datasource>
...
</datasources>
B.5. Installing a Subversion client

The official svnbook is a very good reference for both beginners and advanced subversion users.
B.5.1. Generic subversion clients with linux

The Nuxeo EP source repository is a Subversion repository thus you will need a subversion client to access the
source code. Most Linux distributions provide the svn command line tool. To install it under Ubuntu / Debian:
$ sudo apt-get install subversion
Under Fedora Core, this should become:

$ yum install subversion
B.5.2. Windows
For MS Windows, we recommend to use the TortoiseSVN Subversion client. You can also directly use the
Subversion command-line client from Subversion website.
B.6. Installing mercurial

Nuxeo EP source are tracked using Mercurial from Selenic.
B.6.1. Linux
To install the hg command under Ubuntu / Debian :
$ sudo apt-get install mercurial
Under Fedora Core, this should become:

$ yum install mercurial
B.6.2. Windows
For MS Windows, we recommend to use the all in one tortoise bundle provided to you by selenic.
B.6.3. Mac OS
Nuxeo EP 5.3 425

For Mac OS, our preferred method is to use the darwin ports environment.
$ port install mercurial
B.6.4. Setting a username

If you plan to checkin in nuxeo's hg repositories, you should provide a valid user name. This is achieved by
setting the username property in the .hgrc settings file.
...
[ui]
...
username = firstname lastname <you@your-domain>
...
B.6.5. Activating pre-integrated extensions

You should activate some pre-integrated extensions for working with nuxeo repositories. This is achieved by
adding the following lines to the extensions section of your .hgrc.
...
[extensions]
...
hgext.mq =
hgext.parentrevspec =
hgext.graphlog =
patchbomb =
transplant =
...
B.6.6. Using forest

Nuxeo EP sources are available as a forest (nuxeo-ecm: nuxeo-common, nuxeo-core, ...). You're able to extend
the hg internal commands by installing the hgforest plugin. One way is to clone the forest hg plugin's
repository.
$ hg clone http://hg.akoha.org/hgforest
. The next step is to declare the plugin into you .hgrc file in the extension section.
[extensions]
...
hgext.forest = [your installation path]/forest.py
...
B.7. Chapter Key Point

In this chapter, we learned:
• how to install a Java development environment (JDK) on your machine
• how to install Ant and Maven, two mandatory tools for building and deploying your own projects on top
of the Nuxeo platform
• how to install the JBoss AS 4 application server that will act as a container for the Nuxeo application
• how to install Mercurial and Subversion clients
Nuxeo EP 5.3 426

Nuxeo EP 5.3 427

Appendix C. Commercial Support
C.1. About Us
The Nuxeo open source ECM platform is developed and published by Nuxeo SA, a company headquartered in
France, with offices around the world.
Through our commercial offer, Nuxeo Connect, we deliver enterprise-grade functional and technical support,
certified software patches and updates, and management tools that assist you during every stage of the
application life-cycle - from design and development, throughout testing and deployment, to operations and
monitoring. Nuxeo Connect helps reduce business and technical risks, increase productivity, speed time to
deployment and improve your success rate for all Nuxeo-based projects.
We're also happy to work with partners, IT Integrators or ISVs, to deliver the best possible applications to
customers.
C.2. Contact information
C.2.1. General
Web: www.nuxeo.com
E-mail: [email protected]
C.2.2. Europe
18-20, rue Soleillet
75020 Paris - France
Tel: +33 1 40 33 79 87
Fax: +33 1 43 58 14 15
C.2.3. USA
55 Cambridge Street, Burlington, MA 01803
Tel: +1 781-328-0520
Fax: +1 781-328-0521
Nuxeo EP 5.3 428

Nuxeo DMS

Uploaded by

Copyright:

Available Formats

Nuxeo DMS

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Nuxeo DMS

Uploaded by

Copyright:

Available Formats

What are the main sections covered in the document?

What are the main sections covered in the document?

What are some of the prerequisites mentioned for working with Nuxeo?

What are some of the prerequisites mentioned for working with Nuxeo?

Nuxeo Document Management -

Copyright © 2000-2010, Nuxeo SA.

4.3.3. Flexible deployment system ........................................................................... 44

Nuxeo EP 5.3 iii

8.1. Introduction ............................................................................................................. 78

11.4. The Compass plugin ............................................................................................. 105

18.3. Architecture ......................................................................................................... 152

25. Placeful Configuration ..................................................................................................... 185

Nuxeo EP 5.3 vii

29.7.2. Frequent patterns ....................................................................................... 217

Nuxeo EP 5.3 viii

34.1. Restlet Integration ................................................................................................ 247

39.4.2. Connecting a client to Nuxeo WebDAV connector ...................................... 276

49.2. Use case .............................................................................................................. 310

55.1.1. Overview and online documentation ........................................................... 341

Nuxeo EP 5.3 xii

59.3. NXAS Repository Plugin ...................................................................................... 380

Nuxeo EP 5.3 xiii

67. Nuxeo DocumentLink Addon .......................................................................................... 406

Nuxeo EP 5.3 xiv

• Business process management (workflow)

• Digital asset management (DAM)

• Digital assets management (DAM)

• News management systems for press agencies

• Museum collections management

1.1. What this Book Covers

1.2. What this book doesn't cover

This book is not a tutorial either. There is also a tutorial on http://www.nuxeo.org/.

1.3. Target Audience

1.4. About Nuxeo

1.5. About Open Source

2.1. Enterprise Content Management

2.1.1. Why ECM?

2.2. The Nuxeo ECM platform

2.3. Introduction FAQ

2.3.1. What are Nuxeo EP 5, Nuxeo EP and Nuxeo RCP?

2.4. Intended audience

2.5. What this book covers

• Eclipse 3.5 (aka galileo) (J2EE edition)

• Maven (for setting up eclipse and builds)

3.3. Eclipse Plugins v Command Line

• Mercurial Integration for eclipse

3.4. Learning from the project sample

• display book documents;

• regulate book document states;

• make book documents indexable and searchable;

• enable drag and drop book creation mode;

• handle book document creation events.

3.5. Setting up the sample project

3.5.1. Some handy environment settings

export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=512M"

3.5.2. Checking the sample project out of mercurial

3.5.3. Initialize the Eclipse workspace

$ mvn -Declipse.workspace=. eclipse:configure-workspace

3.5.4. Setting up your project for importing into Eclipse

3.5.5. Importing the sample project into Eclipse