Using the WAR template

Quick Links to:

Installation overview

This document contain the instruction on how to install and configure a WAR Maven project.  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: Installation of 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 .

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.
   
   ${renderedContent}
   When satisfied that everything is correct, click Next.
   
2. Do the following:
   ${renderedContent}
   ${renderedContent}
   When done the panel should be identical to the following:
   
   ${renderedContent}
   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.
   
   ${renderedContent}
   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.
   
   ${renderedContent}
   When satisfied that everything is correct, click Finish.
   
5. When the project is opened, your Eclipse - Project Explorer View should look as follows:
   
   ${renderedContent}
   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..
   
   ${renderedContent}
   When satisfied that everything is correct, click Yes.
   
7. Open the Eclipse - Navigator View
   ${renderedContent}
8. Open the Eclipse Project Explorer View. The view should look as follows:
   
   ${renderedContent}
   Right click on the project and select Refactor > Rename....
   Replace projectArtifactId with the projectArtifactId that you have previously selected.
   
   ${renderedContent}
   
   For example: If my projectArtifactId was att, then my panel would look like the following:
   
   ${renderedContent}
   When satisfied that everything is correct, click OK.
   
9. The Eclipse - Project Explorer View should look similar to the following:
   
   ${renderedContent}
   Right click on the project and select Team > Share Project...
   
10. Select SVN as shown below:
    
    ${renderedContent}
    When satisfied that everything is correct, click Next.
    
11. Select Create a new repository location as shown below:
    
    ${renderedContent}
    When satisfied that everything is correct, click Next.
    
12. Enter a desired SVN URL for your project.
    For example:
    ${renderedContent}
    ${renderedContent}
    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:
    
    ${renderedContent}
    When satisfied that everything is correct, click OK.
    
14. Do the following:
    ${renderedContent}
    The panel should be as illustrated in the following panel:
    
    ${renderedContent}
    When satisfied that everything is correct, click Finish.
    
15. Nothing to do here.  This is an information panel similar to the following panel:
    
    ${renderedContent}
    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:
    
    ${renderedContent}
    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.
    
    ${renderedContent}
    
    

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

Section 2: Customizing the project WAR

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:
   
   ${renderedContent}
   
   
2. Expand your project, then expand src/main/resources.
   Your Project Explorer View should look similar to the following:
   
   ${renderedContent}
   
   
3. Open the applicationContext-projectName-config.xml for editing and change the following lines substituting your project name for projectName.
   The are 5 occurances of projectName that have to be changed.

   <bean id="projectNameWebMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="hibernateCsfProjectNameMappingResources">
   <bean id="projectNameWebMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="hibernateCsfProjectNameMappingResources">
   <bean id="hibernateMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="projectNameWebMappingResources">
   <value>file:$\{user.home}/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:

       <bean id="attWebMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="hibernateCsfAttMappingResources">
       <bean id="attNameWebMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="hibernateCsfAttMappingResources">
       <bean id="hibernateMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="attWebMappingResources">
       <value>file:${user.home}/att.properties</value>
       <value>file:${user.home}/att.properties</value>
   

   In the above example, projectName was replaced with att and ProjectName was replaced with Att.
   When you are satisifed with the changes, save and close the file.
4. Open the applicationContext-projectName.xml for editing and change the following lines substituting your project name for projectName.
   There are 3 occurances of projectName that have to be changed.

       <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:

       <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, projectName was replaced with att.*.
   When you are satisifed with the changes, save and close the file.
5. Open the log4j.xml for editing and change the following lines substituting your project name for projectName.
   There are 3 occurances of projectName that have to be changed.

       <param name="File" value="log/projectName.log" />
       <param name="File" value="log/csf-projectName.log" />
   

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

       <param name="File" value="log/att.log" />
       <param name="File" value="log/csf-att.log" />
   

   In the above example, projectName was replaced 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 project name for projectName.
   There is 1 occurance of projectName that has to be changed.

       <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:

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

   In the above example, projectName was replaced 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 project name for projectName.
   There are 4 files that have to be renamed.

       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:

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

   In the above example, projectName was replaced with att.*.
   Your Project Explorer View should look similar to the following:
   ${renderedContent}
8. In the Project Explorer View, expand src/main/java.
   Rename the edu.mit.projectName.web package, substituting your project name for projectName.
   Your Project Explorer View should look similar to the following:
   ${renderedContent}
9. In the Project Explorer View, expand src/test/resources.
   Open the applicationContext-config-test.xml for editing and change the following lines substituting your project name for projectName.
   There are 2 occurances of projectName that have to be changed.

       <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:

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

   In the above example, projectName was replaced with att.*.
   When you are satisifed with the changes, save and close the file.
10. From the Project Explorer View, rename the following file, substituting your project name for projectName.
    There is 1 file that has to be renamed.

        projectName-test.properties
    

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

        att-test.properties
    

    In the above example, projectName was replaced with att.*.
    Your Project Explorer View should look similar to the following:
    ${renderedContent}
11. In the Project Explorer View, expand src/main/webapp/WEB-INF.
    Open the web.xml for editing and change the following lines substituting your project name for projectName.
    There are 7 occurances of projectName that have to be changed.

        <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:

        <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, projectName was replaced with att.*.
    When you are satisifed with the changes, save and close the file.
12. Commit all changes to the SVN repository.
    

Customizing the project WAR is now complete.

Section 3: Customizing the project WAR pom.xml

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:
   ${renderedContent}
   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.