Reference Guides

Copyright © 2009-2012 eXo Platform SAS

Abstract

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
I. eXoJCR
1. Introduction in eXoJCR
Data model
2. Why use JCR?
What is JCR?
Why use JCR?
What does eXo do?
Further Reading
3. eXo JCR Implementation
Related Documents
How it works
Workspace Data Model
4. Advantages of eXo JCR
Advantages for application developers
Advantages for managers
5. Compatibility Levels
Level 1
Level 2
Optional features
6. Using JCR
Obtaining a Repository object
JCR Session common considerations
JCR Application practices
Simplifying the management of a multi-workspace application
Reusing SessionProvider
7. JCR Service Extensions
Concept
Implementation
Configuration
Related Pages
8. eXo JCR Application Model
9. NodeType Registration
Interfaces and methods
ExtendedNodeTypeManager
NodeTypeValue
NodeDefinitionValue
PropertyDefinitionValue
ItemDefinitionValue
Node type registration
Run time registration from xml file.
Run time registration using NodeTypeValue.
Changing existing node type
Removing node type
Practical How to
Adding new PropertyDefinition
Adding new child NodeDefinition
Changing or removing existing PropertyDefinition or child NodeDefinition
Changing the list of super types
10. Registry Service
Concept
The API
Configuration
11. Namespace altering
Adding new namespace
Changing existing namespace
Removing existing namespace
12. Node Types and Namespaces
Node Types definition
Namespaces definition
13. eXo JCR configuration
Related documents
Portal and Standalone configuration
JCR Configuration
Repository service configuration (JCR repositories configuration)
Repository configuration:
Workspace configuration:
Workspace data container configuration:
Value Storage plugin configuration (for data container):
Initializer configuration (optional):
Cache configuration:
Query Handler configuration:
Lock Manager configuration:
Help application to prohibit the use of closed sessions
Getting the effective configuration at Runtime of all the repositories
14. Multi-language support in eXo JCR RDB backend
Oracle
DB2
MySQL
PostgreSQL
15. How to host several JCR instances on the same database instance?
LockManager configuration
HibernateService configuration
16. Search Configuration
XML Configuration
Configuration parameters
Global Search Index
Global Search Index Configuration
Customized Search Indexes and Analyzers
Creating the filter
Creating the analyzer
Creating the search index
Configuring your application to use your SearchIndex
Configure your application to use your Analyzer
Indexing Adjustments
IndexingConfiguration
Indexing rules
Node Scope Limit
Indexing Boost Value
Conditional Index Rules
Exclusion from the Node Scope Index
Indexing Aggregates
Property-Level Analyzers
Example
Characteristics of Node Scope Searches
Advanced features
17. JCR Configuration persister
Idea
Usage
18. JDBC Data Container Config
General recommendations for database configuration
DB2 configuration
MySQL configuration
PostgreSQL configuration
MS SQL configuration
Sybase configuration
Oracle configuration
Multi-database Configuration
Single-database configuration
Configuration without DataSource
Dynamic Workspace Creation
Simple and Complex queries
Forse Query Hints
Notes for Microsoft Windows users
19. External Value Storages
Tree File Value Storage
Simple File Value Storage
Content Addressable Value storage (CAS) support
Disabling value storage
20. Workspace Data Container
21. REST Services on Groovy
Usage
22. Configuring JBoss AS with eXo JCR in cluster
Launching Cluster
Deploying eXo JCR to JBoss As
Configuring JCR to use external configuration
Requirements
Environment requirements
Configuration requirements
How to stop the node properly
23. JBoss Cache configuration
JBoss cache configuration for indexer, lock manager and data container
JGroups configuration
Allow to share JBoss Cache instances
Shipped JBoss Cache configuration templates
Data container template
Lock manager template
Query handler (indexer) template
24. LockManager configuration
LockManagerImpl
CacheableLockManagerImpl
Configuration
Simple JbossCache Configuration
Template JBossCache Configuration
Data Types in Different Databases
Lock migration from 1.12.x
25. QueryHandler configuration
Indexing in clustered environment
Configuration
Query-handler configuration overview
Standalone strategy
Cluster-ready indexing strategies
Local Index Recovery Filters
JBoss-Cache template configuration
Asynchronous reindexing
On startup indexing
Hot Asynchronous Workspace Reindexing via JMX
Notices
Advanced tuning
Lucene tuning
26. JBossTransactionsService
Configuration
27. TransactionManagerLookup
28. Infinispan integration
Components configuration requirements
Workspaces configuration requirements
Shipped Infinispan Cache configuration templates
Data container template
Lock manager template
Query handler (indexer) template
29. RepositoryCreationService
Dependencies
How it works
Configuration
RepositoryCreationService Interface
Conclusions and restrictions
30. JCR Query Usecases
Query Lifecycle
Query Creation and Execution
Query Result Processing
Scoring
Query result settings
Type Constraints
Property Constraints
Path Constraint
Ordering specifing
Fulltext Search
Indexing rules and additional features
Query Examples
SetOffset and SetLimit
Common info
Repository structure
Query execution
Fetching result
Finding All Nodes
Repository structure:
Query execution
Fetching result
Finding Nodes by Primary Type
Repository structure:
Query execution
Fetching result
Finding Nodes by Mixin Type
Repository structure:
Query execution
Fetching result
Property Comparison
Repository structure:
Query execution
Fetching result
LIKE Constraint
Repository structure:
Query execution
Fetching result
Escaping in LIKE Statements
Repository structure
Query execution
Fetching result
NOT Constraint
Repository Structure
Query execution
Fetching the result
AND Constraint
Repository Structure:
Query execution
Fetching the Result
OR Constraint
Repository Structure
Query Execution
Fetching the Result
Property Existence Constraint
Repository Structure
Query Execution
Fetching the Result
Finding Nodes in a Case-Insensitive Way
Repository Structure
Query Execution
Fetching the Result
Date Property Comparison
Repository Structure
Query Execution
Fetching the result
Node Name Constraint
Repository Structure
Query execution
Fetching the Result
Multivalue Property Comparison
Repository Structure
Query Execution
Fetching the Result
Exact Path Constraint
Repository Structure
Query Execution
Fetching the Result
Child Node Constraint
Repository Structure
Query Execution
Fetching the Result
Finding All Descendant Nodes
Repository Structure
Query Execution
Fetching the Result
Sorting Nodes by Property
Repository Structure
Query Execution
Fetching the Result
Ordering by Descendant Nodes Property (XPath only)
Repository structure:
Query Execution
Fetching the Result
Ordering by Score
Info
Repository Structure
Query Execution
Fetching the Result
Ordering by Path or Name
Fulltext Search by Property
Repository Structure
Query Execution
Fetching the Result
Fulltext Search by All Properties in Node
Repository structure:
Query execution
Fetching result
Ignoring Accent Symbols. New Analyzer Setting.
Repository structure:
Query execution
Fetching result
Finding nt:file node by content of child jcr:content node
Repository structure:
Query execution
Fetching the result
Changing Priority of Node
Indexing configuration
Repository structure:
Query execution
Fetching result
Removing Nodes Property From Indexing Scope
Repository structure:
Query execution
Fetching result
Regular Expression as Property Name in Indexing Rules
Repository structure:
Query execution
Fetching result
High-lighting Result of Fulltext Search
Base info
Repository structure:
Query execution
Fetching result
Searching By Synonim
Repository structure:
Query execution
Fetching result
Checking the spelling of Phrase
Repository structure:
Query execution
Fetching result
Finding Similar Nodes
Repository structure:
Query execution
Fetching result
Tips and tricks
XPath queries containing node names starting with a number
31. Searching Repository Content
Bi-directional RangeIterator (since 1.9)
Fuzzy Searches (since 1.0)
SynonymSearch (since 1.9)
High-lighting (Since 1.9)
DefaultXMLExcerpt
DefaultHTMLExcerpt
How to use it
SpellChecker
How do I use it?
Similarity (Since 1.12)
32. Fulltext Search And Affecting Settings
Property content indexing
Lucene Analyzers
How are different properties indexed?
Fulltext search query examples
Different analyzers in action
33. JCR API Extensions
API and usage
Configuration
Implementation notices
34. WebDAV
Configuration
Screenshots
MS Internet Explorer
Dav Explorer
Xythos Drive
Microsoft Office 2003
Ubuntu Linux
Comparison table of WebDav and JCR commands
Restrictions
Windows 7
Microsoft Office 2010
35. FTP
Configuration Parameters
command-port:
data-min-port & data-max-port
system
client-side-encoding
def-folder-node-type
def-file-node-type
def-file-mime-type
cache-folder-name
upload-speed-limit
download-speed-limit
timeout
36. eXo JCR Backup Service
Concept
How it works
Implementation details
Work basics
Configuration
RDBMS backup
Usage
Performing a Backup
Performing a Restore
Restoring into an existing workspace
System workspace
Repository and Workspace initialization from backup
Restore the Workspace over BackupWorksaceInitializer
Restore the Repository over BackupWorksaceInitializer
Scheduling (experimental)
Restore existing workspace or repository
Restore a workspace or a repository using original configuration
Backup set portability
37. HTTPBackupAgent and backup client
HTTPBackupAgent
HTTPBackupAgent methods
Starting Backup Service
Stopping Backup Service
Backup Info Service
Dropping Workspace Service
Backup Info
Current Backups Information
Completed Backups Information
Workspace-specific Backup Information
Single Backup Information
Restores on a Workspace Information
Restores Information
Restoring Service
Default Workspace Information
HTTPBackupAgent Configuration
Backup Client
Backup Client Usage
Building application
Running application
Getting information about backup service
Starting full backup
Starting full and incremental backup on a single workspace
Getting information about the current backups (in progress)
Getting information about the current backup by 'backup_id'
Stopping backup by "backup_id"
Getting information about the completed (ready to restore) backups
Restoring to workspace
Getting information about the current restore
Restoring workspace and remove exists workspace
Restoring workspace from backup set
Restoring workspace from backup set and remove exists workspace
Restoring workspace with original configuation
Restoring workspace with original configuation and remove exists workspace
Restoring workspace from backup set with original configuation
Restoring workspace from backup set with original configuation and remove exists workspace
Restoring repository
Restoring repository and remove exists repository
Restoring repository from backup set
Restoring repository from backup set and remove exists repository
Restoring repository with original configuation
Restoring repository with original configuation and remove exists repository
Restoring repository from backup set with original configuation
Restoring repository from backup set with original configuation and remove exists repository
Full example about creating backup and restoring it for workspace 'backup'
Creating backup
Getting information about current backups
Stopping backup by id
Deleting the workspace "backup" and close opened sessions on this workspace
Restoring the workspace "backup"
Getting information about restore for workspace /repository/backup
Full example about creating backup and restoring it for repository 'repository'
Creating backup
Getting information about current backups
Stopping backup by id
Deleting the repository "repository" and close all opened sessions
Restoring the repository "repository"
Getting information about restore for repository 'repository'
38.
Repository suspending
Backup
Repository resuming
39. eXo JCR statistics
Statistics on the Database Access Layer
Statistics on the JCR API accesses
Statistics Manager
40. Checking repository integrity and consistency
Recommendations on how to fix corrupted JCR
41. JTA
42. The JCA Resource Adapter
The SessionFactory
Configuration
Deployment
43. Access Control
Standard Action Permissions
eXo Access Control
Principal and Identity
ACL
Privilegeable
Ownable
ACL Inheritance
Default ACL of the root node
Notes
Example
XML Example
Inheritance Examples
Permission validation
Java API
44. Access Control Extension
Prerequisites
Access Context Action
The Invocation Context
Custom Extended Access Manager
Example of a custom Access Manager
45. Link Producer Service
46. Binary Values Processing
Configuration
Usage
Value implementations
47. JCR Resources:
48. JCR Workspace Data Container (architecture contract)
Concepts
Container and connection
Value storages
Lifecycle
Value storage lifecycle
Requirements
Read operations
Write operations
State operations
Validation of write operations
Consistency of save
Value storages API
Storages provider:
Value storage plugin
Value I/O channel
Transaction support via channel
49. How-to implement Workspace Data Container
Notes on Value storage usage:
50. DBCleanService
Methods of DBCleanerService
Need to clean only single workspace
Need to clean the whole repository
51. JCR Performance Tuning Guide
JCR Performance and Scalability
Cluster configuration
JCR Clustered Performance
Performance Tuning Guide
JBoss AS Tuning
JCR Cache Tuning
Clustering
JVM parameters
II. eXoKernel
52. ExoContainer info
Container hierarchy
53. Service Configuration for Beginners
Requirements
Services
Configuration File
Execution Modes
Containers
Configuration Retrieval
RootContainer
PortalContainer
StandaloneContainer
Service instantiation
Miscellaneous
Startable interface
Inversion of Control
More Containers
Single Implementation Services
Configuration properties
Configuration Logging
Further Reading
54. Service Configuration in Detail
Requirements
Sample Service
Java Class
First configuration file
Init Parameters
Service Access
Parameters
Value-Param
Properties-Param
Object-Param
Collection
External Plugin
Import
System properties
Understanding the prefixes supported by the configuration manager
55. Container Configuration
Kernel configuration namespace
Understanding how configuration files are loaded
Configuration Retrieval
Configuration retrieval order for the PortalContainer
Configuration retrieval for a StandaloneContainer
General notes about the configuration retrieval
Configuration retrieval log
Getting the effective configuration at Runtime
Advanced concepts for the PortalContainers
Add new configuration files from a WAR file
Creating your PortalContainers from a WAR file
Defining a PortalContainer with its dependencies and its settings
PortalContainer settings
Adding dynamically settings and/or dependencies to a PortalContainer
The existing implementations of PortalContainerDefinitionChange
AddDependencies
AddDependenciesBefore
AddDependenciesAfter
AddSettings
Disable dynamically a portal container
System property configuration
Properties init param
Properties URL init param
System Property configuration of the properties URL
Variable Syntaxes
Runtime configuration profiles
Profiles activation
Profiles configuration
Profiles definition
Profiles capable configuration elements
Component element
Component plugin element
Import element
Init param element
Value collection element
Field configuration element
Component request life cycle
Component request life cycle contract
Request life cycle
Scheduling a component request life cycle
Scheduling a container request life cycle
When request life cycle is triggered
Portal request life cycle
JMX request Life Cycle
56. Inversion Of Control
How
Injection
Side effects
57. Services Wiring
Portal Instance
Introduction to the XML schema of the configuration.xml file
Configuration retrieval and log of this retrieval
58. Component Plugin Priority
59. Understanding the ListenerService
What is the ListenerService ?
How does it work?
Registering a listener
Triggering an event
How to configure a listener?
Concrete Example
60. Initial Context Binder
API
61. Job Scheduler Service
Where is Job Scheduler Service used in eXo Products?
How does Job Scheduler work?
How can Job Scheduler Service be used in Kernel?
Samples
Define a job
Job configuration
Run the project
Reference
62. eXo Cache
Basic concepts
Advanced concepts
Invalidation
FutureExoCache
eXo Cache extension
eXo Cache based on JBoss Cache
Configuring the ExoCacheFactory
Adding specific configuration for a cache
Adding a cache creator
Understanding a cache creator
Registering a cache creator
The cache creators available
LRU Cache Creator - Least Recently Used
FIFO Cache Creator - First In, First Out
MRU Cache Creator - Most Recently Used
LFU Cache Creator - Least Frequently Used
EA Cache Creator - Expiration Algorithm
Defining a cache
How to define a cache?
At CacheService initialization
With an "external plugin"
How to define a distributed or a local cache?
How to share a JBoss Cache instance between multiple eXo Cache instances
LRU Cache - Least Recently Used
FIFO Cache - First In, First Out
MRU Cache - Most Recently Used
LFU Cache - Least Frequently Used
EA Cache - Expiration Algorithm
eXo Cache based on Infinispan
Configure the ExoCacheFactory
Add specific configuration for a cache
Add a cache creator
Understanding a cache creator
Register a cache creator
The cache creators available
Generic Cache Creator
Define an infinispan cache instance
How to define a replicated, a distributed or a local cache?
How to define an infinispan cache instance
Using Infinispan in distributed mode
Configuration of the DistributedCacheManager
Launch a CacheServer
Configure the cache of your workspace
63. TransactionService
Existing TransactionService implementations
JOTM in standalone mode
Generic TransactionService based on the TransactionManagerLookup of JBoss Cache
Specific GenericTransactionService for JBoss Cache and Arjuna
Generic TransactionService based on the TransactionManagerLookup of Infinispan
Specific GenericTransactionService for Infinispan and Arjuna
A very specific TransactionService for JBoss AS
TransactionsEssentials in standalone mode
64. The data source provider
Configuration
65. JNDI naming
Prerequisites
How it works
JNDI System property initialization
JNDI reference binding
Configuration examples
Recommendations for Application Developers
InitialContextInitializer API
66. Logs configuration
Logs configuration initializer
Configuration examples
Log4J
Assigning logger level for classes or components
JDK Logging
Commons Logging SimpleLogss
Tips and Troubleshooting
JBoss tips
Other tips
67. Manageability
Managed framework API
Annotations
@org.exoplatform.management.annotations.Managed annotation
@org.exoplatform.management.annotations.ManagedDescription
@org.exoplatform.management.annotations.ManagedName
@org.exoplatform.management.annotations.ManagedBy
JMX Management View
JMX Annotations
@org.exoplatform.management.jmx.annotations.Property annotation
@org.exoplatform.management.jmx.annotations.NameTemplate annotation
@org.exoplatform.management.jmx.annotations.NamingContext annotation
Example
CacheService example
68. ListenerService
69. RPC Service
Configuration
The SingleMethodCallCommand
III. eXoCore
70. Database Creator
API
A configuration examples
An examples of a DDL script
71. Security Service
Framework
ConversationState and ConversationRegistry
Authenticator
Usage
JAAS login module
Predefinded JAAS login modules
J2EE container authentication
72. Spring Security Integration
Installation
Configuration
JAAS disabling
Enabling spring security
security-context.xml
Login portlet example
Building the portlet
Setting up the login portal page
Customization of portal login and logout urls
A look at the login page
Integration strategies
Direct integration
Replication
Integration with eXo portal
Security context propagation to portlets
Portal side filter
Portlet side filter
Conclusion
73. Organization Service
Organizational Model
User
Group
Membership
Custom Organization Service implementation instructions
Basic entities implementation
Unit handlers implementation
Extending BaseOrganizationService class
Verification of compliance
Related articles and how-tos
74. Organization Service Initializer
75. Organization Listener
Writing your own listeners
UserEventListener
GroupEventListener
MembershipEventListener
Registering your listeners
76. Update ConversationState when user's Membership changed
77. DB Schema creator service (JDBC implementation)
78. Database Configuration for Hibernate
Generic configuration
Example DB configuration
Registering custom Hibernate XML files into the service
79. LDAP Configuration
Quickstart
Configuration
Connection Settings
Organization Service Configuration
Users
Main parameters
User mapping
Groups
Membership Types
Memberships
User Profiles
Advanced topics
Automatic directory population
Active Directory sample configuration
OpenLDAP dynlist overlays
80. Organization Service TCK tests configuration
Maven pom.xml file configuration
Standalone container and Organization Service configuration
81. Tika Document Reader Service
Architecture
Configuration
Old-style DocumentReaders and Tika Parsers
How to make and register own DocumentReader
TikaDocumentReader features and notes
82. Digest Authentication
Server configuration
Tomcat Server configuration
Jetty server configuration
JBoss server configuration
OrganizationService implementation requirements
IV. eXoWS
83. Introduction to the Representational State Transfer (REST)
84. Overwrite default providers
Motivation
Usage
Example
85. RestServicesList Service
Usage
HTML format
JSON format
86. Groovy Scripts as REST Services
Loading script and save it in JCR
Instantiation
Deploying newly created Class as RESTful service
Script Lifecycle Management
Getting node UUID example
Groovy script restrictions
87. Framework for cross-domain AJAX
Motivation
Scheme (how it works)
A Working Sequence:
How to use it
V. Frequently Asked Question
88. JCR FAQ
Kernel
What is the best, standardized way to get the instance of a service ?
JCR
JCR core
Is it better to use Session.getNodeByUUID or Session.getItem?
Does it make sense to have all the node referencable to use getNodeByUUID all the time?
What should I use to check if an Item exists before getting the Value?
How to use Observation properly?
Is it better to use queries that to access the data by the JCR API?
What is default query ordering?
Is ordering by jcr:path or Item name supported?
How eXo JCR indexer uses content encoding?
Which database server is better for eXo JCR?
How to setup eXo JCR for mutilingial content on MySQL?
Does MySQL have limitation affecting on eXo JCR features?
Does use of Sybase database need special options in eXo JCR configuration?
How to open and close a session properly to avoid memory leaks?
Can I use Session after loging out?
How to configure jcr for cluster ?
How to use lucene spellchecker?
How can I affect to spellchecker results?
JCR extensions
How to restore repository to existing repository ?
How to restore workspace to existing worksapce?
Does JCR support hot backup?
WebDAV
I uploaded a file to WebDAV server using Mac OS Finder, but the file size is '0', what is wrong ?
Can I manage 'cache-control' value for different media-types from server configuration ?
How to perform WebDAV requests using curl ?
How eXo JCR WebDAV server treats content encoding?
VI. eXo JCR with GateIn
89. How to extend my GateIn instance?
Motivations
Prerequisites
Removing all the hard coded portal container name (i.e. "portal")
Removing all the hard coded rest context name (i.e. "rest")
Removing all the hard coded realm name (i.e. "exo-domain")
Making your Http Filters compatible
Making your HttpServlets compatible
Making your HttpSessionListeners compatible
Use init tasks if you need a PortalContainer to initialize an Http Filter or an HttpServlet
Making your LoginModules compatible
Avoiding static modifier on component dependency
Avoid component initialization based on component dependency in the constructor
FAQ
What has changed since the previous versions?
What is the main purpose of a portal extension?
What is the main purpose of the starter?
How a portal and a portal container are related?
How to define and register a PortalContainerDefinition?
How the platform interprets the dependency order defined into the PortalContainerDefinition?
How to change the ServletContext name, the realm name and/or the rest context name of my portal without using a PortalContainerDefinition?
On JBoss (tested on JBoss 5.1.0.GA)
On Tomcat (tested on Tomcat 6.0.20)
How to add new configuration file to a given portal from a war file?
How to create/define a portal extension?
How to deploy a portal extension?
How to create/define a new portal?
How to deploy a new portal?
How to import properly a configuration file using the prefix "war:"?
How to avoid duplicating configuration files just to rename a simple value?
How to add or change a Repository and/or a Workspace?
How to add new ResourceBundles to my portal?
How to overwrite existing ResourceBundles in my portal?
How to replace a groovy template of my portal?
How to add new Portal Configurations, Navigations, Pages or Portlet Preferences to my portal?
How to add new Http Filters to my portal without modifying the portal binary?
How to add new HttpSessionListeners and/or ServletContextListeners to my portal without modifying the portal binary?
How to add new HttpServlet to my portal without modifying the portal binary?
How to override or add a Context Parameter to my portal without modifying the portal binary?
Where can I found an example of how to extend my portal?
How to deploy the sample extension?
On JBoss (tested on JBoss 5.1.0.GA)
On Tomcat (tested on Tomcat 6.0.20)
Where can I find an example of how to create a new portal?
How to deploy the sample portal?
On JBoss (tested on JBoss 5.1.0.GA)
On Tomcat (tested on Tomcat 6.0.20)
I get "java.lang.IllegalStateException: No pre init tasks can be added to the portal container 'portal', because it has already been initialized." what can I do to fix it?
Recommendations
Don't ship your configuration files with your jar files?
Using a dedicated workspace/repository for your extension?
90. How to use AS Managed DataSource under JBoss AS
Declaring the datasources in the AS
Do not let eXo bind datasources explicitly
Reference Guide / GateIn
1. Introduction
Related Links
2. Configuration
Database Configuration
Overview
Configure the database for JCR
Configure the database for the default identity store
Email Service Configuration
Overview
Configure the outgoing e-mail account
3. Portal Development
Skin the portal
Overview
Skin Components
Skin Selection
Skin Selection Through the User Interface
Setting the Default Skin within the Configuration Files
Skins in Page Markups
The Skin Service
Skin configuration
Resource Request Filter
The Default Skin
Create New Skins
Creating a New Portal Skin
Portal Skin Configuration
Portal Skin Preview Icon
Creating a New Window Style
Window Style Configuration
Window Style CSS
How to Set the Default Window Style
How to Create New Portlet skins
Change portlet icons
How to create a new Portlet Specification CSS Classes
Tips and Tricks
Easier CSS debugging
Some CSS techniques
Decorator pattern
Left margin left pattern
Portal Lifecycle
Overview
Application Server start and stop
The Command Servlet
Default Portal Configuration
Overview
Configuration
Tips
Delete Portals Definition by Configuration
Set the info bar shown by default for portlet
Portal Default Permission Configuration
Overview
Overwrite Portal Default Permissions
Portal Navigation Configuration
Overview
Portal Navigation
Group Navigation
User Navigation
Data Import Strategy
Introduction
Import Mode
Data Import Strategy
Navigation Data
Portal Config
Page Data
Internationalization Configuration
Overview
Locales configuration
ResourceBundleService
Navigation Resource Bundles
Portlets
Standard portlet resource keys
Debugging resource bundle usage
Translate the language selection form
RTL (Right To Left) Framework
Groovy templates
Stylesheet
Images
Client side JavaScript
XML Resources Bundles
Motivation
XML format
Portal support
JavaScript Inter Application Communication
Overview
Library
Syntax
Example of Javascript events usage
Upload Component
Upload Service
Deactivation of the Ajax Loading Mask Layer
Purpose
Synchronous issue
JavaScript Configuration
Navigation Controller
Description
Controller in Action
Controller
Building controller
Controller Configuration (controller.xml)
Route parameters
Path parameters - Regular expression support
Request parameters
Route precedence
Route nesting
Integrate to GateIn WebUI framework
Routing
Rendering
PortalURL
NodeURL
ComponentURL
Portlet URLs
Webui URLBuilder
Groovy Templates
Changes and migration from GateIn 3.1.x
Migration of navigation node URL
Security changes
Default handler
Legacy handler
Static resource handler
portal.war's web.xml changes
Dashboard changes
Remove unused files
4. Portlet development
Portlet Primer
JSR-168 and JSR-286 overview
Portal Pages
Rendering Modes
Window States
Tutorials
Deploying your first Portlet
Compiling
Package Structure
Portlet Class
Application Descriptors
JavaServer Pages Portlet Example
Package Structure
Portlet Class
JSP files and the Portlet Tag Library
JSF example using the JBoss Portlet Bridge
Global porlet.xml file
Global portlet.xml usecase
Global metadata
Location
Global metadata elements
Portlet filter
Portlet Mode and Window State
5. Gadget development
Gadgets
Existing Gadgets
Create a new Gadget
Remote Gadget
Gadget Importing
Gadget Web Editing
Gadget IDE Editing
Dashboard Viewing
Set up a Gadget Server
Virtual servers for gadget rendering
Configuration
Security key
Gadget proxy and concat configuration
Proxy
6. Authentication and Identity
Predefined User Configuration
Overview
Plugin for adding users, groups and membership types
Membership types
Groups
Users
Plugin for monitoring user creation
Authentication Token Configuration
What is Token Service?
Implement the Token Service API
Configure token services
PicketLink IDM integration
Configuration files
Organization API
Access User Profile
Single-Sign-On (SSO)
Overview
Prerequisites
Central Authentication Service (CAS)
CAS server
Obtaining CAS
Modifying the CAS server
Set up the CAS client
Redirect to CAS
JOSSO
JOSSO server
Obtaining JOSSO
Modifying the JOSSO server
Set up the JOSSO client
Set up the portal to redirect to JOSSO
OpenSSO - The Open Web SSO project
OpenSSO server
Obtaining OpenSSO
Modifying the OpenSSO server
Set up the OpenSSO client.
Set up the portal to redirect to OpenSSO
SPNEGO
SPNEGO Server Configuration
Clients
GateIn 3.2 Configuration
7. Web Services for Remote Portlets (WSRP)
Level of support in GateIn 3.2
Deploy GateIn's WSRP services
WSRP use when running GateIn on a non-default port or hostname
Considerations to use WSRP with SSL
Make a portlet remotable
Consume GateIn's WSRP portlets from a remote Consumer
Consume remote WSRP portlets in GateIn
Overview
Configure a remote producer walk-through
Using the configuration portlet
Using XML
Adding remote portlets to categories
Configure access to remote producers via XML
Required configuration information
Optional configuration
Examples
Consumers maintenance
Modify a currently held registration
Registration modification for service upgrade
Registration modification on producer error
Consumer operations
Import and export portlets
Erase local registration data
Configure GateIn's WSRP Producer
Overview
Default configuration
Registration configuration
Customization of Registration handling behavior
WSRP validation mode
WSRP integration configuration
Extended Navigation
WSRP integration
8. Advanced Development
Foundations
GateIn Kernel
Configure services
Configuration syntax
Components
External Plugins
Includes, and special URLs
Special variables
InitParams configuration object
Configure a portal container
GateIn Extension Mechanism and Portal Extensions
Run Multiple Portals
Reference Guide / Content Functions
1. Preface
Get Started with eXo Content
Package
2. Applications
Portlets
Content Detail
Content List
Search
Sites Explorer
Administration
Fast Content Creator
Form Builder
Authoring
Newsletter
SEO portlet
3. Configuration
Components
ActionServiceContainer
ApplicationTemplateManagerService
FragmentCacheService
JodConverterService
LiveLinkManagerService
LockService
NewsletterInitializationService
NewsletterManagerService
SiteSearchService
SEOService
QueryService
TaxonomyService
ThumbnailService
TimelineService
WatchDocumentService
WCMService
External Component Plugins
AuthoringPublicationPlugin
BaseActionPlugin
BPActionPlugin
ContentTypeFilterPlugin
ContextPlugin
CreatePortalPlugin
ExcludeIncludeDataTypePlugin
FriendlyPlugin
ImageThumbnailPlugin
IgnorePortalPlugin
InitialWebcontentPlugin
LinkDeploymentPlugin
LockGroupsOrUsersPlugin
ManageDrivePlugin
ManageViewPlugin
PDFThumbnailPlugin
PorletTemplatePlugin
PredefinedProcessesPlugin
PublicationPlugin
QueryPlugin
RemovePortalPlugin
RemoveTaxonomyPlugin
ScriptActionPlugin
ScriptPlugin
StageAndVersionPublicationPlugin
StatesLifecyclePlugin
TagPermissionPlugin
TagStylePlugin
TaxonomyPlugin
TemplatePlugin
XMLdeploymentPlugin
4. Developer references
WCM Templates
Content types
Dialog
Common parameters
Text Field
Hidden Field
Text Area Field
Rich Text Field
Calendar Field
Upload Field
Radio Field
Select box Field
Checkbox Field
Mixin Field
Action Field
Interceptors
How to add a new ECM template with tabs
How to prevent XSS attacks
View
List of Contents
Content List Template
Category Navigation Template
WCM Explorer
CSS
CKEditor
Extensions
REST Services
Overview
Restful Web Service
HTTP Methods
Formats
Data Format
REST configuration
Create a REST service
UI Extensions
Overview
How to add your own tab in ECM Administration
Add your own UIAction
Add your own ActionListener
Register your UI Action
Run your own UI extension sample
Authoring Extension
Extended Publication Plugin
States
Start/End publication dates
New Publication Mixin
Publication Manager
Lifecycle
Listen to a lifecycle
Perform tasks when a content's state is updated
Context
New Authoring Mixin
Public REST APIs
ThumbnailRESTService
RssConnector
FCKCoreRESTConnector
ResourceBundleConnector
VoteConnector
DriverConnector
GadgetConnector
PortalLinkConnector
GetEditedDocumentRESTService
PublicationGetDocumentRESTService
FavoriteRESTService
RESTImagesRendererService
LifecycleConnector
CopyContentFile
PDFViewerRESTService
ManageDocumentService
DownloadConnector
Public Java APIs
TaxonomyService
LinkManager
PublicationManager
WCMComposer
NewFolksonomy
ApplicationTemplateManager
NodeFinder
JodConverter
TimelineService
SiteSearchService
SEOService
Deprecated portlets
FAQ
How to deploy a workflow?
Deploy a workflow inside a .war file
Deploy a workflow inside a .jar file
Reference Guide / CMIS Developer
1. Introduction
About CMIS
About xCMIS
About eXo CMIS
2. CMIS specification
3. xCMIS project
4. CMIS features
Integration with eXo WCM
JCR namespaces and nodetypes
WCM drives as CMIS Repositories
Use Case: Browse Drives via getRepository
WCM Symlinks
Use Case: Follow Symlinks
Modify WCM via CMIS
CMIS search
Query examples
Simple query
Find document by several constraints
Full-text search
Extended full-text search
Date property comparison
Boolean property comparison
IN Constraint
Select all documents where longprop property is not in set
Select all documents where longprop property is not in set
IN_FOLDER constraint
Select all documents that are in a specified folder
Select all documents where query supertype is cmis:article
IN_TREE constraint
LIKE Comparison
Test LIKE constraint with escape symbols
NOT constraint
Property existence
ORDER BY
ORDER BY ASC
ORDER BY DESC
ORDER BY SCORE (as columns)
Not equal comparison (decimal)
Not equal comparison (string)
More than comparison (>)
CMIS Domain Model
CMIS Services
5. CMIS Usage code examples
Login to repository
Use java
List of documents (folder, files)
Use Java
Use JavaScript
Read document properties and content-stream
Use Java
Use JavaScript
Search of data and syntax examples
Use java
Use JavaScript
Modification of document properties or content
Use java
Use JavaScript
6. References
Reference Guide / CMIS Administrator
1. Introduction
CMIS Specification
xCMIS project
eXo CMIS
2. Configuration
CMIS Configuration
Required nodetypes and namespaces in JCR
Authenticator and organization service configuration
CMIS search and index
CMIS Relational View
Query Capabilities
Configuration
Index atomicity and durability
3. Service JARs
4. Miscellaneous and Tips
5. Links
Reference Guide / Collaboration Functions
1. Prerequisites
2. Applications
Portlets
Calendar portlet
Description
Portlet.xml
Chatbar portlet
Description
Portlet preferences
Portlet.xml
Chat Portlet
Description
Portlet.xml
Contact Portlet
Description
Portlet.xml
Mail Portlet
Description
Portlet.xml
RSSreader Portlet
Description
Portlet.xml
Gadgets
Eventslist
Description
Links to used REST services
Taskslist
Description
Links to used REST services
Messageslist
Description
Links to used REST services
3. Configurations
Components in eXo Collaboration Configuration
CalendarService
HistoryImpl
XMPPMessenger
DefaultPresenceStatus
ContactService
External Component Plugins
Calendar Configuration
NewUserListener
NewGroupListener
NewMembershipListener
ReminderPeriodJob
PopupReminderPeriodJob
AddActionsPlugin
Chat Configuration
HistoryPeriodJob
RequestFilterComponentPlugin
AuthenticationLoginListener and AuthenticationLogoutListener
AuthenticationLoginListener
AuthenticationLogoutListener
Contact Configuration
NewUserListener
NewMembershipListener
UpdateUserProfileListener
Content Configuration
RSSContentPluginDescriptionPlugin
DescriptionPlugin
Mail Configuration
AuthenticationLogoutListener
MailSettingConfigPlugin
Social Integration Configuration
CalendarDataInitialize
ContactDataInitialize
ContactSpaceActivityPublisher
CalendarSpaceActivityPublisher
PortletPreferenceRequiredPlugin
Data Injectors
ContactDataInjector
CalendarDataInjector
MailDataInjector
Usage of MailDataInjector
eXo Chatserver Configuration
Openfire Configuration
Configuration in Openfire.xml
eXo specific configuration
System Configuration
AS configuration
4. JCR Structure
Calendar JCR Structure
calendars
eventCategories
categories
eXoCalendarFeed
Y%yyyy%
calendarSetting
Chat JCR Structure
Address Book JCR Structure
Contacts
ContactGroup
tags
Shared
Mail JCR Structure
RSS JCR Structure
5. Developer reference
Extension points
ContentDAO
ContactLifeCycle
Transport
EventLifeCycle
Public REST APIs
Calendar application
Mail application
Chat application
RESTXMPPService
FileExchangeService
Reference Guide / Knowledge Functions
1. Prerequisites
2. Applications
Portlets
Forum Portlet
Overview
Portlet.xml
Preferences
Events
ForumLinkEvent
ReLoadPortletEvent
OpenLink
ForumPollEvent
ForumModerateEvent
ForumRuleEvent
QuickReplyEvent
Answers Portlet
Overview
Portlet.xml
Portlet Preferences
FAQ Portlet
Overview
Portlet.xml
Portlet Preferences
Polls Portlet
Overview
Portlet.xml
Portlet Preferences
Gadgets
Overview
Preferences
Links to used REST services
3. Configuration
Components
Components of eXo Knowledge
Components of Forum
Components of Answers
Components of Polls
External-component-plugin
Init data configuration
Init data
Configuration
Initialize the conf-part for loading repository-configuration.xml
Initialize workspace name and repository name in storage-configuration.xml
Initialize data
Roles Configuration
Overview
Configuration
ProfileProvider Configuration
Overview
Configuration
Use ContactProvider
By DefaultContactProvider
By SocialContactProvider
Forum Configuration
BBCode Configuration
Overview
Configuration
Default BBCode data
Forums Initializer
Overview
Configuration
Default forum data
Forum array
Forum topics
Initial Data Plugin
Auto-prune
Overview
Configuration
User Statistics
Overview
Configuration
Update Statistic Data
Overview
Configuration
Default User Profile
Overview
Configuration
Answer Configuration
Answers Initializer
Overview
Configuration
Answers Email Templates Configuration
Overview
Configuration
Poll Configuration
Overview
Configuration
Default Poll data
Data Injector Servive
Technical details
Configuration
ForumDataInjector
Wiki Data injector
AnswerDataInjector
How to use?
4. JCR structure
Forum JCR structure
Forum System
User Profile and User Profile Home
Statistic and Statistic Home
Ban IP and Ban IP Home
Administration and Administration Home
Forum Data
Category and Category home
Forum
Topic
Post
Tag and Tag home
BBCode and BBCode home
Topic type and Topic type home
FAQ JCR structure
Category
Sub-category
RSS
Question and Question Home
Multilanguages
Answer, Comment and Attachment
FAQ setting
Template for FAQ
Poll JCR structure
Wiki JCR structure
Wiki data
WikiHome
Preferences
LinkRegistry
Trash
Template Container
Wiki metadata
5. Developer reference
Extension points
ForumEventLifeCycle
Overview
Configuration plug-in
Tutorial
AnswerEventLifeCycle
Overview
Configuration plug-in
Tutorial
BBCodeRenderer
Internal API
Forum application
Answers application
Polls application
FAQ Template Configuration
Configuration plug-in
How to change look and feel
Plug-in
Edit Mode
API provided by the UIComponent (UIViewer.java)
Extend actions over a wiki page from external jars
Overview
How to add action extension to the Wiki toolbar
Create a new project for action extension
Create new actions and their corresponding listeners
Register new actions with UIExtensionManager
Deploy new action extension
Reference Guide / Social Functions
1. Applications
List of Portlets in Social
List of Gadgets in Social
Activity Stream
Social RSS Reader
My Connections
My Spaces
2. Configuration
Component
SpaceService
LifeCycleCompletionService
IdentityManager
ServiceProviderStore
RelationshipManager
SpaceIdentityProvider
SpaceApplicationHandler
ExoPeopleService
RestPortalContainerNameConfig
LinkProvider
External Component Plugin
ActivityResourceBundlePlugin
IdentityProviderPlugin
MentionsProcessor
OSHtmlSanitizerProcessor
PortletPreferenceRequiredPlugin
SpaceApplicationConfigPlugin
SocialChromatticLifeCycle
TemplateParamsProcessor
URLConverterFilterPlugin
RestPortalContainerNameConfig
3. Developers References
UI Extensions
About Activity Plugin
How to create activity plugin
Create a custom UI component for displaying the activity based on its type
What is ActivityBuilder?
Create a composer extension for composing activity on the UI composer and display it on the activity stream
Overridable Components
Public Java APIs
ActivityManager
IdentityManager
RelationshipManager
SpaceService
Java APIs sample code/ tutorial
Activity Stream
Publish an activity
Publish an activity for a user
Publish an activity for a space
Configure an activity processor
Publish an RSS feed with feedmash
Sample Code
OpenSocial
Gadget
Supported APIs
REST/RPC API
Configure the security
Publish an activity into a space
Tutorial
People
Identity
IdentityProvider
IdentityManager
ProfileListener
Connections
Users connection
RelationshipListener
Spaces
Spaces Management
Space's applications management
Add an application to a space
Remove an application from a space
Space's members management
Listener to a space lifecycle
Space widget tutorial
Basic version
Advanced version
Configure
How to extend the activities rendering
Objective
Requirements
Why would you need to do this?
Write an ActivityProcessor
Configure the processor
XMLProcessor component
Objectives
XMLProccessor Component
Built-in XMLProcessor Plugins
How to create internationalized activities
Objective
Internationalize an activity
Get an internationalized message
Public REST APIs
Activities REST service
Apps REST service
Identity REST service
Linkshare REST service
People Rest Service
Spaces REST service
Widget Rest Service
Location
Rest Service APIs
Activity Resources
GET activity/activityId.format
POST activity.format
DELETE activity/activityId.format
POST activity/destroy/activityId.format
GET activity/activityId/comments.format
POST activity/activityId/comment.format
DELETE activity/activityId/comment/commentId.format
POST activity/activityId/comment/destroy/commentId.format
GET activity/activityId/likes.format
POST activity/activityId/like.format
DELETE activity/activityId/like.format
POST activity/activityId/like/destroy.format
Activity Stream Resources
GET identityId.format
GET feed.format
GET spaces.format
GET connections.format
Identity Resources
GET identityId.format
GET providerId/remoteId.format
Version Resources
GET latest.format
GET supported.format
Public Javascript APIs
Social JCR Structure
Overview
soc:providers
soc:<providername>
Identity
Relationship
Profile
Profile experience
Activity list
Activity year
Activity month
Activity day
Activity
Activity parameters
Space list
Space
Spaces Template configuration
Configure the oauth 2 legged scenario
Generate the certificates
Configure the property file
Copyright © 2009-2012. All rights reserved. eXo Platform SAS