hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document where to begin using the Framework

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/modules/dspace-services/trunk@5021 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Mark Wood
2010-05-26 13:58:20 +00:00
parent d8d10ea50b
commit fa388a002a
3 changed files with 29 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/main/javadoc/overview.html
View File

@@ -1,10 +1,12 @@
<html>
<body>
<p>
The DSpace Services Framework provides the infrastructure of a more
componentized realization of DSpace. Services, plugins, and providers
are registered with the framework so that they can find each other without
having to know each other too intimately. This should make it easier to
maintain, extend, and understand DSpace as it evolves.
</p>
<p>The framework consists of:</p>
@@ -20,6 +22,23 @@ maintain, extend, and understand DSpace as it evolves.
<dd>includes the DSpace object, a starting point in using the framework</dd>
</dl>
<p>
To use the Services Framework, start by obtaining a reference to a
running kernel.
</p>
<ul>
<li>In a standalone application, you can instantiate {@link
org.dspace.utils.DSpace the DSpace object}. It will provide references
to the kernel and core services.</li>
<li>In a Spring context you can wire ??? as needed.</li>
<li>In a servlet context, you should configure a {@link
org.dspace.servicemanager.servlet.DSpaceKernelServletContextListener
context listener} and a {@link
org.dspace.utils.servlet.DSpaceWebappServletFilter filter} to start the
kernel and establish the connection between the web application and the
framework.</li>
</ul>
@see <a href='http://wiki.dspace.org/confluence/display/DSPACE/DSpace+Services+Framework'>
DSpace Services Framework</a>
</body>

10
utils/src/main/java/org/dspace/utils/servlet/DSpaceWebappServletFilter.java
View File

@@ -32,10 +32,12 @@ import org.dspace.services.model.CacheConfig.CacheScope;
/**
* This servlet filter will handle the hookup and setup for DSpace requests and should
* be applied to any webapp that is using the DSpace core <br/>
* It will also do anything necessary to the requests that are coming into a DSpace web application
* and the responses on their way out
* This servlet filter will handle the hookup and setup for DSpace
* requests. It should be applied to any webapp that is using the
* DSpace core.
* <p>
* It will also do anything necessary to the requests that are coming
* into a DSpace web application and the responses on their way out.
*
* @author Aaron Zeckoski (azeckoski @ gmail.com)
*/

5
utils/src/main/java/org/dspace/utils/servlet/package-info.java
View File

@@ -1,3 +1,6 @@
/** Initializing the framework in a web application. */
/**
* Connect a servlet container with the DSpace Services framework, in a
* web application context.
*/
package org.dspace.utils.servlet;