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. Introduction to JCR
1.1. JCR architecture
1.2. Compatibility levels
2. Configuration
2.1. Basic configuration
2.2. Advanced configuration
3. Developer References
3.1. Basic usage
3.2. Advanced usage
4. Administration
4.1. Connectors
4.2. Database
4.3. Tools
4.4. Performance tuning
Reference Guide / eXo Foundations
1. eXo Kernel
1.1. ExoContainer info
1.1.1. Container hierarchy
1.2. Service Configuration for Beginners
1.2.1. Requirements
1.2.2. Services
1.2.3. Configuration File
1.2.4. Execution Modes
1.2.5. Containers
1.2.6. Configuration Retrieval
1.2.7. Service instantiation
1.2.8. Miscellaneous
1.2.9. Further Reading
1.3. Service Configuration in Detail
1.3.1. Requirements
1.3.2. Sample Service
1.3.3. Parameters
1.3.4. External Plugin
1.3.5. Import
1.3.6. System properties
1.3.7. Understanding the prefixes supported by the configuration manager
1.4. Container Configuration
1.4.1. Kernel configuration namespace
1.4.2. Understanding how configuration files are loaded
1.4.3. System property configuration
1.4.4. Variable Syntaxes
1.4.5. Runtime configuration profiles
1.4.6. Component request life cycle
1.4.7. Thread Context Holder
1.5. Inversion Of Control
1.5.1. How
1.5.2. Injection
1.5.3. Side effects
1.6. Services Wiring
1.6.1. Portal Instance
1.6.2. Introduction to the XML schema of the configuration.xml file
1.6.3. Configuration retrieval and log of this retrieval
1.7. Component Plugin Priority
1.8. Understanding the ListenerService
1.8.1. What is the ListenerService ?
1.8.2. How does it work?
1.8.3. How to configure a listener?
1.8.4. Concrete Example
1.9. Initial Context Binder
1.9.1. API
1.10. Job Scheduler Service
1.10.1. Where is Job Scheduler Service used in eXo Products?
1.10.2. How does Job Scheduler work?
1.10.3. Reference
1.11. eXo Cache
1.11.1. Basic concepts
1.11.2. Advanced concepts
1.11.3. eXo Cache extension
1.11.4. eXo Cache based on JBoss Cache
1.11.5. eXo Cache based on Infinispan
1.12. The data source provider
1.12.1. Configuration
1.13. JNDI naming
1.13.1. Prerequisites
1.13.2. How it works
1.13.3. Configuration examples
1.13.4. Recommendations for Application Developers
1.14. Logs configuration
1.14.1. Logs configuration initializer
1.14.2. Configuration examples
1.14.3. Tips and Troubleshooting
1.15. Manageability
1.15.1. Managed framework API
1.15.2. JMX Management View
1.15.3. Example
1.16. RPC Service
1.16.1. Configuration
1.16.2. The SingleMethodCallCommand
2. eXo Core
2.1. Database Creator
2.1.1. API
2.1.2. A configuration examples
2.1.3. An examples of a DDL script
2.2. Security Service
2.2.1. Framework
2.2.2. Usage
2.3. Organization Service
2.3.1. Organizational Model
2.3.2. Custom Organization Service implementation instructions
2.4. Organization Service Initializer
2.5. Organization Listener
2.5.1. Writing your own listeners
2.5.2. Registering your listeners
2.6. Update ConversationState when user's Membership changed
2.7. DB Schema creator service (JDBC implementation)
2.8. Database Configuration for Hibernate
2.8.1. Generic configuration
2.8.2. Example DB configuration
2.8.3. Registering custom Hibernate XML files into the service
2.9. LDAP Configuration
2.9.1. Quickstart
2.9.2. Configuration
2.9.3. Advanced topics
2.10. Organization Service TCK tests configuration
2.10.1. Maven pom.xml file configuration
2.10.2. Standalone container and Organization Service configuration
2.11. Tika Document Reader Service
2.11.1. Architecture
2.11.2. Configuration
2.11.3. Old-style DocumentReaders and Tika Parsers
2.11.4. TikaDocumentReader features and notes
2.12. Digest Authentication
2.12.1. Server configuration
2.12.2. OrganizationService implementation requirements
3. eXo Web Services
3.1. Introduction to the Representational State Transfer (REST)
3.2. Overwrite default providers
3.2.1. Motivation
3.2.2. Usage
3.2.3. Example
3.3. RestServicesList Service
3.3.1. Usage
3.4. Groovy Scripts as REST Services
3.4.1. Loading script and save it in JCR
3.4.2. Instantiation
3.4.3. Deploying newly created Class as RESTful service
3.4.4. Script Lifecycle Management
3.4.5. Getting node UUID example
3.4.6. Groovy script restrictions
3.5. Framework for cross-domain AJAX
3.5.1. Motivation
3.5.2. Scheme (how it works)
3.5.3. A Working Sequence:
3.5.4. How to use it
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.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.2.1. Poll Public APIs
3.2.2. Answer Public APIs
3.2.3. Forum Public APIs
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