Eclipse

Eclipse Setup

A demonstration of installing and configuring Eclipse 3.7 for working with most Jasig projects.

Many progress bars and wait times are cut out of the video.

Detailed Instructions

These instructions correspond to the times and subtitles in the demo video.

 0:00 - 0:40 - Download & Extract Eclipse

Download Eclipse IDE for Java EE Developers from: http://www.eclipse.org/downloads/

 0:40 - 0:55 - Create a new Eclipse Workspace

Select the location to store your projects

 0:55 - 1:35 - Install Subclipse SVN Client Plugin
  1. Go to the Help > Eclipse Market Place... menu
  2. Search for Subversion
  3. Scroll to the Subclipse entry and click on the Install button
  4. Agree to the license, click through the following dialogs and click the Restart Now button when it appears.
 1:35 - 2:05 - Ubuntu Specific: Install Java-Subversion Library

If using Ubuntu, or likely other flavors of Linux, the libsvn-java library needs to be installed. If you are not using Linux please ignore this step.

 2:05 - 3:05 - Install Spring Tool Suite
  1. Download the Spring Tool Suite Installation Instructions
  2. Find the Installing from the Release Update Site section
  3. Find the URL for the bookmarks.xml file for Eclipse 3.7 (http://dist.springsource.com/release/TOOLS/composite/e3.7/bookmarks.xml)
  4. Save this file to your computer
  5. In Eclipse go to the Window > Preferences > Install/Update > Available Software" options and click on the *Import... button.
  6. Select the bookmarks.xml file you just downloaded
  7. Go to the Help > Install New Software... menu
  8. Select the SpringSource Update Site for Eclipse 3.7 option from the Work with: drop down box
  9. Click the Select All button and then the Next > button
  10. Agree to the license, click through the following dialogs and click the Restart Now button when it appears.
 3:05 - 3:38 - Install Maven 2 Eclipse Integration (M2E)
  1. Go to the M2E Project Site and follow the Download link
  2. Copy the update site URL (http://download.eclipse.org/technology/m2e/releases)
  3. In Eclipse go to the Help > Install New Software... menu
  4. Paste the update site URL into the Work with: drop down box and press enter.
  5. Click the Select All button and then the Next > button
  6. Agree to the license, click through the following dialogs and click the Restart Now button when it appears.
 3:38 - 4:05 - Install Sysdeo Tomcat Plugin
  1. Go to the Sysdeo Tomcat Plugin Site
  2. Scroll to the Download section and download the latest release.
  3. Extract the downloaded file and move the resulting com.sysdeo.eclipse.tomcat_3.3.0 folder into the eclipse/plugins directory.
  4. Manually restart eclipse
 4:05 - 4:33 - Workspace Setup

Customize your Eclipse workspace UI according to your preferences.

These instructions were last updated on 7/22/2011

uPortal Project Setup

A demonstration of checking out and configuring uPortal 4 in Eclipse. This video assumes the setup in the Eclipse Setup video above was followed.

Many progress bars and wait times are cut out of the video.

Detailed Instructions

These instructions correspond to the times and subtitles in the demo video.

 0:00 - 0:12 - Starting Eclipse

.

 0:12 - 0:52 - Checkout uPortal trunk
  1. Switch to the SVN Repository Exploring perspective
  2. Navigate to the uPortal/trunk folder in the Jasig SVN repository (https://source.jasig.org/)
  3. Right click on the trunk folder and select Checkout... from the menu
  4. Use the New Project Wizard option on the Checkout from SVN dialog and click the Finish button
  5. Under the General folder select Project and click the Next > button
  6. Name the project uPortal_trunk and click Next > then Finish
 0:52 - 1:02 - Create uPortal_trunk Working Set
  1. Right Click on the uPortal_trunk project and select the Assign working sets... option.
  2. Click on the New... button
  3. Select the Java working set type
  4. Name the working set uPortal_trunk and click the Finish button
    NOTE: See the Switch to Working Sets View section of the uPortal 3.2 video
 1:02 - 1:12 - Configure as Maven Project
  1. Right Click on the uPortal_trunk project and select the Configure > Convert to Maven Project option.
 1:12 - 1:41 - Import Child Projects
  1. Right Click on the uPortal_trunk project and select the Import... option.
  2. Expand the Maven folder and select the Existing Maven Projects option, then click Next >
  3. Click the Deselect All button since uPortal creates a lot of little Maven overlay projects that aren't useful to import.
  4. Select the uportal-war and uportal-search-api projects
  5. Expand the Advanced section and select the Name template: artifactId-TRUNK, then click Next >
  6. Click Finish. You can ignore the warnings about missing Maven plugin connectors.
 1:41 - 2:10 - Install M2E Build Helper Extension
  1. You will be prompted to install the m2e connector for build-helper-maven-plugin
  2. Click the Finish button on this dialog, accept the license and OK on the following prompt.
  3. Restart Eclipse when prompted
 2:10 - 3:00 - Install M2E JAXB Extension
  1. In Eclipse go to the Help > Install New Software... menu
  2. Paste the URL https://github.com/hwellmann/m2eclipse-extras/raw/master/p2/ into the Work with: drop down box and press enter.
  3. Expand the Omadac m2e Extensions option
  4. Select the m2e Connector for JAXB
  5. Click the Next > button until you get to the license, accept the license and click Finish
  6. Restart Eclipse when prompted
 3:00 - 3:34 - Update Search API Project Configuration
  1. Right click on the uportal-search-api project select the Maven > Update Project Configuration... menu option and click OK on the following prompt
  2. After the Eclipse finishes updating go the Project > Clean menu.
  3. Select the Clean projects selected below box and then select only the uportal-search-api project and click OK
  • When Eclipse finishes updating you should see an additional target/generated-sources/xjc source folder in the project, this folder contains Java source files generated by the XJC tool from the XML schemas in the project.
 3:34 - 4:03 - Update WAR Project Configuration
  1. Right click on the uportal-war project select the Maven > Update Project Configuration... menu option and click OK on the following prompt
  2. After the Eclipse finishes updating go the Project > Clean menu.
  3. Select the Clean projects selected below box and then select only the uportal-war project and click OK
  • When Eclipse finishes updating you should see an additional target/generated-sources/xjc source folder in the project, this folder contains Java source files generated by the XJC tool from the XML schemas in the project.
 4:03 - 5:02 - M2E Processor Plugin Work-Around
  • uPortal 4 uses the JPA2 MetaModel for type-safe query building. The maven-processor-plugin is used to generate Java source files for this meta model but there is not yet support for the plugin in m2e. The following is a work-around for getting the project working correctly in Eclipse.
  • The video shows downloading and setting up Maven for this step, if you do not have Maven installed it is required to work with uPortal.
  1. Open a command line window and navigate to the uPortal_trunk/uportal-war project directory
  2. Run the command "mvn clean compile" this will trigger generation of the uPortal JPA2 Meta Model
  3. In Eclipse right click on the uportal-war project and select Refresh from the menu
  • When Eclipse finishes refreshing the project a target/generated-sources/annotations directory should be visisble.

These instructions were last updated on 7/22/2011