Page History

The SVN repository for the jar template has moved to svn+ssh://svn.mit.edu/es-common-services-framework/es-project-template/jar-template/trunk.
Please note that the dialog screen shots in Section 1-3, 1-5, 1-7 and 1-13 shows the old SVN location of the war-template.

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:

• Section 1:
  This section deals with creating a Maven war project using the war-template.  You should notice that in this section:
  1. Items 1 - 8 deal with checking out and disconnecting the war template from the SVN repository.
  2. Items 9 - 12 deal with cleanup, renaming the war template and converting the project to a Maven project..
  3. Items 13 - 20 deal with checking in the renamed project into a new SVN repository specifically for your project.
• Section 2:
  This section deals editing various project files and is very straight forward.
• Section 3:
  This section deals editing the project's pom.xml.
• Section 4:
  This section deals with changes that have been made to the WAR template that are not reflected in the documentation.

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

The first thing that must be done is to pick a *projectName* and a *projectArtifactId*.  These will be used throughout the life time of your project.
\\
\\
The *projectName* is a short acronym that is used to uniquely identify your project.
The *projectArtifactId* is the application context under which your project war file will be deployed to the OC4J server.
\\
\\
Once the *projectName* and *projectArtifactId* have been selected, they should not be changed.
\\
\\
Here are a few examples of what other project have used in the past:

||projectName||projectArtifactId||project description|
|ssb|sfs-ssb|student sponsored billing|
|ogs|ogs|online grade submission|
|onlinereg|onlinereg|online registration|
|iap|iap|individual activities period|

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

• This setup assumes that you have completed the Workstation configuration as found on the CSF Home - Getting Started tab.
  If you have not completed the Workstation configuration , please do so now .
  
  Please read the OVERVIEW before continuing.

1. Run Eclipse.  Go to File > New > Other....
   Scroll down to

   Maven

   SVN and expand then select

   Checkout Maven Projects

   Project from

   SCM

   SVN as shown in the following panel.

   indent
   2 2
   !setupWarTemplate002.jpg!

   When satisfied that everything is correct, click Next.

2. Do the following:

3. From the

Section 2: Customizing the project WAR

{color:red}Please read the [*OVERVIEW* | #overview] before continuing.{color}

1. Run Eclipse.  From the Project Explorer View, open the Maven WAR project that you want to customize.
   Your Project Explorer View should look similar to the following:

   indent
   2 2
   !customizeWar002.jpg!

2. Expand your project, then expand src/main/resources.
   Your Project Explorer View should look similar to the following:

   indent
   2 2
   !customizeWar004.jpg!

3. Open the applicationContext-projectName-config.xml for editing and change the following lines substituting your short project acronym for projectName.
   There are 6 occurances of projectNamethat have to be changed.

   Code Block
   <value>file:${user.dir}/projectName/projectName.properties</value> <value>file:${user.home}/projectName.properties</value> <value>file:${user.dir}/projectName/projectName.properties</value> <value>file:${user.home}/projectName.properties</value>

   When you have made all the changes, the lines you have changed should look similar to the following:

   Code Block
   <value>file:${user.dir}/att/att.properties</value> <value>file:${user.home}/att.properties</value> <value>file:${user.dir}/att/att.properties</value> <value>file:${user.home}/att.properties</value>

   In the above example, my short project acronym was att so I replaced projectName with att and ProjectName with Att.
   When you are satisifed with the changes, save and close the file.

4. Open the log4j.xml for editing and change the following lines substituting your short project acronym for projectName.
   
   

   • For Tomcat 7 implementations:
     There are 4 occurances of projectNamethat have to be changed.

     Code Block
     <param name="File" value="${logs.dir}/projectName/projectName.log" /> <param name="File" value="${logs.dir}/projectName/hbn-projectName.log" />

     When you have made all the changes, the lines you have changed should look similar to the following:

     Code Block
     <param name="File" value="${logs.dir}/att/att.log" /> <param name="File" value="${logs.dir}/att/hbn-att.log" />

     In the above example, my short project acronym was att so I replaced projectName with att and ProjectName with Att.

   • For OC4J implementations:
     Replace ${logs.dir}/projectName with log and the 2 remaining occurances of projectNamehave to be changed.

     Code Block
     <param name="File" value="${logs.dir}/projectName/projectName.log" /> <param name="File" value="${logs.dir}/projectName/hbn-projectName.log" />

     When you have made all the changes, the lines you have changed should look similar to the following:

     Code Block
     <param name="File" value="log/att.log" /> <param name="File" value="log/hbn-att.log" />

     In the above example, my short project acronym was att so I replaced projectName with att and ProjectName with Att.
     
     When you are satisifed with the changes, save and close the file.

5. Open the applicationContext-projectName.xml for editing and change the following lines substituting your short project acronym for projectName.
   There are 3 occurances of projectNamethat have to be changed.

   Code Block
   <import resource="classpath*:applicationContext-projectName-component-scan.xml" /> <import resource="classpath*:applicationContext-projectName-config.xml" /> <import resource="classpath*:applicationContext-projectName-security-spring.xml" />

   When you have made all the changes, the lines you have changed should look similar to the following:

   Code Block
   <import resource="classpath*:applicationContext-att-component-scan.xml" /> <import resource="classpath*:applicationContext-att-config.xml" /> <import resource="classpath*:applicationContext-att-security-spring.xml" />

   In the above example, my short project acronym was att so i replaced projectName with att.*.
   When you are satisifed with the changes, save and close the file.

6. Open the servlet.xml for editing and change the following lines substituting your short project acronym for projectName.
   There is 1 occurance of projectNamethat has to be changed.

   Code Block
   <context:component-scan base-package="edu.mit.projectName.web">

   When you have made the change, the line you have changed should look similar to the following:

   Code Block
   <context:component-scan base-package="edu.mit.att.web">

   In the above example, my short project acronym was att so I replaced projectName with att.*.
   When you are satisifed with the changes, save and close the file.

7. From the Project Explorer View, rename each of the following files, substituting your short project acronym for projectName.
   There are 4 files that have to be renamed.

   Code Block
   applicationContext-projectName-component-scan.xml applicationContext-projectName-config.xml applicationContext-projectName-security-spring.xml applicationContext-projectName.xml

   When you have made all the changes, the file names that you have changed should look similar to the following:

   Code Block
   applicationContext-att-component-scan.xml applicationContext-att-config.xml applicationContext-att-security-spring.xml applicationContext-att.xml

   In the above example, my short project acronym was att so I replaced projectName with att.*.
   Your Project Explorer Viewshould look similar to the following:

   indent
   2 2
   !customizeWar006.jpg!

8. In the Project Explorer View, expand src/main/java.
   Rename the edu.mit.projectName.web package, substituting your short project acronym for projectName.
   Your Project Explorer Viewshould look similar to the following:

   indent
   2 2
   !customizeWar008.jpg!

9. In the Project Explorer View, expand src/test/resources.
   Open the applicationContext-csf-unit-tests-default.xml for editing and change the following lines substituting your project name for projectName.
   There are 3 occurances of projectNamethat have to be changed.

   Code Block
   <import resource="classpath*:applicationContext-csf-projectName.xml" /> <import resource="classpath*:applicationContext-projectName.xml" /> <import resource="classpath*:applicationContext-projectName-config-test.xml" />

   When you have made all the changes, the lines you have changed should look similar to the following:

   Code Block
   <import resource="classpath*:applicationContext-csf-att.xml" /> <import resource="classpath*:applicationContext-att.xml" /> <import resource="classpath*:applicationContext-att-config-test.xml" />

   In the above example, my short project acronym was att so I replaced projectName with att.*.
   When you are satisifed with the changes, save and close the file.

10. In the Project Explorer View, expand src/test/resources.
    Open the applicationContext-projectName-config-test.xml for editing and change the following lines substituting your project name for projectName.
    There are 2 occurances of projectNamethat have to be changed.

    Code Block
    <value>classpath:projectName-test.properties</value> <value>classpath:projectName-test.properties</value>

    When you have made all the changes, the lines you have changed should look similar to the following:

    Code Block
    <value>classpath:att-test.properties</value> <value>classpath:att-test.properties</value>

    In the above example, my short project acronym was att so I replaced projectName with att.*.
    When you are satisifed with the changes, save and close the file.

11. From the Project Explorer View, rename the following file, substituting your short project acronym for projectName.
    There are 2 files that have to be renamed.

    Code Block
    applicationContext-projectName-config-test.xml projectName-test.properties

    When you have made all the changes, the file names that you have changed should look similar to the following:

    Code Block
    applicationContext-att-config-test.xml att-test.properties

    In the above example, my short project acronym was att so I replaced projectName with att.*.

12. In the Project Explorer View, expand src/main/webapp/WEB-INF.
    Open the web.xml for editing and change the following lines substituting your short project acronym for projectName.
    
    

    • There are 7 occurances of projectNamethat have to be changed.

      Code Block
      <display-name>projectName</display-name> classpath*:applicationContext-csf-projectName.xml, classpath*:applicationContext-projectName.xml <servlet-name>projectName</servlet-name> <servlet-name>projectName</servlet-name> <servlet-name>projectName</servlet-name> <servlet-name>projectName</servlet-name>

      When you have made all the changes, the lines you have changed should look similar to the following:

      Code Block
      <display-name>att</display-name> classpath*:applicationContext-csf-att.xml, classpath*:applicationContext-att.xml <servlet-name>att</servlet-name> <servlet-name>att</servlet-name> <servlet-name>att</servlet-name> <servlet-name>att</servlet-name>

      In the above example, my short project acronym was att so I replaced projectName with att.*.

    • Find the following line and change MitsisDSfor your project's JNDI name.

      Code Block
      <res-ref-name>jdbc/MitsisDS</res-ref-name>

      
      When you are satisifed with the changes, save and close the file.

13. Commit all changes to the SVN repository.

Customizing the project WAR is now complete.

Section 3: Customizing the project WAR pom.xml

{color:red}Please read the [*OVERVIEW* | #overview] before continuing.{color}

1. Run Eclipse.  From the Project Explorer View, open the Maven WAR project that you want to customize.
   Expand your project and open the project's pom.xml for editing.
   Select the pom.xml tab.
   You should have a display similar to the following panel.  From time to time the war-template is updated and, as a result, the Configuration Instructionsare changed.  The instructions found in the pom.xml will ALWAYS be up-to-date and may differ from what is display in the panel below.

   indent
   2 2
   !pomXml002.jpg!

   Follow the Configuration Instructions that are provided in the pom.xml.
   When you are satisfied with the changes that you have made, save the changes and close the file.

2. Commit the changes to the SVN repository.

Customizing the project WAR pom.xml is now complete.

Section 4: One final thing to do

There may have been changes made to the WAR template that are not reflected in the above documentation.
The final task that must be done is to search the entire project for any occurance of projectName.
Open any file that contain projectName for editing and change projectName to your short project acronym.

One final thing to do is now complete.