Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

Anchor
overview
overview

OVERVIEW

This document contain the instruction on how to install and configure your project's WAR component using the war-template.  The screen shots are taken from the Eclipse Java EE IDE for Web Developers - Version: Indigo Service Release 2 IDE.  If you are using a different version of Eclipse Java EE or a different variant of Eclipse, the screen shots may differ.  It is important to keep in mind that the following instructions should be viewed as to what has to be done rather than how to do it.

There are 3 sections to this document.  These sections are:

indent
1
1
*Section 1:*
indent
2
2
This section deals with creating a Maven war project using the war-template.  You should notice that in this section:
# Items 1 - 7 deal with checking out the war template from the SVN repository.
# Items 8 - 9 deal with renaming the war template.
# Items 10 - 17 deal with checking in the renamed project into a new SVN repository specifically for you project.

There is nothing new here and you should know how to do the above relative to the Eclipse IDE that you are using.
indent
1
1
*Section 2:*
indent
2
2
This section deals editing various project files and is very straight forward.

Again, there is nothing new here and you should know how to do the above relative to the Eclipse IDE that you are using.
indent
1
1

*Section 3:*
indent
2
2
xxxxx
Panel

Anchor
Installation of the project war component using the war-template
Installation of the project war component using the war-template

Section 1: Installation of the project war component using the war-template

  1. Run Eclipse.  Go to File > New > Other....
    Scroll down to Maven and expand then select Checkout Maven Projects from SCM as shown in the following panel.
    indent
    2
    2
    !setupWarTemplate002.jpg!
    
    When satisfied that everything is correct, click Next.
  2. Do the following:
    indent
    1
    1
    * From the *SCM URL:* dropdown, select *snv*.
    * Uncheck *Checkout All Projects*.
    * Copy and pasted the following URL into the *SCM URL:* input field.
    
    indent
    2
    2
    {code}
    svn+ssh://svn.mit.edu/es-projects/es-project-template/war-template/trunk
    {code}
    
    When done the panel should be identical to the following:
    indent
    2
    2
    !setupWarTemplate004.jpg!
    
    When satisfied that everything is correct, click Next.
  3. If you want the change the Workspace location, uncheck the Use default Workspace location and enter the path to the desired workspace.
    indent
    2
    2
    !setupWarTemplate006.jpg!
    
    When satisfied that everything is correct, click Finish.
  4. Verify the Maven Project that is being imported. The Import Maven Projects panel should be identical to the following panel.
    indent
    2
    2
    !setupWarTemplate008.jpg!
    
    When satisfied that everything is correct, click Finish.
  5. When the project is opened, your Eclipse - Project Explorer View should look as follows:
    indent
    2
    2
    !setupWarTemplate010.jpg!
    
    Right click on the project and select Team > Disconnect
  6. When following Confirm Disconnect from SVN is displayed, select Also delete the SVN meta-information from the file system..
    indent
    2
    2
    !setupWarTemplate012.jpg!
    
    When satisfied that everything is correct, click Yes.
  7. Open the Eclipse - Navigator View
    indent
    2
    2
    * expand the *projectArtifactId* project,
    * delete the *.settings* file.
    
  8. Open the Eclipse Project Explorer View. The view should look as follows:
    indent
    2
    2
    !setupWarTemplate014.jpg!
    
    Right click on the project and select Refactor > Rename....
    Replace projectArtifactId with the projectArtifactId that you have previously selected.
    indent
    2
    2
    *Note*:  You might want to append a *-war* to the projectArtifactId to denote that this is the war component of your project.
    

    For example: If my projectArtifactId was att, then my panel would look like the following:
    indent
    2
    2
    !setupWarTemplate016.jpg!
    
    When satisfied that everything is correct, click OK.
  9. The Eclipse - Project Explorer View should look similar to the following:
    indent
    2
    2
    !setupWarTemplate018.jpg!
    
    Right click on the project and select Team > Share Project...
  10. Select SVN as shown below:
    indent
    2
    2
    !setupWarTemplate020.jpg!
    
    When satisfied that everything is correct, click Next.
  11. Select Create a new repository location as shown below:
    indent
    2
    2
    !setupWarTemplate022.jpg!
    
    When satisfied that everything is correct, click Next.
  12. Enter a desired SVN URL for your project.
    For example:
    indent
    1
    1
    Keep in mind that there are at least 2 component for every project, a WAR and a JAR.
    You Should keep all project components grouped together in the same SVN directory.  A logical grouping
    would be by the projectName that you selected.  If my projectName were *att*, then the SVN
    URL would be *svn+ssh://svn.mit.edu/es-projects/att*.  This would mean that my war project
    would be created under the *es-projects/att* directory in the SVN repository.  This is shown
    in the following panel:
    
    indent
    2
    2
    !setupWarTemplate024.jpg!
    
    Don't forget to enter your User name and Password,
    When satisfied that everything is correct, click Finish.
  13. When the following panel is display notifying you that a new SVN entry will be created:
    indent
    2
    2
    !setupWarTemplate026.jpg!
    
    When satisfied that everything is correct, click OK.
  14. Do the following:
    indent
    1
    1
    * In the *Advanced Mode* section, select *Use project name*.
    * In the *Project Repository Layout* section, select *Use single project layout*.
    * Check *Use Subversion recommended layout ('trunk', 'branches' and 'tags')* check box.
    
    The panel should be as illustrated in the following panel:
    indent
    2
    2
    !setupWarTemplate028.jpg!
    
    When satisfied that everything is correct, click Finish.
  15. Nothing to do here.  This is an information panel similar to the following panel:
    indent
    2
    2
    !setupWarTemplate030.jpg!
    
    When satisfied that everything is correct, click Finish.
  16. When a panel similar to the one below is display, enter a comment.
    This is the initial SVN check-in (svn commit) for the WAR project:
    indent
    2
    2
    !setupWarTemplate032.jpg!
    
    When satisfied that everything is correct, click OK.
  17. When the SVN commit has completed, the Eclipse - Project Explorer View should look similar to the following.
    indent
    2
    2
    !setupWarTemplate034.jpg!
    

Installation of the project war component using the war-template is now complete.

...