Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

The DSpace system is organized into three layers, each of which consists of a number of components.

DSpace System Architecture

The storage layer is responsible for physical storage of metadata and content. The business logic layer deals with managing the content of the archive, users of the archive (e-people), authorization, and workflow. The application layer contains components that communicate with the world outside of the individual DSpace installation, for example the Web user interface and the Open Archives Initiative protocol for metadata harvesting service.

Each layer only invokes the layer below it; the application layer may not used use the storage layer directly, for example. Each component in the storage and business logic layers has a defined public API. The union of the APIs of those components are referred to as the Storage API (in the case of the storage layer) and the DSpace Public API (in the case of the business logic layer). These APIs are in-process Java classes, objects and methods.

...

Packages within

Correspond to components in

org.dspace.app

Application layer

org.dspace

Business logic layer (except storage and app)

org.dspace.storage

Storage layer

Wiki MarkupThe storage and business logic layer APIs are extensively documented with Javadoc-style comments. Generate the HTML version of these by entering the \ [dspace-source\]/dspace directory and running:

Code Block
mvn javadoc:javadoc

...

The resulting documentation will be at _\[dspace-source\]dspace-api/target/site/apidocs/index.html_. The package-level documentation of each package usually contains an overview of the package and some example usage. This information is not repeated in this architecture document; this and the Javadoc APIs are intended to be used in parallel.

Each layer is described in a separate section:

  • Storage Layer
    • RDBMS
    • Bitstream Store
  • Business Logic Layer
    • Core Classes
    • Content Management API
    • Workflow System
    • Administration Toolkit
    • E-person/Group Manager
    • Authorisation
    • Handle Manager/Handle Plugin
    • Search
    • Browse API
    • History Recorder
    • Checksum Checker
  • Application Layer
    • Web User Interface
    • OAI-PMH Data Provider
    • Item Importer and Exporter
    • Transferring Items Between DSpace Instances
    • Registration
    • METS Tools
    • Media Filters
    • Sub-Community Management
      2002-2008 The DSpace Foundation