eXo Platform 3.5

## Chapter 6. eXo Platform 3.5 APIs

This chapter presents the information about APIs that help you build your own applications from eXo services via the following topics:

- Definitions of API Levels

  Introduction to the different levels of APIs, Provisional or Experimental APIs.

- Platform APIs

  Definitions of levels of Platform APIs, including:

  - Java APIs

  - JavaScript APIs

  - Web Services

- Provisional APIs

  A list of provisional APIs.

## 6.1. Definitions of API Levels

APIs vary according to the maturity level. It is important to understand the eXo Platform's general approach to the API change management. The different levels of APIs are described in the following table:

API Level | Test Suite | Clients | Documentation | Support | Compatibility X.Y.Z(1) | Compatibility X.Y(1)
--- | --- | --- | --- | --- | --- | ---
Platform API |  |  |  |  |  |
Provisional API |  |  |  |  |  |
Experimental API |  |  |  | Best effort | Best effort |
Unsupported API |  |  |  |  |  |

Test Suite: A suite of tests that can be run against the API to detect changes.

Clients: The API has been used successfully by at least 2 different teams, using the API Documentation only.

Documentation: The API has a clean JavaDoc and reference documentation.

Support: The eXo Support team provides help on the code that uses this API, and fixes any reported bugs.

Compatibility X.Y.Z(1): The compatibility between maintenance versions (X.Y.Z and X.Y.Z1) is guaranteed. If there is any change between X.Y and X.Y1, the eXo Support team will help by upgrading the code.

Compatibility X.Y(1): The compatibility between minor versions (X.Y and X.Y1) is guaranteed. If there is any change between X and X1, the eXo Support team will help by upgrading the code.

Best Effort: You will receive assistance, but eXo Platform cannot guarantee any specific result.

Use Provisional or Experimental APIs

These APIs are provided to give an "early look" at which will be available in upcoming versions of eXo Platform. These APIs are not final, but they can be used to start developing your application.

Provisional APIs are APIs close to being frozen, but that need a last look from users. They can be used by third-party developers for their own apps, with the knowledge that only a limited compatibility guarantee is offered.

Experimental APIs are APIs that are likely to change. They are published to get feedback from the community. These APIs have been tested successfully, but have not yet had enough feedback from developers.

`See also`

- Platform APIs

- Provisional APIs

## 6.2. Platform APIs

This section summarizes a list of eXo Platform APIs which can be categoried into:

- Java APIs

- JavaScript APIs

- Web Services

Java APIs

- Portlet API: (JSR 168 and JSR 286) A Java standard that defines how to write portlets. This is the way to develop Java applications that are integrated into eXo Platform.

- WSRP 1.0 on JBoss: A network protocol for integrating remote portlets into eXo Platform.

- JAX-RS: (JSR 311) A standard API that provides support for creating REST-like services.

- JCR (JSR 170): A standard API that provides access to a content repository.

- JCR Service Extensions: A set of APIs that provide extended functionalities for the JCR, such as observation, permissions, and access to a repository.

- Java EE 6: eXo Platform supports the Java EE 5 APIs, so you can develop applications using this standard.

- Cache: An API used for data caching.

- Event and Listener: An API for listening and sending events within eXo Platform.

- Organization: An API and SPI for accessing user, group and membership information.

- Portal Container: This API is used to configure your portal.

- TaxonomyService: An API that allows you to organize your content.

- LinkManager: An API that provides a way to manage links when developing WCM features.

- PublicationManager: An API that provides different ways to manage the publication of content when developing WCM features.

- WCMComposer: An API to get content shown in the website. The cache management is used in this service, and methods to update the content cache.

- NewFolksonomy: An API to manage all the tags and their styles. Currently, it just supports adding/editing/removing the Private & Public tags.

- ApplicationTemplateManager: An API to manage dynamic groovy templates for WCM-based products.

- NodeFinder: An API to find a node with a given path.

- JodConverter: An API to convert documents into different office formats.

- SiteSearchService: An API that allows users to find all information matching with their given keyword.

- SEOService: An API that manages SEO data of a page or a content.

- TimelineService: An API that allows documents to be displayed by days, months and years.

- XML Configuration: A set of DTD for configuring eXo Platform.

- ActivityManager: An API to manage activities (create/delete/like activity; delete/like/create comment; get activities of space/user/connection).

- IdentityManager: An API to manage identities (create identity, save profile, get connection of an identity).

- RelationshipManager: An API which is used to work with connections between 2 identities, interact between identities, get list access to get list of connections, incomings, outgoings.

- SpaceService: An API that provides methods for working with space (create new space, delete, get space by url, groupid, display name, pretty name).

JavaScript APIs

- OpenSocial 1.1 Gadget Specification: A standard that defines how to write gadgets and provide APIs. Gadgets are particularly useful for integrating external applications into eXo Platform.

Web Services

- CMIS: A standard API that gives access to the content repository via REST and SOAP Web services.

- FTP: A standard protocol for exchanging documents.

- OpenSocial 1.1 REST Protocol: A standard API for accessing the social graph and activity streams.

- WebDAV: A standard protocol for exchanging document over HTTP.

`See also`

- Definitions of API Levels

- Provisional APIs

## 6.3. Provisional APIs

Java APIs

- UI Extensions: An API to plug new actions into the eXo Platform UI.

- ECM Admin and DocumentExplorer Toolbar

- Activity Sharing

`See also`

- Definitions of API Levels

- Platform APIs

Copyright © 2009-2012. All rights reserved. eXo Platform SAS