eXo Platform 3.5
Reference Guides
Copyright © 2009-2012 eXo Platform SAS
Welcome to eXo Platform 3.5 Reference Guide. This guide is a complete reference for customization points, and available APIs, for all modules.
Reference Guide / eXo JCR
1. eXo JCR
1.1. Introduction in eXoJCR
1.1.1. Data model
1.2. Why use JCR?
1.2.1. What is JCR?
1.2.2. Why use JCR?
1.2.3. What does eXo do?
1.2.4. Further Reading
1.3. eXo JCR Implementation
1.3.1. Related Documents
1.3.2. How it works
1.3.3. Workspace Data Model
1.4. Advantages of eXo JCR
1.4.1. Advantages for application developers
1.4.2. Advantages for managers
1.5. Compatibility Levels
1.5.1. Level 1
1.5.2. Level 2
1.5.3. Optional features
1.6. Using JCR
1.6.1. Obtaining a Repository object
1.6.2. JCR Session common considerations
1.6.3. JCR Application practices
1.7. Session Leak Detector
1.7.1. Introduction
1.7.2. Activation
1.7.3. Report
1.8. JCR Service Extensions
1.8.1. Concept
1.8.2. Implementation
1.8.3. Configuration
1.8.4. Related Pages
1.9. eXo JCR Application Model
1.10. NodeType Registration
1.10.1. Interfaces and methods
1.10.2. Node type registration
1.10.3. Changing existing node type
1.10.4. Removing node type
1.10.5. Practical How to
1.11. Registry Service
1.11.1. Concept
1.11.2. The API
1.11.3. Configuration
1.12. Namespace altering
1.12.1. Adding new namespace
1.12.2. Changing existing namespace
1.12.3. Removing existing namespace
1.13. Node Types and Namespaces
1.13.1. Node Types definition
1.13.2. Namespaces definition
1.14. eXo JCR configuration
1.14.1. Related documents
1.14.2. Portal and Standalone configuration
1.14.3. JCR Configuration
1.14.4. Repository service configuration (JCR repositories configuration)
1.14.5. Repository configuration
1.14.6. Workspace configuration
1.14.7. Workspace data container configuration
1.14.8. Value Storage plugin configuration (for data container):
1.14.9. Initializer configuration (optional)
1.14.10. Cache configuration
1.14.11. Query Handler configuration
1.14.12. Lock Manager configuration
1.14.13. Help application to prohibit the use of closed sessions
1.14.14. Help application to allow the use of closed datasources
1.14.15. Getting the effective configuration at Runtime of all the repositories
1.15. Multi-language support in eXo JCR RDB backend
1.15.1. Oracle
1.15.2. DB2
1.15.3. MySQL
1.15.4. PostgreSQL
1.16. How to host several JCR instances on the same database instance?
1.16.1. LockManager configuration
1.16.2. HibernateService configuration
1.17. Search Configuration
1.17.1. XML Configuration
1.17.2. Configuration parameters
1.17.3. Global Search Index
1.17.4. Indexing Adjustments
1.18. JCR Configuration persister
1.18.1. Idea
1.18.2. Usage
1.19. JDBC Data Container Config
1.19.1. General recommendations for database configuration
1.19.2. Multi-database Configuration
1.19.3. Single-database configuration
1.19.4. Simple and Complex queries
1.19.5. Forse Query Hints
1.19.6. Notes for Microsoft Windows users
1.20. External Value Storages
1.20.1. Tree File Value Storage
1.20.2. Simple File Value Storage
1.20.3. Content Addressable Value storage (CAS) support
1.20.4. Disabling value storage
1.21. Workspace Data Container
1.22. REST Services on Groovy
1.22.1. Usage
1.23. Configuring JBoss AS with eXo JCR in cluster
1.23.1. Launching Cluster
1.23.2. Requirements
1.23.3. How to stop the node properly
1.24. JBoss Cache configuration
1.24.1. JBoss cache configuration for indexer, lock manager and data container
1.24.2. JGroups configuration
1.24.3. Allow to share JBoss Cache instances
1.24.4. Shipped JBoss Cache configuration templates
1.25. LockManager configuration
1.25.1. LockManagerImpl
1.25.2. CacheableLockManagerImpl
1.26. QueryHandler configuration
1.26.1. Indexing in clustered environment
1.26.2. Configuration
1.26.3. Asynchronous reindexing
1.26.4. Advanced tuning
1.27. JBossTransactionsService
1.27.1. Configuration
1.28. TransactionManagerLookup
1.29. RepositoryCreationService
1.29.1. Dependencies
1.29.2. How it works
1.29.3. Configuration
1.29.4. RepositoryCreationService Interface
1.29.5. Conclusions and restrictions
1.30. JCR Query Usecases
1.30.1. Query Lifecycle
1.30.2. Query result settings
1.30.3. Type Constraints
1.30.4. Property Constraints
1.30.5. Path Constraint
1.30.6. Ordering specifying
1.30.7. Fulltext Search
1.30.8. Indexing rules and additional features
1.30.9. Query Examples
1.30.10. Tips and tricks
1.31. Searching Repository Content
1.31.1. Bi-directional RangeIterator (since 1.9)
1.31.2. Fuzzy Searches (since 1.0)
1.31.3. SynonymSearch (since 1.9)
1.31.4. High-lighting (Since 1.9)
1.31.5. SpellChecker
1.31.6. Similarity (Since 1.12)
1.32. Fulltext Search And Affecting Settings
1.32.1. Property content indexing
1.32.2. Lucene Analyzers
1.32.3. How are different properties indexed?
1.32.4. Fulltext search query examples
1.32.5. Different analyzers in action
1.33. WebDAV
1.33.1. Configuration
1.33.2. Screenshots
1.33.3. Comparison table of WebDav and JCR commands
1.33.4. Restrictions
1.34. FTP
1.34.1. Configuration Parameters
1.35. eXo JCR statistics
1.35.1. Statistics on the Database Access Layer
1.35.2. Statistics on the JCR API accesses
1.35.3. Statistics Manager
1.36. Checking repository integrity and consistency
1.36.1. Recommendations on how to fix corrupted JCR
1.37. JTA
1.38. The
JCA
Resource Adapter
1.38.1. The
SessionFactory
1.38.2. Configuration
1.38.3. Deployment
1.39. Access Control
1.39.1. Standard Action Permissions
1.39.2. eXo Access Control
1.40. Access Control Extension
1.40.1. Prerequisites
1.40.2. Access Context Action
1.40.3. The Invocation Context
1.40.4. Custom Extended Access Manager
1.40.5. Example of a custom Access Manager
1.41. Link Producer Service
1.42. Binary Values Processing
1.42.1. Configuration
1.42.2. Usage
1.42.3. Value implementations
1.43. JCR Resources:
1.44. JCR Workspace Data Container (architecture contract)
1.44.1. Concepts
1.44.2. Requirements
1.44.3. Value storages API
1.45. How to implement Workspace Data Container
1.45.1. Notes on Value storage usage:
1.46. DBCleanService
1.46.1. Methods of DBCleanerService
1.46.2. Need to clean only single workspace
1.46.3. Need to clean the whole repository
1.47. JCR Performance Tuning Guide
1.47.1. JCR Performance and Scalability
1.47.2. Performance Tuning Guide
2. eXo Kernel
2.1. ExoContainer info
2.1.1. Container hierarchy
2.2. Service Configuration for Beginners
2.2.1. Requirements
2.2.2. Services
2.2.3. Configuration File
2.2.4. Execution Modes
2.2.5. Containers
2.2.6. Configuration Retrieval
2.2.7. Service instantiation
2.2.8. Miscellaneous
2.2.9. Further Reading
2.3. Service Configuration in Detail
2.3.1. Requirements
2.3.2. Sample Service
2.3.3. Parameters
2.3.4. External Plugin
2.3.5. Import
2.3.6. System properties
2.3.7. Understanding the prefixes supported by the configuration manager
2.4. Container Configuration
2.4.1. Kernel configuration namespace
2.4.2. Understanding how configuration files are loaded
2.4.3. System property configuration
2.4.4. Variable Syntaxes
2.4.5. Runtime configuration profiles
2.4.6. Component request life cycle
2.4.7. Thread Context Holder
2.5. Inversion Of Control
2.5.1. How
2.5.2. Injection
2.5.3. Side effects
2.6. Services Wiring
2.6.1. Portal Instance
2.6.2. Introduction to the XML schema of the configuration.xml file
2.6.3. Configuration retrieval and log of this retrieval
2.7. Component Plugin Priority
2.8. Understanding the ListenerService
2.8.1. What is the ListenerService ?
2.8.2. How does it work?
2.8.3. How to configure a listener?
2.8.4. Concrete Example
2.9. Initial Context Binder
2.9.1. API
2.10. Job Scheduler Service
2.10.1. Where is Job Scheduler Service used in eXo Products?
2.10.2. How does Job Scheduler work?
2.10.3. Reference
2.11. The data source provider
2.11.1. Configuration
2.12. JNDI naming
2.12.1. Prerequisites
2.12.2. How it works
2.12.3. Configuration examples
2.12.4. Recommendations for Application Developers
2.12.5. InitialContextInitializer API
2.13. Logs configuration
2.13.1. Logs configuration initializer
2.13.2. Configuration examples
2.13.3. Tips and Troubleshooting
2.14. Manageability
2.14.1. Managed framework API
2.14.2. JMX Management View
2.14.3. Example
2.15. ListenerService
3. eXo Core
3.1. Database Creator
3.1.1. API
3.1.2. A configuration examples
3.1.3. An examples of a DDL script
3.2. Security Service
3.2.1. Framework
3.2.2. Usage
3.3. Organization Service
3.3.1. Organizational Model
3.3.2. Custom Organization Service implementation instructions
3.3.3. Related articles and how-tos
3.4. Organization Service Initializer
3.5. Organization Listener
3.5.1. Writing your own listeners
3.5.2. Registering your listeners
3.6. Update ConversationState when user's Membership changed
3.7. DB Schema creator service (JDBC implementation)
3.8. Database Configuration for Hibernate
3.8.1. Generic configuration
3.8.2. Example DB configuration
3.8.3. Registering custom Hibernate XML files into the service
3.9. LDAP Configuration
3.9.1. Quickstart
3.9.2. Configuration
3.9.3. Advanced topics
3.10. Organization Service TCK tests configuration
3.10.1. Maven pom.xml file configuration
3.10.2. Standalone container and Organization Service configuration
3.11. Tika Document Reader Service
3.11.1. Architecture
3.11.2. Configuration
3.11.3. Old-style DocumentReaders and Tika Parsers
3.11.4. TikaDocumentReader features and notes
3.12. Digest Authentication
3.12.1. Server configuration
3.12.2. OrganizationService implementation requirements
4. eXo Web Services
4.1. Introduction to the Representational State Transfer (REST)
4.2. Overwrite default providers
4.2.1. Motivation
4.2.2. Usage
4.2.3. Example
4.3. RestServicesList Service
4.3.1. Usage
4.4. Groovy Scripts as REST Services
4.4.1. Loading script and save it in JCR
4.4.2. Instantiation
4.4.3. Deploying newly created Class as RESTful service
4.4.4. Script Lifecycle Management
4.4.5. Getting node UUID example
4.4.6. Groovy script restrictions
4.5. Framework for cross-domain AJAX
4.5.1. Motivation
4.5.2. Scheme (how it works)
4.5.3. A Working Sequence:
4.5.4. How to use it
5. eXo JCR with GateIn
5.1. How to extend my GateIn instance?
5.1.1. Motivations
5.1.2. Prerequisites
5.1.3. FAQ
5.1.4. Recommendations
5.2. How to use AS Managed DataSource under JBoss AS
5.2.1. Declaring the datasources in the AS
5.2.2. Do not let eXo bind datasources explicitly
6. Frequently Asked Question
6.1. JCR FAQ
6.1.1. Kernel
6.1.2. JCR
Reference Guide / GateIn
About GateIn
1. Configuration
1.2. Email Service Configuration
2. Portal Development
2.1. Skin the portal
2.2. Portal Lifecycle
2.3. Default Portal Configuration
2.4. Portal Default Permission Configuration
2.5. Portal Navigation Configuration
2.5.1. Portal Navigation
2.5.2. Group and User Navigation
2.6. Data Import Strategy
2.7. Internationalization Configuration
2.8. RTL (Right To Left) Framework
2.9. XML Resources Bundles
2.10. Upload Component
2.11. Deactivation of the Ajax Loading Mask Layer
2.12. JavaScript Configuration
2.13. Navigation Controller
3. Applications Development
3.1. Portlet development
3.2. Gadget development
4. Authentication and Identity
4.1. Password Encryption
4.2. Predefined User Configuration
4.3. Authentication Token Configuration
4.4. PicketLink IDM integration
4.5. Organization API
4.6. Access User Profile
4.7. Single-Sign-On (SSO)
5. Web Services for Remote Portlets (WSRP)
5.1. Level of support in GateIn 3.2
5.2. Deploy GateIn's WSRP services
5.3. Make a portlet remotable
5.4. Consume GateIn's WSRP portlets from a remote Consumer
5.5. Consume remote WSRP portlets in GateIn
5.6. Consumers maintenance
5.7. Configure GateIn's WSRP Producer
5.8. WSRP integration configuration
6. Advanced Development - Foundations
6.1. GateIn Kernel
6.2. Configure services
6.3. Configuration syntax
6.4. InitParams configuration object
6.5. Configure a portal container
6.6. GateIn Extension Mechanism and Portal Extensions
6.7. Run Multiple Portals
Reference Guide / Content Functions
About Content Package
1. Portlet Applications
1.1. Content Detail
1.2. Content List
1.3. Search
1.4. Sites Explorer
1.5. Administration
1.6. Fast Content Creator
1.7. Form Builder
1.8. Authoring
1.9. Newsletter
1.10. SEO portlet
2. CMIS
2.1. Overview
2.2. CMIS specification
2.3. xCMIS project
2.4. CMIS features
2.5. Service JARs
3. Configuration
3.1. Components
3.2. External Component Plugins
3.3. CMIS configuration
4. Developer references
4.1. WCM Templates
4.2. WCM Explorer
4.3. Extensions
4.3.2. How to make your own ECMS UI Extensions
4.4. CMIS Usage code examples
4.5. Public REST APIs
4.6. Public Java APIs
4.7. Deprecated portlets
4.8. Miscellaneous and Tips
4.9. FAQs
Reference Guide / Collaboration Functions
Prerequisites
1. Applications
1.1. Portlets
1.2. Gadgets
2. Configurations
2.1. Components
2.2. External Component Plugins
2.3. Data Injectors
2.4. eXo Chatserver Configuration
3. Developer reference
3.1. Extension points
3.2. Public REST APIs
3.3. JCR Structure
Reference Guide / Knowledge Functions
Prerequisites
1. Applications
1.1. Portlets
1.2. Gadgets
2. Configuration
2.1. Components
2.2. External component plugins
2.3. Data Injectors
3. Developer reference
3.1. Extension points
3.2. Internal API
3.3. Wiki Service API
3.4. FAQ Template Configuration
3.5. Actions over a wiki page from external jars
3.6. JCR structure
Reference Guide / Social Functions
1. Applications
1.1. Portlets
1.2. Gadgets
2. Configuration
2.1. Component
2.2. External Component Plugin
3. Developers References
3.1. UI Extensions
3.2. Overridable Components
3.3. Public Java APIs
3.4. Java APIs sample code/ tutorial
3.5. Public REST APIs
3.6. Rest Service APIs
3.6.1. Activity Resources
3.6.2. Activity Stream Resources
3.6.3. Identity Resources
3.6.4. Version Resources
3.7. Public Javascript APIs
3.8. Social JCR Structure
3.9. Spaces Template configuration
3.10. Configure the 2-legged OAuth scenario
Copyright © 2009-2012. All rights reserved. eXo Platform SAS