Info |
---|
indent |
{color:green}Help is available by sending an email to [mailto: Help is available by sending an email to ]{color} {color:green}Have any suggestion on how improve this wiki? Please give us your feedback at [mailto:
|
Panel | ||||||
---|---|---|---|---|---|---|
Quick Links to:
|
Note |
---|
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. |
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OVERVIEWThis document contain the instruction on how to install and configure your project's WAR component using the war-template. The screen shots are taken | |||||||||||||||
Panel | |||||||||||||||
Anchor | | overview | overview |
indent | ||||
---|---|---|---|---|
|
[*||||
|
- This
- section
- deals
- with
- creating
- a
- Maven
- war
- project
- using
- the
- war-template.
[*Section 2:* | #Customizing the project WAR]
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 WAR 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 war component created and customized.
- You should notice that in this section:
- Items 1 - 8 deal with checking out and disconnecting the war template from the SVN repository.
- Items 9 - 12 deal with cleanup, renaming the war template and converting the project to a Maven project..
- 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.
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section 1: Creating the project war component using the war-template
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | | Creating the project war component using the war-template | Creating the project war component using the war-template | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 2 | 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
!setupWarTemplate002.jpg!
|
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate004setupWarTemplate006.jpg! |
When satisfied that everything is correct, click Next.
In theThe Repository Location
InformationProperties panel is a warning panel.
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate007.jpg!
|
You do not want to normalize the URL!
click No.
In the Select Resourcepanel, select
Code Block |
---|
for the URL: field enter:
Code Block |
---|
svn+ssh://svn.mit.edu/es-common-services-projectsframework/es-project-template/war-template/trunk |
For the Authentication, enter your User name and password.
as shown in the following panel:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate006setupWarTemplate008.jpg! |
When satisfied that everything is correct, click
NextFinish.
In the Check Out As panel, select Check out as a project with the name specified: as shown in the following panel.
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate007setupWarTemplate010.jpg! |
click No.
In the Select Resource panel, select
Code Block |
---|
svn+ssh://svn.mit.edu/es-projects/es-project-template/war-template/trunk
|
When satisfied that everything is correct, click Finish.
Your Eclipse - Project Explorer View should now look similar to the following:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate008setupWarTemplate011.jpg! |
In the Check Out As panel, select Check out as a project with the name specified: as shown in the following panel
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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate010setupWarTemplate012.jpg! |
When satisfied that everything is correct, click
FinishYes.
Open the Eclipse
-Project Explorer View. The view should
now look similar to the followinglook as follows:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate011setupWarTemplate014.jpg! |
Right click on the war-template project and select
Team > DisconnectWhen the following Confirm Disconnect from SVN panel is displayed, select Also delete the SVN meta-information from the file system.
!setupWarTemplate012.jpg!
Rename....
Replace war-template with the 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 | ||||
---|---|---|---|---|
| ||||
* expand the *war-template* project,
* delete the *.settings* file.
|
*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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate016.jpg!
|
When satisfied that everything is correct, click OK.
The Eclipse - Project Explorer View should look similar to the following:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate018!setupWarTemplate014.jpg! |
Right click on the
war-templaterenamed project and select
Rename....Replace war-template with the 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.
Configure > Convert to Maven Project
Expand your project and it should look similar to the following:
indent | ||||
---|---|---|---|---|
| ||||
*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.
| ||||
!setupWarTemplate019.jpg!
|
Right click on the renamed project and select Team > Share Project...
Select SVN as shown below:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate020.jpg!
|
When satisfied that everything is correct, click Next.
Select Create a new repository location as shown below:
For example: If my short project acronym was att, then my panel would look like the following:indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate016setupWarTemplate022.jpg! |
When satisfied that everything is correct, click
OKNext.
Enter a desired SVN URL for your project.
The
!setupWarTemplate018.jpg!
Expand your project and it should look
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 | ||||
---|---|---|---|---|
| ||||
If my *SVN project identifier* is *academic-att*, then the SVN URL would be:
{code}
svn+ssh://svn. |
!setupWarTemplate019.jpg!
Select SVN as shown below:
!setupWarTemplate020.jpg!
Select Create a new repository location as shown below:
!setupWarTemplate022.jpg!
Enter a desired SVN URL for your project.
The SVN repository that you should use is svn+ssh://svn.
mit.edu/es-projects/ |
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/academic-att. {code} This would mean that my jar project would be created under the *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. This is shown in the following * directory in the SVN repository. This is shown in the following panel: |
indent | ||||
---|---|---|---|---|
| ||||
!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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate026.jpg!
|
When satisfied that everything is correct, click OK.
Do the following:
indent | ||||
---|---|---|---|---|
| ||||
* 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', 'branches' and 'tags')* check box. |
and 'tags')* check box.
|
The panel should be as illustrated in the following panel:
indent | ||||
---|---|---|---|---|
| ||||
!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 | ||||
---|---|---|---|---|
| ||||
!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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate028setupWarTemplate032.jpg! |
When satisfied that everything is correct, click
NextOK.
Nothing to do here. This is an information panel similar to the following panel:
!setupWarTemplate030.jpg!
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
When the SVN commit has completed, the Eclipse - Project Explorer View should look similar to the following.
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate034.jpg!
|
Creating the project war component using the war-template is now complete.
Panel | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section 2: Customizing the project WAR
Creating the project war component using the war-template is now complete. | |||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||
Anchor | | Customizing the project WAR | Customizing the project WAR | ||||||||||||||||||||||||
indent | 1 | 1 | |||||||||||||||||||||||||
{color:red}Please read the [*OVERVIEW* | #overview] before continuing.{color}
| |||||||||||||||||||||||||||
indent | 2 | ||||||||||||||||||||||||||
!customizeWar002.jpg!
| |||||||||||||||||||||||||||
indent | 2 | 2 | |||||||||||||||||||||||||
!customizeWar004.jpg!
|
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.
The are 5
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.
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.
Open the
log4j servlet.xml for editing and change the following lines substituting your short project acronym for projectName.
There
is 1 occurance of projectNamethat
havehas to be changed.
Code Block |
---|
<param name="File" value="log/projectName.log" />
<param name="File" value="log/csf-projectName.log" />
|
Code Block |
---|
<param name="File" value="log/att.log" />
<param name="File" value="log/csf-att.log" />
|
When you are satisifed with the changes, save and close the file.
There is 1 occurance of projectName that has to be changed.
Code Block |
---|
<context:component-scan base-package="edu.mit.projectName.web">
|
Code Block |
---|
<context:component-scan base-package="edu.mit.att.web">
|
When you are satisifed with the changes, save and close the file.
<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.
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 | ||||
---|---|---|---|---|
| ||||
!customizeWar006.jpg!
|
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 | ||||
---|---|---|---|---|
| ||||
!customizeWar008.jpg!
|
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" /> |
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 thatlines 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 <import resource="classpath*:applicationContext-csf-att.xml" /> <import resource="classpath*:applicationContext-att.xml |
Your Project Explorer View should look similar to the following:
!customizeWar006.jpg!
Rename the edu.mit.projectName.web package, substituting your short project acronym for projectName.
Your Project Explorer View should look similar to the following:
" />
<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.
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.
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.*.
Your Project Explorer View should look similar to the following:
!customizeWar010.jpg!
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.
Customizing the project WAR is now complete.
Panel | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section 3: Customizing the project WAR pom.xml
Customizing the project WAR pom.xml is now complete. |
Panel | ||||||
---|---|---|---|---|---|---|
Section 4: One final thing to doThere may have been changes made to the JAR WAR template that are not reflected in the above documentation. One final thing to do is now complete. |