Contact us
  • en
  • fr
  • Solutions
    • Company IntranetDiscover our company intranet software to connect and engage your employees
    • Collaboration PlatformDiscover our digital collaboration platform that boost your employee engagement and performance
    • Knowledge ManagementHow To build and manage your knowledge base with eXo Platform
    • Employee EngagementDiscover how to boost your employee engagement
  • Product
    • Overview
      • Software TourAn overview of our software capabilities
      • Why eXoHow eXo improves your employee experience
    • Features
      • CommunicationFeatures to facilitate employee communications
      • CollaborationFeatures to create efficient teams
      • KnowledgeKnowledge management capabilities
      • ProductivityEmployee productivity tools to engage employees
    • Technology
      • Open sourceAn overview of our technology
      • IntegrationsDiscover how eXo integrates with your tools and systems
      • SecurityHow eXo Platform ensures your data security
  • Pricing
    • Product pricingLearn about our business model and pricing
    • ServicesLearn about our professional services
    • FAQsQuestions about the software, the community and our offers
  • Resources
    • Resource center
      • Case studies
      • White Papers
      • Datasheets
      • Videos
    • Technical documentation
      • Getting started
      • Developer Guide
      • Technical administration guide
      • REST APIs
    • From The Blog
      • eXo Platform 6.4 is here, available in both Enterprise and Community editions!
      • eXo Platform community edition is back
      • Cloud Vs On-premise Digital Workplace: Which one is right for your business?
  • Company
    • About us
    • Careers
    • Customers
    • Newsroom
    • Contact us
    • Partners
  • Menu mobile
    • Pricing
    • About us
    • Services
    • FAQs
    • Customers
    • Resource center
    • Contact us
    • Blog
Company Intranet Discover our company intranet software to connect and engage your employees
Collaboration Platform Discover our digital collaboration platform that boost your employee engagement and performance
Knowledge Management How To build and manage your knowledge base with eXo Platform
Employee Engagement Discover how to boost your employee engagement
Overview
  • Software Tour An overview of our software capabilities
  • Why eXo How eXo improves your employee experience
Features
  • Communication Features to facilitate employee communications
  • Collaboration Features to create efficient teams
  • Knowledge Knowledge management capabilities
  • Productivity Employee productivity tools to engage employees
Technology
  • Open source An overview of our technology
  • Integrations Discover how eXo integrates with your tools and systems
  • Security How eXo Platform ensures your data security
Product pricing Learn about our business model and pricing
Services Learn about our professional services
FAQs Questions about the software, the community and our offers
Resource center
  • Case studies
  • White Papers
  • Datasheets
  • Videos
Technical documentation
  • Getting started
  • Developer Guide
  • Technical administration guide
  • REST APIs
From The Blog
  • eXo Platform 6.4 is here, available in both Enterprise and Community editions!
  • eXo Platform community edition is back
  • Cloud Vs On-premise Digital Workplace: Which one is right for your business?
About us
Careers
Customers
Newsroom
Contact us
Partners
Pricing
About us
Services
FAQs
Customers
Resource center
Contact us
Blog
  1. Accueil
  2. Uncategorized
  3. Extend eXo Cloud Drive to new cloud services with the Connector API: Architecture (Part 1 of 3)

Extend eXo Cloud Drive to new cloud services with the Connector API: Architecture (Part 1 of 3)

CloudDrive-post1

Hello, eXo Tribe!

This is an update about the eXo Cloud Drive add-on—an add-on that connects cloud files into eXo.

Recently we introduced a feature of Cloud Drive enabling you to modify cloud documents directly from eXo Platform. This time, along with seamless synchronization and embedded access to files, we are adding support of Single Sign-On and open Connector API, which lets other developers create new extensions to connect more cloud services, such as Microsoft SharePoint or Dropbox, or maybe a connector to your software.

In this post I will introduce the Connector API and describe how to create a new connector for Cloud Drive, from developer conventions to installation in eXo Platform. Due to its length, this post is split into three parts and refers frequently to the add-on documentation for details and examples.

Cloud Drive connector is a set of Java interfaces implemented by the connector code with client scripts, pages, styles, and other files connected together by the conventions. Thanks to Connector API it’s possible to create connectors to new cloud providers without changing the add-on code or its configuration. Technically, the Cloud Drive add-on is a portal extension in eXo Platform, and each connector is also a portal extension that depends on the Cloud Drive extension.

Cloud Drive Architecture

Let’s look at Cloud Drive architecture and see which parts of the add-on are extensible in connectors. In the diagram below, critical parts of Connector API are marked in red and optional ones are blue. All major parts should be implemented by any connector. Optional parts may be implemented if needed to add a control on additional features such as automatic synchronization, user interface post-processing and styles, or other client customizations.

architecture-connector

As shown in the diagram, a client consumes both eXo Platform and cloud resources while working. Platform serves requests to portal UI and Cloud Drive’s web services to render cloud drive with proper menu actions and styles. Cloud services are used directly from the client (browser) to connect drives in embedded file view and, if connector supports, for synchronization initiation.

Platform’s server will load the Cloud Drive add-on via its extension configuration. Cloud Drive has embedded connectors (for Google Drive and Box.com), which are already configured in the add-on configuration. All third-party connectors will be loaded via their extension configurations.

Where To Start A New Connector

When planning a connector to Cloud Drive, first decide which cloud features you want to expose in eXo Documents. Then you just can be creative with Cloud Drive! You can find out how the add-on works functionally in the previous post. Programmatically, it offers an abstraction layer on top of the internal JCR storage used to store file stubs with metadata. This abstraction defines common properties of a drive with its files on the cloud side. Relying on this set of naming conventions and interfaces you will be able to decide on features and how to expose your cloud files in the eXo Documents app.

The overall Cloud Drive architecture consists of a server-side Java API and client support in a browser. Start working on critical parts in the Java API and then move on to the client side customizations when you want to start working on the user interface. Connector API is file-centric and highly compatible with the ECMS (JCR) virtual file system—take this in account when adapting features not explicitly related to the files system. For example, comments, projects, or tasks don’t describe a file as an entity and probably will need support in a dedicated custom code.

When you have an idea and know which features you will show in eXo, start engineering work from the connector’s project organization. You can reuse the existing template project to bootstrap the development—it contains Javadocs (recommendations to follow). Copy its files to a new location and start to code the connector plugin class, a programmatic entry point of the add-on. By working on its logic and digging into the details of Connector API you will understand the relationships better. I’ll talk about them in the next post.

A connector project imported in your IDE should look like the example below, a template project in Eclipse:

template-project-eclipse

In the next post I will introduce a major component: the Java API.

Join the eXo tribe by registering for the community and get updates, tutorials, support, and access to the Platform and add-on downloads!


make-the-most-out-of-eXo-platform4

Make the most out of eXo Platform 4

Register to the next webinar and get a complete overview of what you can do with eXo Platform 4. Reserve your seat now!

Brahim Jaouane

I am a Digital Marketing specialist specialized in SEO at eXo Platform. Passionate about new technologies and Digital Marketing. With 10 years' experience, I support companies in their digital communication strategies and implement the tools necessary for their success. My approach combines the use of different traffic acquisition levers and an optimization of the user experience to convert visitors into customers. After various digital experiences in communication agencies as well as in B2B company, I have a wide range of skills and I am able to manage the digital marketing strategy of small and medium-sized companies.

Full-featured digital workplace with everything your employees need to work efficiently, smartly integrated for a compelling employee experience

  • Product
    • Software tour
    • Communication
    • Collaboration
    • Knowledge
    • Productivity
    • Open Source
    • Integrations
    • Security
  • Uses cases
    • Digital Workplace
    • Intranet software
    • Collaboration software
    • Knowledge management software
    • Entreprise Social Network
    • Employee Engagement platform
  • Roles
    • Internal Communications
    • Human Resources
    • Information Technology
  • Company
    • Product offer
    • Services Offer
    • Customers
    • Partners
    • About us
  • Resources
    • FAQs
    • Resource Center
    • Collaboration guide
    • What is a Digital workplace?
    • What is an intranet?
    • Employee engagement
  • Terms and Conditions
  • Legal
  • Privacy Policy
  • Accessibility
  • Contact us
  • Sitemap
  • Facebook
  • Twitter
  • LinkedIn
wpDiscuz