Difference between revisions of "Home Library 1.0 API"

From Gcube Wiki
Jump to: navigation, search
Line 4: Line 4:
 
==Architecture==
 
==Architecture==
 
The ''user's homes'' are organized in scopes.
 
The ''user's homes'' are organized in scopes.
The users and the homes for a specific scope are managed by the ''HomeManager''.
 
Each user home (''Home'') have a workspace area (''WorkspaceArea'') and a data area (''DataArea'').
 
  
[[Image:homelibrary-architecture.png]]
+
The users and the homes for a specific scope are managed by the '''HomeManager'''.
 +
 
 +
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===
 +
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'''.
 +
 
 +
[[Image:homelibrary-workspacearea-model.png|frame|center|Figure 2. Workspace Area model]]
 +
 
  
 
==How to retrieve an User WorkspaceArea from a servlet==
 
==How to retrieve an User WorkspaceArea from a servlet==

Revision as of 19:18, 29 September 2009

Alert icon2.gif THIS SECTION OF GCUBE DOCUMENTATION IS CURRENTLY UNDER UPDATE.

The Home Library manage and persist the users homes.

Architecture

The user's homes are organized in scopes.

The users and the homes for a specific scope are managed by the HomeManager.

Each user home (Home) have a workspace area (WorkspaceArea) and a data area (DataArea).

Figure 1. Home Library Reference Architecture

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.

Figure 2. Workspace Area 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.

WorkspaceArea wa = HomeLibrary.getUserWorkspaceArea(session);


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