- *JDK 1.5 or above installed* (Required for Maven Eclipse plugin to work properly) - *Eclipse IDE 3.3.x or above* (Can be downloaded from: http://www.eclipse.org/downloads/) - *Maven M2Eclipse plugin for Eclipse* (You can install the latest version from within maven using the following update site from within Eclipse: http://m2eclipse.sonatype.org/update/) - *SVN Subclipse Plugin Eclipse* (Instructions on installing Subclipse plugin can be found here: http://subclipse.tigris.org/servlets/ProjectProcess?pageID=p4wYuA)
- Create an Eclipse shortcut - Right-Click your Eclipse shortcut and select *Properties* - *At the end of the line that says Target, add -vm "x" where x is the location of a JDK (e.g., "C:\Program Files\Java\jdk1.6.0_13\bin"). This step is necessary for the Maven plugin to work* - *Restart Eclipse using the edited shortcut.*
- Importing the ESAPI Source from Google SVN:*
If you choose to use the ESAPI SVN code, follow the instructions here<http://code.google.com/p/owasp-esapi-java/source/checkout>. Unless you have been added to the ESAPI project as a contributor, please use the bottom SVN checkout link on the Google Code page (non-SSL).
If you are using subclipse, as recommended, open Eclipse and:
- Click *File* -> *New* -> *Other....*. - From the *SVN Folder* select '"Checkout Projects from SVN* (this option will only be available if you have a SVN plugin installed) and hit *Next >*.* - Click the *Create a new repository location* radio button. - If you are not listed as a project contributor, insert * http://owasp-esapi-java.googlecode.com/svn/trunk/* as the URL. If you are listed as a project contributor, check the Google Code page for the URL to use. (Note: if you are a contributor, when prompted for your SVN password, use your Google generated password, available from the Google Code Source page.) - Once the directory structure appears in the window, click the URL at the top to download everything. Then hit *Next >* - Select your desired project options. For most people, the default options should be fine. When finished, click *Next >*. - Select your desired workspace options, then click *Finish*. The latest ESAPI source files will then be downloaded to your workspace. This may take a few minutes.
Building ESAPI should be easy with the new Maven integration.
Once your environment is set up, as specified above:
1. Right-Click your ESAPI project root folder 2. Select *Run As...* 3. Select *Run Configurations* 4. Double Click "Maven Build" from the options on the left to create a new configuration. 5. Name your configuration at the top. This will be for building ESAPI without running JUnit tests. 6. The "Base directory" should point to the root of your project 7. The "Goals" field type "package" 8. From the checkboxes below, check "Skip Tests" 9. Any options not mentioned should be left as their default 10. Click "Apply" to save your build configuration 11. Click "Run" to run your configuration
NOTE: Jars created through building are located in the directory called "target".