...
Build and deployment instructions for services-api (development)
DSpace source modifications (temporary)
Warning |
---|
The following changes cannot be committed and should just be made locally. |
dspace pom.xml
Alter (dspace-source)/dspace/pom.xml around line 160 (the one next to the module directory that is responsible for creating the install directory), NOT the dspace-parent pom.xml.
Replace the following dependency:
Code Block | ||
---|---|---|
| ||
<!-- This dependency ensures DSpace OAI JAR is added to [dspace]/lib/,
so that the 'dspace oai' launcher.xml command works. -->
<dependency>
<groupId>org.dspace</groupId>
<artifactId>dspace-oai</artifactId>
<type>jar</type>
<classifier>classes</classifier>
</dependency> |
by the following dependency
Code Block | ||
---|---|---|
| ||
<dependency>
<groupId>org.dspace.modules</groupId>
<artifactId>additions</artifactId>
</dependency> |
This is needed because the dspace-oai module currently doesn't compile and without this we cannot create an installation directory.
build.xml file
In order to be able to perform a fresh_install with ant we need to remove the "test_database" depends from the fresh_install target. This should be on or around line 857 in (dspace-source)/dspace/src/config/build.xml
The DatabaseUtils is currently broken because I'm unsure of how to fix it at the current time.
Before:
Code Block | ||
---|---|---|
| ||
<target name="fresh_install"
depends="init_installation,init_configs,test_database,install_code"
description="Do a fresh install of the system, overwriting any data"> |
After:
Code Block | ||
---|---|---|
| ||
<target name="fresh_install"
depends="init_installation,init_configs,install_code"
description="Do a fresh install of the system, overwriting any data"> |
Postgres changes
Enable pgcrypto extension
In order to generate UUID identifiers in postgres an extension module is required.
Postgres changes
Enable pgcrypto extension
In order to generate UUID identifiers in postgres an extension module is required.
- Start by installing the "pgcrypto" module (must have version 1.1 or above for the "gen_random_uuid()" method, see
)Start by installing the "pgcrypto" moduleJira server DuraSpace JIRA serverId c815ca92-fd23-34c2-8fe3-956808caf8c5 key DS-2716 - In many Linux systems (especially Debian/Ubuntu), pgcrypto is provided in the "postgresql-contrib" package.
- Connect to the database using user postgres
- Run the following command: "CREATE EXTENSION pgcrypto;"
- The output of the command if successful is blank, so you can always try to run "SELECT gen_random_uuid();" which should return a result.
...
Database migration occurs on tomcat start (handled by flywayFlyway). Both existing databases & new installation should work , although existing databases has not been tested as well as a new database. There COULD be issues where an integer/boolean columns have the NULL value, the old DatabaseManager had a fallback to -1, false. Hibernate does not so the migration sql script might need to be altered to support any issues we find(though please report any errors if you find any).
Maven build instructions
Since not all the modules are currently compiling (the only operations ones are dspace-api, dspace-services, dspace-xmlui) a special command is needed to build everythingThe same build instructions apply as in DSpace 5:
Code Block | ||
---|---|---|
| ||
mvn clean package -P -dspace-oai,-dspace-jspui,-dspace-rdf,-dspace-sword,-dspace-swordv2,-dspace-rest,dspace-services |
Ant update
Don't forget to ant update/fresh_install before starting up tomcat again.
Starting tomcat
Info |
---|
Create a database backup before starting the tomcat, as it will trigger a migration. |
The "ant update" or "ant fresh_install" process will trigger a database update. If your database content is important to you (or you wish to test the migration process more thoroughly), you may wish to back it up prior to running Ant. The migration will obviously modify your existing database. While we think it is "safe", it is not considered "production ready" until 6.0 is released.
Starting tomcat
Finally, start up Tomcat as normalBefore starting tomcat it is best to set a breakpoint in the org.dspace.core.HibernateFlywayIntegrator class on line 72 (this catches SQL exceptions caused by flyway & will be useful information if it fails).
How to migrate DSpace modules to the service api
Introduction
...
Tutorial: Basic class porting
...
Info |
---|
In order to quickly find the factory call you need, see: DSpace Service based api: API Changelist, every service that has a factory call has an example of how to retrieve. The factories always have the following format: [packageName]ServiceFactory.getInstance().get[className]Service(). So after a while you won't even need to look them up. |
...
As seen in the example above some of the services require additional arguments, depending on the method this could be a context, database object, .... A complete list of methods that have changed in this manner is available here DSpace Service based api: API Changelist
Another change easily encountered is the fact that in older DSpace versions an array of objects was returned instead of a list. This has been changed to always return lists. So the following changes will also need to be made:
...