Information

Created in: 2007-06-03 20:15:07

Author: martin

Size: 0 bytes

Last updated: 2007-06-03 20:15:07

Categories

Developers

You may be interested in...

jLibrary Developers Guide

jLibrary developers first steps (updated to jLibrary 1.0 beta4)

These are the basic steps to get started with jLibrary. I'm using Microsoft Windows for this tutorial but any other platform with Eclipse support would also be valid. If you find any mistakes, or if you think that something here is not correct, please send me an email to mpermar_AT_gmail_DOT_com. Here are the necessary steps:

1. Download and install Eclipse SDK 3.1.1. This is mandatory. You can also try another version, but this is the last tested one. Currently, you can find this Eclipse version here: http://www.eclipse.org/downloads/download.php?file=/eclipse/downloads/drops/R-3.1.1-200509290840/eclipse-SDK-3.1.1-win32.zip
   
   
2. Download and insta Eclipse GEF SDK 3.1.1. GEF is needed because contains draw2d libraries. At this time, you can grab it from http://download.eclipse.org/tools/gef/downloads/drops/R-3.1.1-200509301327/index.php.
   
   
3. Now you can start Eclipse. The next step is to download jLibrary sources from sourceforge.net CVS. To do this, you have to open the CVS perspective and create a new CVS location with the following data:
   
   If you are already a jlibrary developer, then you must enter your sourceforge.net id and password and use extssh protocol. If you are not a jlibrary developer (normal case), then you must use login anonimously and using pserver protocol. There are detailed instructions about how to connect as anonymous on http://sourceforge.net/cvs/?group_id=95837. Note that it seems that Eclipse requires a password for anonymous connections. For me it worked entering some email direction as test@test.com. Of course, to get write privileges you should contact with me proving your interest on the project. :-)
   
   
4. Now, open the HEAD branch on the CVS location that you have created. You'll see nine different modules. But you have only to download the following ones (of course, you can also download all :-)):
   
   - base-deploy: base code used for automation builds and deployment.
   - org.jlibrary.client: core client code
   - org.jlibrary.client.nl1: internationalized resources, currently have spanish and french data
   - org.jlibrary.intro: intro pages
   - org.jlibrary.intro.nl1: internationalized resources for the intro pages
   - org.jlibrary.server: core server code
   
   The other modules are related to automatically update and the org.jlibrary.webclient module is currently starting again its development.
   
   To checkout the modules simply right click over them and choose the Checkout menu option. The modules have appropiate project information so it should be checked out as Eclipse projects automatically.
   Well, you must checkout all these modules using the module names as project names. Normally, I checkout org.jlibrary.client and org.jlibrary server as Java projects (checkout as..., new project from wizard, java project, and remember to create separate src/bin folders), and the other modules as normal projects (checkout).
   
   If you are using anonymous id, note that sourceforge.net has many problems with pserver connections. So if you are getting timeout or connection errors the only solution is retry and retry and retry. In fact, I had to try several times to be able to download the project sources :-(
   
   After this, you should end with something like:
   
   
   
   jLibrary CVS projects come with .project/.classpath bundled files so you should not get neither compilation errors nor problems.
   
   
5. Finally, we're going to run jLibrary. We have to create a new Run Configuration from the Run... menu:
   
   
   
   Now, you have to create a new configuration. You can call it jLibrary or any other name. On the radio buttons section check run a product, and on the combobox select org.jlibrary.client.product as product value:
   
   
   
   That's ok. Now, jLibrary needs to know where to find the configuration (/conf) directory. There are two sample configuration directories on the base-deploy project. One is under base-deploy/rcp directory and the other one is under base-deploy/tomcat/ webapps/jlibrary/WEB-INF/repository directory. jLibrary will look for the conf directory just under the value of the JLIBRARY_HOME environment variable. So, you can set that variable to point to this directories, but that won't be a good thing because then jLibrary will create several stuff on that directories, and I'm sure that you want to keep your modules clean :-)
   
   So, copy one of those conf directories to a place on your file system, for example /temp/jlibrary (for example you should end with a c:/temp/temp/jlibrary/conf directory), and then set the -Djlibrary.home parameter pointing to that directory. You have also to set the -Djava.security.auth.login.config pointing to the jaas.config file on that conf directory. Optionally, you can also set your prefered language to one of the jlibrary supported ones. Here is a sample complete run configuration:
   
   
   
   
   Now, go to the plug-ins tab and press the button Add required plug-ins. This would fill for you all the dependencies.
   
   
   
   Press Apply, and Run. And finally, jLibrary will start!
   
   
   

Well, if you have reached this step I have to give you congratulations.

You're now able to become a jLibrary developer :-)