Building JSDSI

Contents:

• How to Build JSDSI from Source.
• Maven: A step-by-step guide to installing.
• Eclipse: How to generate a JSDSI project.
• Eclipse CVS Repository Explorer: How to generate a JSDSI project.

How to Build JSDSI from Source

Pre-requisites

• You have a working Java Development Kit version 1.4 or better. Note that if you use Eclipse, you must set the source compatibility of the compiler to 1.4 (Project -> Properties -> Java Compiler -> Configure Workspace Settings (or Project Settings, if you prefer) -> Compliance and Classfiles -> Source Compatibility -> 1.4)

• Your have downloaded and installed , or built Maven. (You may like to follow our step-by-step guide to installing Maven)

Steps

1. Download or retrieve the JSDSI source code from CVS .

2. Make sure your local Maven repository contains the necessary jar file dependencies or configure your Maven system to search the JSDSI Maven Repository . This is achieved by adding the relevant entry in your Maven ${user.home}/build.properties configuration file, e.g.

   maven.repo.remote=http://www.ibiblio.org/maven/,http://jsdsi.sf.net/maven/
   

3. Using a shell, run your desired Maven target from the jsdsi directory, e.g.

   maven jar:install

4. Make a cuppa tea :-)

Maven: A step-by-step guide to installing

Pre-requisites

• You have a working Java Development Kit version 1.4 or better.

Steps

1. Download maven-1.0-rc1.zip (Windows) or maven-1.0-rc1.tar.gz ('nix) [ http://maven.apache.org/start/download.html ) ] .

2. Extract the downloaded zip to your chosen target directory. Resulting in something like:

   /usr/java/maven-1.0-rc1

   or

   c:\java\maven-1.0-rc1

3. Create a MAVEN_HOME Environment Variable and set it to the target directory created in the previous step.
   'nix: add an entry to a shell startup script, e.g. ~/.bash_profile
   Windows: set this as a 'User Variable' in your 'Environment Variables' via the Control Panel.

4. Add MAVEN_HOME\bin to your 'Path' Environment Variables similar to above.
   'nix: if 'Path' Variable already exists, add ":$MAVEN_HOME/bin" to the end of it.
   Windows: 'Path' Variable must be in 'User Variables'. If a Path Variable already exists, add ";%MAVEN_HOME%\bin" to the end of it.

5. Open a shell (known as Command Prompt in Windows) and run 'set' or 'env' to check that the Environment Variables are set correctly.
   Windows: an easy way to open a Command Prompt is 'Start\Run...', enter 'command' and press 'ok').

6. From the shell run 'install_repo.bat YOURHOMEPATH/.maven/repository'.
   Windows:

   install_repo.bat %HOMEPATH%\.maven\repository

   (On some boxes the environment variable is %HOME%, you can check this by running the 'set' command and looking for which entry points to 'C:\Documents and Settings\YOURUSERNAME'
   'nix:

   install_repo.bat ~/.maven/repository

7. From the shell run 'maven -g' to check that Maven is running - all the maven goals should be listed.

Eclipse CVS Repository Explorer: How to generate the JSDSI project

Pre-requisites

• You have Maven installed and working.

• You have downloaded and installed Eclipse .

Steps

1. Run Eclipse

2. Set up a JSDSI CVS repository in the Eclipse CVS Repository Explorer (make sure to use 'extssh' or 'ext' if you are a JSDSI Developer). [ Sourceforge's JSDSI CVS guide ]

3. In the CVS Repository Explorer select the HEAD branch of 'cvsroot/jsdsi'

4. Under the above, select the 'jsdsi' directory and right-click

5. Select 'Check Out As...'

6. Make sure 'Check out as a project configured using the New Project Wizard' is selected and press 'Finish'.

7. Select 'Java' in the left pane, 'Java Project' in the right pane, and press 'Next'

8. Enter project name 'jsdsi' in the text box and press 'Finish'. (Optionally enter an alternate project location in the 'Project Contents' information area).

9. If you are asked to switch Perspective, select 'yes'

10. Follow the steps in 'Eclipse: How to generate the JSDSI project'

Eclipse: How to generate the JSDSI project

Pre-requisites

• You can build JSDSI from Source .
• You have downloaded and installed Eclipse .

Steps

1. Edit (create if need be) your personal Maven 'build.properties' (located in your home directory), adding a 'maven.eclipse.workspace' entry with the path to your Eclipse Workspace directory, e.g.

   maven.eclipse.workspace=~/programs/eclipse-3.0-M7/workspace

   Windows: Your home directory is normally found under 'C:\Documents and Settings\YOURUSERNAME'.
   'nix: Your home directory is normally '/home/YOURUSERNAME', or for shorthand '~'.

2. Create an Eclipse Classpath Variable - in a shell 'cd' to your jsdsi project directory and run

   maven eclipse:add-maven-repo

   (About the Maven Eclipse Plugin )

3. Create the Eclipse '.project' and '.classpath' files - again in a shell within your jsdsi project directory and run:

   maven eclipse

   (About the Maven Eclipse Plugin )

4. If you have the jsdsi project open in Eclipse, right click the project name in the Package Explorer and select "Refresh."