Project installation

This section describes all activities that lead to installation of our project on local PC with Eclipse platform.

Downloading and building Tudas

1. Check out Tudas project from repository.

2. Install maven.

3. Add ICE library to local maven repository. To do that, just open ./lib directory and type:

mvn install:install-file -Dfile=./Ice.jar -DgroupId=com.zeroc -DartifactId=Ice -Dversion=3.4.2 -Dpackaging=jar

4. Add JDBC library to local maven repository. Again, open ./lib directory and type

mvn install:install-file -Dfile=./ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0 -Dpackaging=jar

If jar is missing in ./lib directory, then download it yourself from: http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html

5. Our project requires ICE installed ( slice2java, slice2cpp, slice2python) to generate code from slice interface. If you don't have ICE installed, follow instruction form Ice installation site.
After installation ensure yourself, that enviroment variable ICE_HOME is set and indicates to Ice directory (e.g. Zeroc/Ice-3.4.2).

WINDOWS

If you use Windows, you will need cl compilator to compile source code of Ice and set two more enviroment variables:

VS_HOME - path to main directory of MS Visual Studio

WIN_SDK_HOME - path to main directory of Microsoft SDK (e.g. C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A)

6. To compile project, type:

mvn compile

Troubleshooting

If code from slice files are not generated, it may be ant script fault. On linux/unix paths to directories should not contain spaces, because ant may misinterpret it.

Preparing eclipse project

1. Create your eclipse project by typing:

mvn eclipse:eclipse

2. Open Eclipse and go to Classpath variables: Window->Preferences->Java->Java Build Path->Classpath varriables. Add new enviroment variable: M2_REPO that indicates to the maven repository.

3. Check if Eclipse uses appropriate JDK. It should be Java Developer Kit SE 1.6 (i. e. http://download.oracle.com/otn-pub/java/jdk/6u25-b06/jdk-6u25-windows-x64.exe).

4. Import our projects to Eclipse: File -> Import -> Existing Projects into Workspace -> Next. Check Select root directory, then Browse and point path to Tudas main directory. All projects should be automatically detected. Select them all and click Finish.

5. We use Lombok library to automatically generate getters and setters for database module. Lombok should be downloaded while maven compilation, so try to find org/projectlombok/lombok-0.11.0.jar in maven repository. Open it by double click or type:

java -jar lombok-0.11.0.jar

Click on Specify Location and set path to Eclipse. Then click Install/Upadte.

To see changes, Eclipse should be restarted and projects should be clean (Project -> Clean...).

6. Add database.properties file to src/main/resoures directory of database project. It should contain url, user and password to database:

db.url=
db.user=
db.password=

REMEMBER: do NOT commit this file to SVN Repository!

SVN repository is configured to ignore this file from src/main/resoures.

7. To manage CppClient in Eclipse, one should install C++ plugin for Eclipse and then set nature of that project as C/C++ project (File->New->C/C++-> Set Nature...). IDE should be aware of ICE header files, so remember to add them to Build path.

8. Follow steps from Configuring Eclipse IDE

Installing Tudas workspace

The workspace concept is described in User's Guide. As a developer, you can use special version of workspace with few modifications in tudas.config file (for your convenience we added several versions of Ice configuration location. You can switch them by commenting and uncommenting proper lines in the file).

Developer's workspace setup is located in Tudas/config directory. Installation process is the same as described in user's guide.