Difference between revisions of "Home Library 2.0 API Framework Specification"

From Gcube Wiki
Jump to: navigation, search
(How to)
(Design Model)
Line 17: Line 17:
 
The core of Home Library 2.0 is a webService build on the top of the Jackrabbit web application. The goal of Home Library 2.0 is to expose content in the content repository as HTTP resources, fostering a RESTful style of application architecture.
 
The core of Home Library 2.0 is a webService build on the top of the Jackrabbit web application. The goal of Home Library 2.0 is to expose content in the content repository as HTTP resources, fostering a RESTful style of application architecture.
 
[[File:WebApp.png]]
 
[[File:WebApp.png]]
 +
 +
Workspace Area model
 +
 +
Each element contained in a workspace area is a WorkspaceItem.
 +
 +
The workspace items are the effective user objects.
 +
 +
The figure 2 illustrate the WorkspaceItem model.
 +
 +
[[File:areamodel.png]]
  
 
== Implementation Framework ==
 
== Implementation Framework ==

Revision as of 18:11, 9 June 2015

Home Library 2.0 API

The Home Library is a library to manage and persist the users homes. that supports file sharing Home Library user is presented with a personal workspace, where users can collaborate, share information, and access project resources using special folders. This module describes the model of Home Library 2.0 and how to use the new API interface.

Design Model

The design model for Home Library identifies a core set of capabilities that ...

The Home Library is defined through an API interface (HomeLibrary project).

Currently there is just one API implementation:

  • HomeLibraryJCR: an HomeLibrary implementation based on JCR 2.0 (Java Content Repository JSR 283).

The Home Library dynamically load the implementation specified on properties file.

The core of Home Library 2.0 is a webService build on the top of the Jackrabbit web application. The goal of Home Library 2.0 is to expose content in the content repository as HTTP resources, fostering a RESTful style of application architecture. WebApp.png

Workspace Area model

Each element contained in a workspace area is a WorkspaceItem.

The workspace items are the effective user objects.

The figure 2 illustrate the WorkspaceItem model.

Areamodel.png

Implementation Framework

The Home Library 2.0 API is a set of components that support the development of .... that comply with the model. Through code sharing, the framework reduces development costs and ensures the consistency and correctness of library implementations.

Management Model

If Needed


How to

To use Home Library 2.0, import the following dependencies:

		<dependency>
			<groupId>org.gcube.common</groupId>
			<artifactId>home-library-jcr</artifactId>
			<version>[2.0.0-SNAPSHOT,3.0.0-SNAPSHOT)</version>
		</dependency>
 
		<dependency>
			<groupId>org.gcube.common</groupId>
			<artifactId>home-library</artifactId>
			<version>[2.0.0-SNAPSHOT,3.0.0-SNAPSHOT)</version>
		</dependency>

Learn how to use the Home Library 2.0 API Framework with this examples ...