Page History

OVERVIEW

This document contain the instruction on how to install and configure your project's WAR JAR component using the jar-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:* | #Creating the project jar component using the jar-template]

This section deals with creating a Maven jar project using the jar-template.  You should notice that in this section:
# Items 1 - 8 deal with checking out and disconnecting the jar template from the SVN repository.
# Items 9 - 10 deal with cleanup and renaming the jar template.
# Items 11 - 19 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.

[*Section 2:* | #Customizing the project JAR]

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.

[*Section 3:* | #Customizing the project JAR pom.xml]

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 jar component created and customized.

Section 1: Creating the project

jar component using the

jar-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 SVN and expand then select Project from SVN as shown in the following panel.
   

   indent
   2 2
   !setupJarTemplate002.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
   !setupJarTemplate004.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/jar-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
   !setupJarTemplate006.jpg!

   When satisfied that everything is correct, click Next.
   
4. The Repository Location Properties panel is a warning panel.
   

   indent
   2 2
   !setupJarTemplate007.jpg!

   You do not want to normalize the URL!
   click No.
   
5. In the Select Resource panel, select

   Code Block
   svn+ssh://svn.mit.edu/es-projects/es-project-template/jar-template/trunk

   as shown in the following panel:
   

   indent
   2 2
   !setupJarTemplate008.jpg!

   When satisfied that everything is correct, click Finish.
   
6. 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
   !setupJarTemplate010.jpg!

   When satisfied that everything is correct, click Finish.
   
7. Your Eclipse - Project Explorer View should now look similar to the following:
   

   indent
   2 2
   !setupJarTemplate011.jpg!

8. Right click on the jar-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
   !setupjarTemplate012.jpg!

   When satisfied that everything is correct, click Yes.
9. Open the Eclipse - Navigator View

   indent
   2 2
   * expand the *jar-template* project, * delete the *.settings* file.

10. Open the Eclipse Project Explorer View.  The view should look as follows:
    

    indent
    2 2
    !setupJarTemplate014.jpg!

    Right click on the jar-template project and select Rename....
    Replace jar-template with the projectArtifactId that you have previously selected.
    

    indent
    2 2
    {color:red}Prefix a *csf-* to the projectArtifactId to denote that this is the jar component of your project.{color}

    
    For example: If my projectArtifactId was att, then my panel would look like the following:
    

    indent
    2 2
    !setupJarTemplate016.jpg!

    When satisfied that everything is correct, click OK.
    
11. The Eclipse - Project Explorer View should look similar to the following:
    

    indent
    2 2
    !setupJarTemplate018.jpg!

12. Right click on the renamed project and select Team > Share Project...
    Select SVN as shown below:
    

    indent
    2 2
    !setupJarTemplate020.jpg!

    When satisfied that everything is correct, click Next.
    
13. Select Create a new repository location as shown below:
    

    indent
    2 2
    !setupJarTemplate022.jpg!

    When satisfied that everything is correct, click Next.
    
14. 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 jar project would be created under the *es-projects/att* directory in the SVN repository.  This is shown in the following panel:

    indent
    2 2
    !setupJarTemplate024.jpg!

    Don't forget to enter your User name and Password,
    When satisfied that everything is correct, click Next.
    
15. When the following panel is display notifying you that a new SVN entry will be created:
    

    indent
    2 2
    !setupJarTemplate026.jpg!

    When satisfied that everything is correct, click OK.
    
16. 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
    !setupJarTemplate028.jpg!

    When satisfied that everything is correct, click Next.
    
17. Nothing to do here.  This is an information panel similar to the following panel:
    

    indent
    2 2
    !setupJarTemplate030.jpg!

    When satisfied that everything is correct, click Finish.
    
18. When a panel similar to the one below is display, enter a comment.
    This is the initial SVN check-in (svn commit) for the JAR project:
    

    indent
    2 2
    !setupJarTemplate032.jpg!

    When satisfied that everything is correct, click OK.
    
19. When the SVN commit has completed, the Eclipse - Project Explorer View should look similar to the following.
    

    indent
    2 2
    !setupJarTemplate034.jpg!

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

Section 2: Customizing the project

JAR

{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 project name for projectName.
   The are 5 occurances of projectName that have to be changed.

   Code Block

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

   Code Block

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

   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, 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.

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

   Code Block
   <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.

   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, 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.

   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, projectName was replaced with att.*.
   Your Project Explorer View should 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 project name for projectName.
   Your Project Explorer View should look similar to the following:

   indent
   2 2
   !customizeWar008.jpg!

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.

   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, 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.

    Code Block
    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
    att-test.properties

    In the above example, projectName was replaced with att.*.
    Your Project Explorer View should look similar to the following:

    indent
    2 2
    !customizeWar010.jpg!

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.

    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, 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.