Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "SMILA/Project Concepts/Binary Storage"

Line 6: Line 6:
 
* The file system will be used as physical storage
 
* The file system will be used as physical storage
 
* The [http://commons.apache.org/vfs/ Apache Commons Virtual File System (Commons VFS)] framework is to be used for accessing the file system.
 
* The [http://commons.apache.org/vfs/ Apache Commons Virtual File System (Commons VFS)] framework is to be used for accessing the file system.
* For performance improvment (in case of ) the binary storage shall be hierarchicaly/tree organized; and not flat
+
* For performance improvement (in case of ) the binary storage shall be hierarchically/tree organized; and not flat
* Binary storage shall internaly manage its persistence hierarchy
+
* Binary storage shall internally manage its persistence hierarchy
 
* The binary service shall be designed as a single bundle / service. Main reason for doing this is that there is only one “client”, the Blackboard service
 
* The binary service shall be designed as a single bundle / service. Main reason for doing this is that there is only one “client”, the Blackboard service
 
* Exception handling mechanism should treat all internal binary storage (logical and unexpected) errors and wrap the exceptions into a “binary storage exception” that makes sense for the Blackboard service
 
* Exception handling mechanism should treat all internal binary storage (logical and unexpected) errors and wrap the exceptions into a “binary storage exception” that makes sense for the Blackboard service

Revision as of 17:19, 7 October 2008

Description

The purpose of Binary Storage is to provide solution for persisting binary objects (content of indexed files) into the file system. The binary objects (files content) shall be simply identified by a unique key / identifier.

Technical aspects for designing the Binary Storage Service

  • The file system will be used as physical storage
  • The Apache Commons Virtual File System (Commons VFS) framework is to be used for accessing the file system.
  • For performance improvement (in case of ) the binary storage shall be hierarchically/tree organized; and not flat
  • Binary storage shall internally manage its persistence hierarchy
  • The binary service shall be designed as a single bundle / service. Main reason for doing this is that there is only one “client”, the Blackboard service
  • Exception handling mechanism should treat all internal binary storage (logical and unexpected) errors and wrap the exceptions into a “binary storage exception” that makes sense for the Blackboard service
  • Resources synchronization shall be done at the lowest possible level
  • Binary Storage shall manage its configuration internally (highly couple classes are difficult to maintain and hard to understand in isolation – they tend to introduce internal dependencies). Decouple binary storage configuration from blackboard service

2.Sequence Diagram NewBinaryStorae.jpg

  • The Binary Storage Service API shall stay as simple as possible

3.Class Diagram BinaryStorage-newAPI.jpg

Current Binary Storage Service

Current implementation of Binary Storage is designed in five bundles, where the org.eclipse.eilf.binstorage(.impl) bundle acts as “service factory” for the Blackboard service, providing the files-service, configuration and file-content services.

1.Sequence Diagram BinaryStorae-flow.jpg

Current implementation is deprecated and it will be soon changed.

Back to the top