Difference between revisions of "Home Library 1.0 API"

From Gcube Wiki
Jump to: navigation, search
(Workspace Area model)
(Replaced content with "This page refers to Home Library 1.0 API that is not supported anymore. Please, use the following redirect for Home Library 2.0 API: #REDIRECT Home Library 2.0 API Fra...")
 
(72 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{UnderUpdate}}
+
This page refers to Home Library 1.0 API that is not supported anymore.
The Home Library manage and persist the users homes.
+
  
==Architecture==
+
Please, use the following redirect for Home Library 2.0 API:
The ''user's homes'' are organized in scopes.
+
  
The users and the homes for a specific scope are managed by the '''HomeManager'''.
+
#REDIRECT [[Home Library 2.0 API Framework Specification]]
 
+
Each user home ('''Home''') have a workspace area ('''WorkspaceArea''') and a data area ('''DataArea''').
+
 
+
[[Image:homelibrary-architecture.png|frame|center|Figure 1. Home Library Reference Architecture]]
+
 
+
===Workspace Area model===
+
The figure 2 illustrate the Workspace Area model.
+
 
+
[[Image:homelibrary-workspacearea-model.png|frame|center|Figure 2. Workspace Area model]]
+
 
+
Each element contained in a workspace area is a '''WorkspaceAreaItem'''.
+
 
+
There are two kind of item container: the '''Workspace''' and the '''Basket''', both can be referred as '''WorkspaceFolder'''.
+
 
+
A workspace can contain one or more workspacefolder.
+
 
+
A basket can contain only '''BasketItems'''.
+
 
+
The basket items are the effective user objects.
+
 
+
The figure 3 illustrate the BasketItem model.
+
 
+
[[Image:homelibrary-basketitem-model.png|frame|center|Figure 3. Basket Item model]]
+
 
+
==How to retrieve an User WorkspaceArea from a servlet==
+
To retrieve a WorkspaceArea for a User you can use the getWorkspaceArea static method from HomeLibrary class. This method required only the current D4ScienceSession.
+
 
+
<source lang="java5">
+
WorkspaceArea wa = HomeLibrary.getUserWorkspaceArea(session);
+
</source>
+
 
+
 
+
==References==
+
The most recent presentation about the Home Library can be found there:
+
http://bscw.research-infrastructures.eu/bscw/bscw.cgi/d107608/06.%20HomeLibrary.ppt
+

Latest revision as of 17:54, 7 July 2016

This page refers to Home Library 1.0 API that is not supported anymore.

Please, use the following redirect for Home Library 2.0 API:

  1. REDIRECT Home Library 2.0 API Framework Specification