JBoss.orgCommunity Documentation

Next

Reference Guides

Copyright © 2009-2012

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 / Content Functions

About this guide

About Content Package

1. Applications

Content Detail
Content List
Search
Sites Explorer
Administration
Fast Content Creator
Form Builder
Authoring
Newsletter
SEO portlet

CMIS specification

xCMIS project

CMIS features

Integration with eXo WCM

JCR namespaces and nodetypes

WCM drives as CMIS Repositories

Use Case: Browse Drives via getRepository

WCM 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

Service JARs

3. Configuration

ActionServiceContainer
ApplicationTemplateManagerService
FragmentCacheService
JodConverterService
LiveLinkManagerService
LockService
NewsletterInitializationService
NewsletterManagerService
SiteSearchService
SEOService
QueryService
TaxonomyService
ThumbnailService
TimelineService
WatchDocumentService
WCMService

External Component Plugins

CMIS 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

4. Developer references

WCM Templates

Content types

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

List of Contents

Content List Template
Category Navigation Template

WCM Explorer

CSS
CKEditor

REST Services

Restful Web Service

HTTP Methods
Formats
Data Format
REST configuration
Create a REST service

UI Extensions

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

Listen to a lifecycle
Perform tasks when a content's state is updated

New Authoring Mixin

Auxiliary attributes for documents

CMIS Usage code examples

Login to repository

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

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
ManageViewService

Deprecated portlets

Miscellaneous and Tips

Reference Guide / Collaboration Functions

Prerequisites

1. Applications

Calendar portlet
Chatbar portlet
Chat Portlet
Contact Portlet
Mail Portlet
RSSreader Portlet

Eventslist
Taskslist
Messageslist

2. 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

eXo Chatserver Configuration

Openfire Configuration

Configuration in Openfire.xml
eXo specific configuration

System Configuration

AS configuration

3. 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

4. Developer reference

Extension points

ContentDAO
ContactLifeCycle
Transport
EventLifeCycle

Public REST APIs

Calendar application

Mail application

Chat application

RESTXMPPService
FileExchangeService

Reference Guide / Knowledge Functions

Prerequisites

1. Applications

Forum Portlet

Portlet.xml

Preferences

ForumLinkEvent
ReLoadPortletEvent
OpenLink
ForumPollEvent
ForumModerateEvent
ForumRuleEvent
QuickReplyEvent

Answers Portlet

Portlet.xml
Portlet Preferences

FAQ Portlet

Portlet.xml
Portlet Preferences

Polls Portlet

Portlet.xml
Portlet Preferences

2. Configuration

Components of eXo Knowledge
Components of Forum
Components of Answers
Components of Polls

External-component-plugin

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

ProfileProvider Configuration

Configuration

Use ContactProvider

By DefaultContactProvider
By SocialContactProvider

Forum Configuration

BBCode Configuration

Forums Initializer

Configuration

Default forum data
Forum array
Forum topics

Initial Data Plugin

User Statistics

Update Statistic Data

Default User Profile

Answer Configuration

Answers Initializer
Answers Email Templates Configuration

Poll Configuration

Data Injector Servive

Technical details

Configuration

ForumDataInjector
Wiki Data injector
AnswerDataInjector

How to use?

3. 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

Category and Category home
Forum
Topic
Post
Tag and Tag home
BBCode and BBCode home
Topic type and Topic type home

FAQ JCR structure

Sub-category
RSS
Question and Question Home
Multilanguages
Answer, Comment and Attachment

FAQ setting

Template for FAQ

Poll JCR structure

Wiki JCR structure

WikiHome
Preferences
LinkRegistry
Trash
Template Container

Wiki metadata

4. Developer reference

Extension points

ForumEventLifeCycle

Configuration plug-in
Tutorial

AnswerEventLifeCycle

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
API provided by the UIComponent (UIViewer.java)

Extend actions over a wiki page from external jars

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

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
I18NActivityProcessor
LinkProvider

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

Supported APIs

REST/RPC API
Configure the security
Publish an activity into a space

IdentityProvider
IdentityManager

ProfileListener

Connections

Users connection
RelationshipListener

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

XMLProccessor Component
Built-in XMLProcessor Plugins

How to create internationalized activities

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

soc:providers
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

NextReference Guide / Content Functions