Table of Contents:
This guide covers version 10.0 of IDEA, which you can get from here: http://www.jetbrains.com/idea/. Instructions for installing & running can be found on the website and in the readme file included with the download.
Once the source has been checked out, you will be asked whether you want to create a project (click "Yes").
Note: If you haven't already defined a JDK, you may not be able to do so at this point, despite being given the option. Instead, create the project without a JDK, then later open the Settings dialog, then go Project Settings -> JDKs
and add your JDK here
Go to the command line, and go to the root of your new project. Run:
mvn package |
These steps might take a while to download all the dependencies, but that should only happen once.
Note: you may notice, if you look in IDEA, that at this stage it will detect a number of web facets. Ignore this for the time being, we will come back to it. They will be available under the flashing cog on the bottom right of the screen for future reference.
After this completes:
dspace
directory navigate to target/dspace-<version>.dir/
(the version may vary depending on which part of the svn tree you are using) and edit the config/dspace.cfg
file according to your local requirements (this is the file that will be deployed into your <dspace>
directory).<dspace>
directory and that the correct database exists, etc. This is all covered in the install docs, but this differs in one important respect: your user will need to have write permissions on the <dspace>
directory. This is because when you run the ant tasks from IDEA they will run with your permissions, and ant update
will fail if you can't write to <dspace>
.ant fresh_install
from this directory. You can do this in IDEA by right clicking build.xml
, and selecting Add as Ant Build File
. When the build file dialog opens, select fresh_install
and hit the run button at the top of the panel.Name
Parameters Tab
<dspace-src>/dspace/
.General Tab
/usr/share/maven-bin-2.0
)~/.m2/settings.xml
)Runner Tab
dspace.config
", and the value is the absolute path to your dspace.cfg
). The ant fresh_install
task from the previous section should have pushed this file into your <dspace>
directory.
dspace.config
property.Once you have this configured, click "Apply" at the bottom and then click "OK".
You should also run it immediately, because the previous build will have the incorrect dspace.cfg
built into it. You can do this using the quick launch from the IDEA tool bar: in the center of the toolbar at the top is a pull-down menu which contains all your pre-configured run tasks. Select the one you have named "mvn clean package", and hit the green arrow to the right of it. You should see maven building your project in a window at the bottom of IDEA, and the content will be similar to when you ran it from the command line earlier.
At some point during the above installation process, IDEA may notify you of new web facets detected. These correspond to the individual WAR files and thus web applications which we are working on. If you do not confirm the detection of these facets straight away, they will be available on the bottom left of the screen by clicking on the flashing gear/cog.
Each of these web facets represents a web application provided by DSpace. This will include, for example, the LNI, the JSP-UI, the XML-UI and the OAI interface.
In the dialog, select "Accept". If you ignored the dialog, they should be available under the flashing 'cog' icon at the bottom of your IDEA window.
The next step in getting fully integrated with this IDE is to set it up with ant and tomcat.
build.xml
file from <dspace-src>/dspace/target/dspace-<version>.dir
.dspace.cfg
. Click "OK".Tomcat integration is only possible if you have IDEA Ultimate edition. The free community version does not offer this feature. If you are an official DSpace developer, you can contact one of the other Committer's to learn about how you can get ultimate edition. |
For Tomcat integration, I chose to download and install tomcat 6 in /opt
to keep it separate from the 5.5 release that I had previously installed with my package manager. There are a few reasons for this, but mostly it's because we need to assign pretty weak privileges to the tomcat directory because we will be deploying the webapp as a normal user (run something along the lines of chmod -R jim:tomcat /opt/apache-tomcat-6.0.14 ; chmod -R g+rwx /opt/apache-tomcat-6.0.14
as root).
Once you have ant and tomcat ready, you can create a new build configuration for these two.
Name
Server Tab
Deployment Tab
jspui:war
, xmlui:war
)
dspace-jspui-webapp:war
; these can be deployed but are not connected to the dependency libraries so unless you have tomcat set up specifically to use shared dependencies you will get tomcat errors on trying to load these pages; always use the simple named facet (e.g. jspui:war
) to deploy.Once you have this set up, you can deploy DSpace, by selecting the tomcat deployment from the menu bar, and hitting the green play button next to it. Hit the play button on the opened dialog, and IDEA will deploy the applications at the context paths specified in this section.
If you leave the "run" dialog boxes open at the bottom, you have a quick way to re-run the build and deployment tasks. The maven build can be re-run by clicking the green icon that looks like ">>", and likewise for the ant + tomcat deployment, except you'll have to click "stop" first, and wait for tomcat to shut down.
If you see an error that indicates that the dspace.dir folder cannot be found in your Tomcat/bin folder, (such as java.io.FileNotFoundException: /opt/local/share/java/tomcat6/bin/dspace.dir/config/dspace.cfg (No such file or directory)) when you attempt to call the Tomcat runconfig, you can try adding a symlink in your Tomcat/bin folder, like so:
cd /opt/local/share/java/tomcat6/bin/ sudo ln -s /dspace/ '${dspace.dir}' |
It's not pretty, but it'll get the job done.
IDEA has loads of plugins available to install. A couple that may be useful are: