mirror of
https://github.com/DSpace/DSpace.git
synced 2025-10-15 14:03:17 +00:00
db521eb0cd
git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5988 9c30dcfa-912a-0410-8fc2-9e0234be79fd
146 lines
7.0 KiB
HTML
146 lines
7.0 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>DSpace Documentation : Architecture</title>
|
|
<link rel="stylesheet" href="styles/site.css" type="text/css" />
|
|
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
</head>
|
|
|
|
<body>
|
|
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
|
|
<tr>
|
|
<td valign="top" class="pagebody">
|
|
<div class="pageheader">
|
|
<span class="pagetitle">
|
|
DSpace Documentation : Architecture
|
|
</span>
|
|
</div>
|
|
<div class="pagesubheading">
|
|
This page last changed on Dec 15, 2010 by <font color="#0050B2">tdonohue</font>.
|
|
</div>
|
|
|
|
<h1><a name="Architecture-DSpaceSystemDocumentation%3AArchitecture"></a>DSpace System Documentation: Architecture</h1>
|
|
|
|
<style type='text/css'>/*<![CDATA[*/
|
|
div.rbtoc1292438668543 {margin-left: 0px;padding: 0px;}
|
|
div.rbtoc1292438668543 ul {list-style: none;margin-left: 0px;}
|
|
div.rbtoc1292438668543 li {margin-left: 0px;padding-left: 0px;}
|
|
|
|
/*]]>*/</style><div class='rbtoc1292438668543'>
|
|
<ul>
|
|
<li><span class='TOCOutline'>1</span> <a href='#Architecture-Overview'>Overview</a></li>
|
|
<ul>
|
|
<li><span class='TOCOutline'>1.1</span> <a href='#Architecture-DSpaceSystemArchitecture'>DSpace System Architecture</a></li>
|
|
</ul>
|
|
</ul></div>
|
|
|
|
<h2><a name="Architecture-Overview"></a>Overview</h2>
|
|
|
|
<p>The DSpace system is organized into three layers, each of which consists of a number of components.</p>
|
|
|
|
<p><span class="image-wrap" style=""><img src="attachments/22022821/21954861.gif" style="border: 0px solid black"/></span></p>
|
|
|
|
<h3><a name="Architecture-DSpaceSystemArchitecture"></a>DSpace System Architecture</h3>
|
|
|
|
<p>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 <a href="http://www.openarchives.org/" title="Open Archives Initiative">Open Archives Initiative</a> protocol for metadata harvesting service.</p>
|
|
|
|
<p>Each layer only invokes the layer below it; the application layer may not used 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.</p>
|
|
|
|
<p>It is important to note that each layer is <em>trusted</em>. Although the logic for <em>authorising actions</em> is in the business logic layer, the system relies on individual applications in the application layer to correctly and securely <em>authenticate</em> e-people. If a 'hostile' or insecure application were allowed to invoke the Public API directly, it could very easily perform actions as any e-person in the system.</p>
|
|
|
|
<p>The reason for this design choice is that authentication methods will vary widely between different applications, so it makes sense to leave the logic and responsibility for that in these applications.</p>
|
|
|
|
<p>The source code is organized to cohere very strictly to this three-layer architecture. Also, only methods in a component's public API are given the <em>public</em> access level. This means that the Java compiler helps ensure that the source code conforms to the architecture.</p>
|
|
<div class='table-wrap'>
|
|
<table class='confluenceTable'><tbody>
|
|
<tr>
|
|
<td class='confluenceTd'> <b>Packages within</b> </td>
|
|
<td class='confluenceTd'> <b>Correspond to components in</b> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> <em>org.dspace.app</em> </td>
|
|
<td class='confluenceTd'> Application layer </td>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> <em>org.dspace</em> </td>
|
|
<td class='confluenceTd'> Business logic layer (except <em>storage</em> and <em>app</em>) </td>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> <em>org.dspace.storage</em> </td>
|
|
<td class='confluenceTd'> Storage layer </td>
|
|
</tr>
|
|
</tbody></table>
|
|
</div>
|
|
|
|
|
|
<p>The 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:</p>
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-java">
|
|
mvn javadoc:javadoc
|
|
</pre>
|
|
</div></div>
|
|
<p>The resulting documentation will be at <em>[dspace-source]dspace-api/target/site/apidocs/index.html</em>. 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.</p>
|
|
|
|
<p>Each layer is described in a separate section:</p>
|
|
|
|
<ul>
|
|
<li><a href="Storage Layer.html" title="Storage Layer">Storage Layer</a>
|
|
<ul>
|
|
<li>RDBMS</li>
|
|
<li>Bitstream Store</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="Business Logic Layer.html" title="Business Logic Layer">Business Logic Layer</a>
|
|
<ul>
|
|
<li>Core Classes</li>
|
|
<li>Content Management API</li>
|
|
<li>Workflow System</li>
|
|
<li>Administration Toolkit</li>
|
|
<li>E-person/Group Manager</li>
|
|
<li>Authorisation</li>
|
|
<li>Handle Manager/Handle Plugin</li>
|
|
<li>Search</li>
|
|
<li>Browse API</li>
|
|
<li>History Recorder</li>
|
|
<li>Checksum Checker</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="Application Layer.html" title="Application Layer">Application Layer</a>
|
|
<ul>
|
|
<li>Web User Interface</li>
|
|
<li>OAI-PMH Data Provider</li>
|
|
<li>Item Importer and Exporter</li>
|
|
<li>Transferring Items Between DSpace Instances</li>
|
|
<li>Registration</li>
|
|
<li>METS Tools</li>
|
|
<li>Media Filters</li>
|
|
<li>Sub-Community Management</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<br/>
|
|
<div class="tabletitle">
|
|
<a name="attachments">Attachments:</a>
|
|
</div>
|
|
|
|
<div class="greybox" align="left">
|
|
<img src="images/icons/bullet_blue.gif" height="8" width="8" alt=""/>
|
|
<a href="attachments/22022821/21954861.gif">architecture-600x450.gif</a> (image/gif)
|
|
<br/>
|
|
</div>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr>
|
|
<td height="12" background="https://wiki.duraspace.org/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><font color="grey">Document generated by Confluence on Dec 16, 2010 11:47</font></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html> |