Page History

...

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

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.

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.
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.
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.
The Repository Location Properties panel is a warning panel.
indent
2
2
!setupWarTemplate007.jpg!
You do not want to normalize the URL!
click No.
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.
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.
Your Eclipse - Project Explorer View should now look similar to the following:
indent
2
2
!setupWarTemplate011.jpg!
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.

Open the Eclipse - Navigator View

indent

	2
	2

* expand the *war-template* project,
* delete the *.settings* file.

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 short project acronym that you have previously selected. If you have not selected a short project acronym, please go to Selecting names for your project before continuing.
indent
2
2
*Note*:  If you haven't already do so, You might want to append a *-web* to the *short project acronym* to denote that this is the web component of your project.
For example: If my short project acronym was att, then my panel would look like the following:
indent
2
2
!setupWarTemplate016.jpg!
When satisfied that everything is correct, click OK.
The Eclipse - Project Explorer View should look similar to the following:
indent
2
2
!setupWarTemplate018.jpg!
Right click on the renamed project and select Configure > Convert to Maven Project
Expand your project and it should look similar to the following:
indent
2
2
!setupWarTemplate019.jpg!
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.
Select Create a new repository location as shown below:
indent
2
2
!setupWarTemplate022.jpg!
When satisfied that everything is correct, click Next.

Enter a desired SVN URL for your project.
The SVN repository that you should use is svn+ssh://svn.mit.edu/es-projects/ followed by the SVN project identifier that you had previously selected. If you have not selected a SVN project identifier, please go to Selecting names for your project before continuing.
For example:

indent

	1
	1

If my *SVN project identifier* is *academic-att*, then the SVN URL would be:
{code}
svn+ssh://svn.mit.edu/es-projects/academic-att.
{code}
This would mean that my jar project would be created under the *es-projects/academic-att* directory in the SVN repository.&nbsp;&nbsp;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.

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.

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.

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

Panel

Anchor

	Customizing the project WAR
	Customizing the project WAR

Section 2: Customizing the project WAR

indent

	1
	1

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

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!
Expand your project, then expand src/main/resources.
Your Project Explorer View should look similar to the following:
indent
2
2
!customizeWar004.jpg!

Open the applicationContext-projectName-config.xml for editing and change the following lines substituting your short project name acronym 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 my short project acronym was att so I replaced projectName with att and ProjectName was replaced with Att.
When you are satisifed with the changes, save and close the file.

Open the applicationContext-projectName.xml for editing and change the following lines substituting your short project name acronym 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 my short project acronym was att so i replaced projectName with att.*.
When you are satisifed with the changes, save and close the file.

Open the log4j.xml for editing and change the following lines substituting your short project name acronym 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 my short project acronym was att so I replaced projectName with att.*.
When you are satisifed with the changes, save and close the file.
Open the servlet.xml for editing and change the following lines substituting your short project name acronym 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 my short project acronym was att so I replaced projectName with att.*.
When you are satisifed with the changes, save and close the file.

From the Project Explorer View, rename each of the following files, substituting your short project name 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, projectName was replaced my short project acronym was att so I replaced projectName with att.*.
Your Project Explorer View should look similar to the following:

indent

	2
	2

!customizeWar006.jpg!

In the Project Explorer View, expand src/main/java.
Rename the edu.mit.projectName.web package, substituting your short project name acronym for projectName.
Your Project Explorer View should look similar to the following:
indent
2
2
!customizeWar008.jpg!
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 my short project acronym was att so I replaced projectName with att.*.
When you are satisifed with the changes, save and close the file.
From the Project Explorer View, rename the following file, substituting your short project name acronym 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 my short project acronym was att so I replaced projectName with att.*.
Your Project Explorer View should look similar to the following:
indent
2
2
!customizeWar010.jpg!

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 name acronym 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 my short project acronym was att so I replaced projectName with att.*.
When you are satisifed with the changes, save and close the file.

Commit all changes to the SVN repository.

Customizing the project WAR is now complete.

...

Child pages

Versions Compared

Old Version 121

New Version 122

Key

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

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

Section 2: Customizing the project WAR

Customizing the project WAR is now complete.