Nuxeo Enterprise Platform - Version 5.1 and 5.2 The Reference guide 5.1 / 5.2 Copyright © 2000-2008, Nuxeo SAS. 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 .............................................................................................................2 1.5. About Open Source .................................................................................................... 2 2. Introduction ..........................................................................................................................3 2.1. Enterprise Content Management .................................................................................. 3 2.1.1. Why ECM? .....................................................................................................3 2.2. The Nuxeo ECM platform .......................................................................................... 3 2.3. Introduction FAQ ....................................................................................................... 3 2.3.1. What are Nuxeo EP 5, Nuxeo EP and Nuxeo RCP? ........................................... 3 2.4. Intended audience ...................................................................................................... 3 2.5. What this book covers ................................................................................................ 3 3. Getting Started ...................................................................................................................... 5 3.1. Prerequisites .............................................................................................................. 5 3.2. Setting up your Eclipse ............................................................................................... 5 3.2.1. Enabling Maven project loading ....................................................................... 5 3.2.2. Enabling Subversion checkout .......................................................................... 5 3.3. Learning from the project sample ................................................................................ 6 3.3.1. Checkout project ............................................................................................. 6 3.3.2. Understanding sample code .............................................................................. 7 3.3.3. Declaring book document type ......................................................................... 7 3.3.4. Regulating book states ..................................................................................... 8 3.3.5. Displaying book documents ............................................................................. 8 3.3.6. Making book documents indexable and searchable .......................................... 10 3.3.7. Enabling drag&drop creation ......................................................................... 11 3.3.8. Listening for events ....................................................................................... 11 3.4. Starting a new project ............................................................................................... 12 3.5. Using Documentation ............................................................................................... 12 3.6. Other IDEs: IntelliJ IDEA and NetBeans ................................................................... 12 3.6.1. IDEA ............................................................................................................ 12 3.6.2. NetBeans ...................................................................................................... 12 4. General Overview ............................................................................................................... 14 4.1. Introduction ............................................................................................................. 14 4.1.1. Architecture Goals ......................................................................................... 14 4.1.2. Main concepts and design .............................................................................. 17 4.2. Nuxeo Runtime: the Nuxeo EP component model ...................................................... 19 4.2.1. The motivations for the runtime layer ............................................................. 19 4.2.2. Extensible component model .......................................................................... 20 4.2.3. Flexible deployment system ........................................................................... 23 4.2.4. Extension points and Nuxeo 5 ........................................................................ 24 4.3. Nuxeo EP layered architecture .................................................................................. 25 4.3.1. Layers in Nuxeo EP ....................................................................................... 25 4.3.2. API and Packaging impacts ............................................................................ 27 4.3.3. Illustration of the layered architecture ............................................................. 27 4.4. Core Layer overview ................................................................................................ 27 4.4.1. Features of Nuxeo Core ................................................................................. 28 4.4.2. Nuxeo Core main modules ............................................................................. 29 4.4.3. Schemas and document types ......................................................................... 29 4.4.4. Life cycle associated to documents ................................................................. 30 4.4.5. Security model .............................................................................................. 31 4.4.6. Core events system ........................................................................................ 32 4.4.7. Query system ................................................................................................ 32 4.4.8. Versioning system ......................................................................................... 32 4.4.9. Repository and SPI Model ............................................................................. 33 Nuxeo EP 5.1 / 5.2 ii Nuxeo Enterprise Platform - Version 5.1 and 5.2 4.4.10. DocumentModel .......................................................................................... 33 4.4.11. Proxies ........................................................................................................ 34 4.4.12. Core API ..................................................................................................... 34 4.5. Service Layer overview ............................................................................................ 34 4.5.1. Role of services in Nuxeo EP architecture ....................................................... 34 4.5.2. Services implementation patterns .................................................................... 35 4.5.3. Platform API ................................................................................................. 36 4.5.4. Adapters ....................................................................................................... 36 4.5.5. Some examples of Nuxeo EP services ............................................................. 37 4.6. Web presentation layer overview ............................................................................... 37 4.6.1. Technology choices ....................................................................................... 37 4.6.2. Componentized web application ..................................................................... 37 5. Schemas and Documents ..................................................................................................... 40 5.1. Introduction ............................................................................................................. 40 5.1.1. Concepts ....................................................................................................... 40 5.2. Schemas .................................................................................................................. 40 5.3. Core Document Types .............................................................................................. 41 5.4. ECM Document Types ............................................................................................. 41 5.4.1. Label and Icon .............................................................................................