Nuxeo 5 Technical Brief Technical<br/>Thierry Delprat - 2006/09/19<br/><br/><br/>Design goals Design<br/><br/><br/>Design goals Design<br/><br/><br/>Flexible deployment<br/><br/><br/>Address different deployment targets:<br/><br/><br/>RCP, JBoss AS ... Full web, full client, client-server<br/><br/><br/><br/>Permit different deployment strategies<br/><br/><br/><br/><br/>Provide several scale-out deployement scenarii<br/><br/><br/><br/>Keep as much as possible of the good Zope/CPS concepts<br/><br/><br/>Modularity and extensibility Schemas and documents types Actions and views management Caching and invalidation<br/><br/><br/><br/><br/><br/><br/><br/><br/>Design goals Design<br/><br/><br/>Make framework usage more accessible<br/><br/><br/>Provide different levels of access Clearly separate each features to have clear API Rely on standards<br/><br/><br/><br/><br/><br/><br/><br/>Leverage the open source Java community<br/><br/><br/>Use « best of breed » existing components Integrate them into plug &amp; play ECM features<br/><br/><br/><br/><br/><br/>Build for the future<br/><br/><br/>Design consequences Design<br/><br/><br/>Nuxeo 5 must rely on standards<br/><br/><br/>Easy access and interoperability Framework perenity<br/><br/><br/><br/><br/><br/>Nuxeo 5 must provide deployment services<br/><br/><br/>Target OSGI and JMX<br/><br/><br/><br/>Nuxeo 5 must provide extension mechanisms<br/><br/><br/>Enterprise Components (replacement for Zope Products) Enable the creation of simple plug-ins<br/><br/><br/><br/><br/>Design consequences Design<br/><br/><br/>Nuxeo 5 must be built on a layered architecture<br/><br/><br/>Choose what to deploy, where Provide multi-level API Share components between the client and the server<br/><br/><br/><br/><br/><br/><br/><br/>Nuxeo 5 integrates existing OSS components<br/><br/><br/>Jackrabbit / Lucene / jBPM /JBoss Rules / JOOConv ...<br/><br/><br/><br/>Nuxeo 5 uses innovatives Java technologies<br/><br/><br/>Make the framework sexy for developpers Make Java and JEE « agile »<br/><br/><br/><br/><br/>Nuxeo Runtime Nuxeo<br/><br/><br/>NXRuntime<br/><br/><br/>One component model<br/><br/><br/>RCP ECM Application Local API<br/><br/>JEE ECM Web Application Remote API<br/><br/>OSGi<br/><br/><br/><br/>Deployment service<br/><br/><br/>Mutualized ECM Component<br/><br/>JBoss (JMX) custom deployer Eclipse RCP (OSGI)<br/><br/>Nuxeo RunTime Eclipse RCP OSGI Rich ECM Client JBoss AS JMX Thin Web 2.0 ECM Client<br/><br/><br/><br/><br/><br/>Localization services<br/><br/><br/>Uses the platform's native features<br/><br/><br/><br/>Nuxeo components are native components<br/><br/><br/>NXRuntime features NXRuntime<br/><br/><br/>Runtime includes an extension points system<br/><br/><br/>Based on the Eclipse model<br/><br/><br/><br/>You can define new extensions points<br/><br/><br/>Let other components extend yours<br/><br/><br/><br/>You can use extension points<br/><br/><br/>Extend or configure via XML descriptors<br/><br/><br/>Extension examples Extension<br/><br/><br/>Pluggable repository Schemas and content types registration Actions and views registration Register event handlers Register transformation plugins<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>NXRuntime implementation NXRuntime<br/><br/><br/>Pure POJO NXRuntime defines<br/><br/><br/><br/><br/>The component model The runtime services The extension mechanism<br/><br/><br/><br/><br/><br/><br/><br/>NXJBossRuntime and NXEclipseRuntime provide adapters<br/><br/><br/>For starting and stoping services and bundles For using native services<br/><br/><br/><br/><br/>Layers Layers<br/><br/><br/>Nuxeo 5 Layers Nuxeo<br/>Nuxeo 5<br/>UI Layer<br/><br/>Presentations and Views UI Toolkit<br/><br/>Enterprise Components WDK<br/><br/>Logic Layer<br/><br/>Business Logic Generic ECM Services<br/><br/>Platform ECM Core<br/><br/>Storage Layer<br/><br/>Core document management Runtime<br/><br/><br/>Layers Layers<br/><br/><br/>Clear separation of concerns<br/><br/><br/>Document storage handled by the ECM Core<br/><br/><br/>ex : eMail document storage ex : Mail extraction, creation, sending ... ex : WebMail, Send via mail, Mail display ...<br/><br/><br/><br/>All logic handled by « the Logic Layer »<br/><br/><br/><br/><br/>All presentation handled by the « the Presentation Layer »<br/><br/><br/><br/><br/>Enterprise components (ex-Products) may be split in 5 parts<br/><br/><br/>One client part: JEE or RCP One server part: JEE or RCP One storage part: normally only parameters via extensions points<br/><br/><br/><br/><br/><br/><br/>Layers Layers<br/><br/><br/>Each layer provides its own set of API<br/><br/><br/>Core level<br/><br/><br/>Monolithic API Compound API for the services and content objects deployed Compound AJAX API on UI controlers<br/><br/><br/><br/>Logic layer<br/><br/><br/><br/><br/>UI Layer<br/><br/><br/><br/><br/>Each layer leverages NXRuntime<br/><br/><br/>For extensibility For deployment transparency (when needed)<br/><br/><br/><br/><br/>Layers Layers<br/>Nuxeo RCP Components<br/><br/>(Remote) Ajax API<br/><br/>Nuxeo Apogee GUI Local EC APIs<br/>ejb3 cont.<br/><br/>Nuxeo Web Framew ork<br/><br/>Remote EC APIs<br/><br/>Nuxeo Enterprise Components<br/><br/>Local Core API<br/><br/>Remote Core API<br/><br/>Nuxeo ECM Core<br/><br/>Nuxeo RunTime Eclipse RCP OSGI Rich ECM Client JBoss AS JMX Client / Server Thin Web 2.0 ECM Solution ECM Client<br/><br/>(Full client side)<br/><br/>(GUI on the client (Full server logic on the server) side)<br/><br/><br/>ECM Core ECM<br/><br/><br/>ECM Core ECM<br/><br/><br/>Embeddable document management library<br/><br/><br/>For the server For the client<br/><br/><br/><br/><br/><br/>Contains all generic features<br/><br/><br/>Content storage and retrieval Content schemas management Indexing / query (using NXQL) Low level events ACL and contextual security management Versioning<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>ECM Core features ECM<br/><br/><br/>Document storage<br/><br/><br/>Storage done according to a set of XSD Schemas Uses JCA to have storage adapters<br/><br/><br/><br/><br/>JCR in current default implementation<br/><br/><br/><br/>Security<br/><br/><br/>Stores ACE, ACL and ACP on each document<br/><br/><br/>Storage can be done outside of the document<br/><br/><br/><br/>Provides placeful security checks<br/><br/><br/>ECM Core features ECM<br/><br/><br/>Indexing and query<br/><br/><br/>Provides a technical indexing Provides a NXQL Query interface<br/> <br/><br/><br/><br/>Several adapters in the way (BIRT, OLEDB ...) Targets MetaQuery in JCR, SQL, LDAP ...<br/><br/><br/><br/>Event manager<br/><br/><br/>Catches all data-related events Pluggable with JMS<br/><br/><br/><br/><br/><br/>Versionning<br/><br/><br/>Check in / Check out model<br/><br/><br/>Implementation Implementation<br/><br/><br/>Pure POJO<br/><br/><br/>Uses NXRuntime as component model<br/><br/><br/><br/>JCA used to manage the storage adapter JSR 170 (JCR) used as default storage<br/><br/><br/><br/><br/>Apache Jackrabbit by default<br/><br/><br/><br/>XSD is used to define schemas<br/><br/><br/>Schemas are mapped to node types in the JCR<br/><br/><br/>Usage Usage<br/><br/><br/>Extensions points<br/><br/><br/>Declaring schemas Defining types Registering event handlers<br/><br/><br/><br/><br/><br/><br/><br/>ECM storage API for the upper layers 2 API flavors<br/><br/><br/><br/><br/>POJO local API IIOP/SOAP remote API via ejb3<br/><br/><br/><br/><br/>Logical view Logical<br/>POJO Local API JEE Local and Remote API<br/><br/>ECM Core Nuxeo ECM Core API Nx o ECM Services NNx eECM Services ux ECM Services Nuxeo Core (Content Repository) Storage Adapter JCA JCR / Jack Rabbit<br/><br/><br/>Document Object Document<br/>DocumenModels<br/><br/><br/>Inside the Core<br/><br/><br/>Core API<br/><br/>CoreDocuments<br/>NxCore Services NxCore Services NxCore Services<br/><br/>ECM Core<br/><br/><br/><br/>Outside the Core (In and Out)<br/><br/><br/>Core Documents NxCorre Services NxCore Services NxCo e Services Core Documents Nuxeo Runtime NxContent Model<br/><br/>DocumentModel<br/><br/><br/>CoreDocument CoreDocument<br/><br/><br/>A CoreDocument is<br/><br/><br/>A Type name A set of schemas A set of facet (Folderish, Orderable ...)<br/><br/><br/><br/><br/><br/><br/><br/>A CoreDocument has no GUI-related information<br/><br/><br/>Motivations for DocumentModel<br/><br/><br/>Detach document from the Core<br/><br/><br/>Use Serializable objects Reduce network calls<br/><br/><br/><br/><br/><br/>Transmit a consolidated artifact of the content object Transparent Lazy fetching Caching and invalidation management<br/><br/><br/><br/><br/><br/><br/>« Logical Layer » « Logical<br/><br/><br/>The Logic part The<br/><br/><br/>High level ECM services<br/><br/><br/>Audit and logging service Workflow service Comment service Transformation service ...<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>Provides business logic<br/><br/><br/>The Core provides the structure EC provides the behavior associated to documents<br/><br/><br/><br/><br/>Platform Platform<br/><br/><br/>Integration with JEE Security<br/><br/><br/>AOP Security Interceptors JAAS Integration<br/>Domain<br/><br/>Server<br/><br/>Data Storage Referential Directories User Directories<br/><br/><br/><br/>Domain<br/><br/><br/><br/>Default content hierarchy<br/><br/><br/>Workspace<br/><br/>Workspace Document Repository<br/><br/>Provide very basic content logic over the core Enable multi-cores instances<br/>Folder<br/><br/>Folder<br/><br/>Folder<br/><br/>Audit Trail<br/><br/><br/><br/>Doc<br/><br/>Doc<br/><br/><br/>Logical view Logical<br/><br/><br/>Packaged as separated and logical bundles Leverages JEE 5<br/><br/><br/>Enterprise Components APIs<br/><br/>ECM Enterprise components<br/><br/><br/>No ECM Services NuxNx ECM Services e x ECM Components Nx ECM JEE Services NuxNo ECM Services e x ECM Services<br/><br/>EJB3 SB EJB3 MDB Integrate JAAS<br/><br/><br/><br/><br/><br/>JEE Local and Remote API ECM Core Nuxeo ECM Core API<br/><br/><br/>EJB Power EJB<br/><br/><br/>Enterprise Java Beans component model provides:<br/><br/><br/>Instance pooling State management (Session Bean) Persistance management (Entity Bean) Transaction handling Security propagation Remote call management Deployment and clustering services Session Bean (Stateless ou Statefull): services Entity Bean: Data Object (uses Hibernate) Message Driven Bean: JMS activated component<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>3 main models of EJBs:<br/> <br/><br/><br/><br/><br/>Nuxeo 5 and EJB Nuxeo<br/><br/><br/>We use the new (JEE5) EJB model: EJB 3<br/><br/><br/>Simpler code (one simple class) Uses annotations instead of XML descriptors Almost POJO<br/><br/><br/><br/><br/><br/><br/><br/>Nuxeo 5 uses<br/><br/><br/>Session Beans for Services<br/><br/><br/>Transaction, Security, Pooling, State management, Remote access JMS driven services When DB Mapping is usefull (logging, non-JCR configuration ...)<br/><br/><br/><br/>Message Driven Bean<br/><br/><br/><br/><br/>Entity Beans<br/><br/><br/><br/>Leverage Java Community Leverage<br/><br/><br/>JBPL for workflow and BPEL JSR-94 (JBoss Rules) for rules management JBoss Cache for caching Adobe server and JOOConv for transformation Jena for RDF relations management<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>What about RCP? What<br/><br/><br/>We already have some Apogee reusable components<br/><br/><br/>Eclipse RCP enforces seperation of GUI vs Logic<br/><br/><br/><br/>Some services will be mutualized<br/><br/><br/>Same API with POJO and EJB implementation<br/><br/><br/>like the Core<br/><br/><br/><br/>Usage of EJB3 embeddable container<br/><br/><br/><br/>We are about to start a new ECM project to build the RCP part<br/><br/><br/>« Presentation Layer » « Presentation<br/><br/><br/>What we need What<br/><br/><br/>A web rendering framework<br/><br/><br/>Template system Reusable widgets Tools to make GUI development easy Action management services Process-driven Form engine<br/><br/><br/><br/><br/><br/><br/><br/>Navigation services<br/> <br/><br/><br/><br/>Document presentation services<br/><br/><br/><br/><br/>Context and cache management Glue code between the presentation and the logic layers<br/><br/><br/><br/><br/>Java Server Faces Java<br/><br/><br/>High level Web framework<br/><br/><br/>MVC Model<br/><br/><br/>Bean, Widget, Handler<br/><br/><br/><br/>Handles tree of UI components Even driven navigation Can support differents render kits Complex but plugable life cycle Some IDE tools begins to exists Template mechanism Enforces pure presentation<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>Facelet template system (like ZPT)<br/> <br/><br/><br/><br/>Expression Langage (like TAL)<br/><br/><br/><br/>Java Server Faces Java<br/><br/><br/>We use apache JSF implementation<br/><br/><br/>Apache MyFaces Tomahawk<br/><br/><br/><br/><br/><br/>JMO has already a JSF version of CPSSkins<br/><br/><br/>JBoss Seam JBoss<br/><br/><br/>The missing link between JSF and EJB3<br/><br/><br/>Uses EJB3 as Action Listeners (event handlers) Keep all conversation related objects in cache Context bijection Uses jBPM to define PageFlow Every ActionListener can be accessed via AJAX<br/><br/><br/><br/>Extends JSF to bring real context management<br/> <br/><br/><br/><br/>Extends JSF for navigation rules<br/><br/><br/><br/><br/>Integrate JSON and Prototype<br/><br/><br/><br/><br/>Part of Seam is being taken to the JCP for normalization A hype new JBoss framework searching for its killer app<br/><br/><br/><br/><br/>Nuxeo WDK Nuxeo<br/><br/><br/>Handles all generic document-related features<br/><br/><br/>TypeManager<br/><br/><br/>Binds Widgets and Layout to the documents defined in the Core Defines Actions with EL enabled guards and filters Invalidate Seam context Invalidate stalled DocumentModel<br/><br/><br/><br/>ActionManager<br/><br/><br/><br/><br/>Cache Invalidation Management<br/> <br/><br/><br/><br/>EL resolver<br/><br/><br/><br/>CPSSkins is on the way<br/><br/><br/>Uses JSF and Seam<br/><br/><br/>AJAX / SOAP Action API<br/><br/><br/><br/>JSF / Facelets<br/><br/><br/>Nuxeo Web Framework JSF Facelets JSF Facelets JSF Facelets<br/><br/>as presentation for context management for Action Listener for ECM UI<br/><br/><br/><br/>Seam<br/><br/><br/>Nuxeo WDK<br/><br/>Acttiion Listeners Ac tion Listeners Ac o n Listeners<br/><br/><br/><br/><br/><br/>Nuxeo WDK<br/><br/><br/>Business Delegates<br/><br/><br/><br/>Business Delegate<br/><br/><br/>Enterprises Components API ECM Enterprises Componeents<br/><br/>to encapsulate remote calls<br/><br/><br/>Enterprise Components Enterprise<br/><br/><br/>Enterprise components have their UI part<br/><br/><br/>JSF Views EJB3 Seam Action Listeners Document view definition (Layout)<br/><br/><br/><br/><br/><br/><br/><br/>By enforcing clear separation of layers inside EC<br/><br/><br/>We will have better reusability We will provide easier customization<br/><br/><br/><br/><br/>Where are we? Where<br/><br/><br/>Build in progress Build<br/><br/><br/>Most infrastructure already exists<br/><br/><br/>Runtime and Core will be released soon The Logic layer is usable The basis of the Web Framework exists We are close to stability at least on the lower layers Unit tests (even if not enought) Automated Build (inside and outside eclipse) Some documentation<br/><br/><br/><br/><br/><br/><br/><br/>We already made several refactoring<br/><br/><br/><br/><br/>We now have<br/> <br/><br/><br/><br/><br/>What we have to do What<br/><br/><br/>Write more Enterprise Components<br/><br/><br/>Comments / Relations Workflow Directories ...<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>Begin work on RCP Finish the Web Layer<br/><br/><br/><br/><br/>Get the best out of Seam and JSF Integrate with the new CPSSkins Deal with JSR 168 (Portlets)<br/><br/><br/><br/><br/><br/><br/><br/>Begin integrating a larger dev team