Versions Compared

Old Version 113

changes.mady.by.user David E Tanner

Saved on

compared with

New Version 114

changes.mady.by.user David E Tanner

Saved on

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:* | #Creating the project war component using the war-template]
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 mainly with checking out and disconnecting the war template from the SVN repository.
# Items 8 - 9 deal with mainlycleanup withand renaming the war template.
# Items 10 - 18 deal with checking in the renamed project into a new SVN repository specifically for your 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:* | #Customizing the project WAR]
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:* | #Customizing the project WAR pom.xml]
indent
2
2
This section deals editing the project's pom.xml.

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

It should take you approximately 10 - 20 minutes to get your war component created and customized.

Panel

Anchor
Creating the project war component using the war-template
Creating the project war component using the war-template

Section 1: Creating the project war component using the war-template

  1. Run Eclipse.  Go to File > New > Other....
    Scroll down to SVN and expand then select Project from SVN as shown in the following panel.
    indent
    2
    2
    !setupWarTemplate002.jpg!
    When satisfied that everything is correct, click Next.
  2. From the Checkout Project from SVN repository panel, select Create a new repository location as shown in the following panel.
    indent
    2
    2
    !setupWarTemplate004.jpg!
    When satisfied that everything is correct, click Next.
  3. In the Enter Repository Location Information panel do the following:
    for the URL: field enter:
    Code Block
        svn+ssh://svn.mit.edu/es-projects/es-project-template/war-template/trunk
    For the Label, select: use the repository URL as the label
    For the Authentication, enter your User name and password.
    indent
    2
    2
    !setupWarTemplate006.jpg!
    When satisfied that everything is correct, click Next.
  4. In the Select Resource panel, select
    Code Block
        svn+ssh://svn.mit.edu/es-projects/es-project-template/war-template/trunk
    as shown in the following panel:
    indent
    2
    2
    !setupWarTemplate008.jpg!
    When satisfied that everything is correct, click Finish.
  5. In the Check Out As panel, select Check out as a project with the name specified: as shown in the following panel.
    indent
    2
    2
    !setupWarTemplate010.jpg!
    When satisfied that everything is correct, click Finish.
  6. Your Eclipse - Project Explorer View should now look similar to the following:
    indent
    2
    2
    !setupWarTemplate011.jpg!
  7. Right click on the war-template project and select Team > Disconnect
    When the following Confirm Disconnect from SVN panel 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.
  8. Open the Eclipse - Navigator View
    indent
    2
    2
    * expand the *war-template* project,
* delete the *.settings* file.
  9. Open the Eclipse Project Explorer View.  The view should look as follows:
    indent
    2
    2
    !setupWarTemplate014.jpg!
    Right click on the war-template project and select Rename....
    Replace war-template 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.
  10. The Eclipse - Project Explorer View should look similar to the following:
    indent
    2
    2
    !setupWarTemplate018.jpg!

  11. Right click on the renamed project and select Team > Share Project...
    Select SVN as shown below:
    indent
    2
    2
    !setupWarTemplate020.jpg!
    When satisfied that everything is correct, click Next.
  12. Select Create a new repository location as shown below:
    indent
    2
    2
    !setupWarTemplate022.jpg!
    When satisfied that everything is correct, click Next.
  13. 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 Next.
  14. 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.
  15. 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 Next.
  16. 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.
  17. 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.
  18. When the SVN commit has completed, the Eclipse - Project Explorer View should look similar to the following.
    indent
    2
    2
    !setupWarTemplate034.jpg!

Creating the project war component using the war-template is now complete.

...