Info |
---|
indent |
{color:green}Help is available by sending an email to [mailto: Help is available by sending an email to csf-support@mit.edu |
Panel | ||||||
---|---|---|---|---|---|---|
Quick Links to:
| ||||||
Panel | ||||||
Anchor | overview | overview | ||||
indent | 1 | 1 | ||||
*Section 1:*
|
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 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:
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 2 | 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This section deals with creating a Maven war project using the war-template. You should notice that in this section:
# Items 1 - 7 deal with checking out the war template from the SVN repository.
# Items 8 - 9 deal with renaming the war template.
# Items 10 - 17 deal with checking in the renamed project into a new SVN repository specifically for you project.
There is nothing new here and you should know how to do the above relative to the Eclipse IDE that you are using.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 1 | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*Section 2:*
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 2 | 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 1 | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*Section 3:*
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 2 | 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | | Installation of the project war component using the war-template | Installation of the project war component using the war-template |
indent | ||
---|---|---|
2 | 2 |
!setupWarTemplate002.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-common-services-framework/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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate006.jpg!
|
When satisfied that everything is correct, click Next.
The Repository Location Properties 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 |
---|
{code} svn+ssh://svn.mit.edu/es-common-services-projectsframework/es-project-template/war-template/trunk {code} |
as shown in the following panel:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate004setupWarTemplate008.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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate006setupWarTemplate010.jpg! |
When satisfied that everything is correct, click Finish.
Verify the Maven Project that is being imported. The Import Maven Projects panel should be identical to the following panel.
!setupWarTemplate008.jpg!
Your Eclipse - Project Explorer View should
look as followsnow look similar to the following:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate010setupWarTemplate011.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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate012.jpg!
|
When satisfied that everything is correct, click Yes.
Open the Eclipse
- Navigator View
* expand the *projectArtifactId* project,
* delete the *.settings* file.
Project Explorer View.
TheThe view should look as follows:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate014.jpg!
|
Right click on the war-template project and select
Refactor > Rename....
Replace
war-template with the
projectArtifactIdshort 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 | ||||
---|---|---|---|---|
| ||||
*Note*: If you haven't already do so, You might want to append a *-warweb* to the projectArtifactId *short project acronym* to denote that this is the warweb 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.jpg!
|
Right click on the renamed project and select
Team Configure > Convert to Maven Project
Expand your project and it should look similar to the following:
indent | ||||
---|---|---|---|---|
| ||||
!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:
indent | ||||
---|---|---|---|---|
| ||||
!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 | ||||
---|---|---|---|---|
| ||||
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 | ||||
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. AThis logicalis grouping would be byshown in 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 war project would be created under the *es-projects/att* directory in the SVN repository. This is shown in the following panel: 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' and 'tags')* check box.
|
The panel should be as illustrated in the following panel:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate024setupWarTemplate028.jpg! |
When satisfied that everything is correct, click
FinishNext.
Nothing to do here. This is an information panel similar to the following panel:
indent | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate026setupWarTemplate030.jpg! |
When satisfied that everything is correct, click
OK.Do the
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 | |||
---|---|---|---|
| |||
* 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.
|
| ||
!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 | ||||
---|---|---|---|---|
| ||||
!setupWarTemplate028setupWarTemplate034.jpg! |
Nothing to do here. This is an information panel similar to the following panel:
!setupWarTemplate030.jpg!
Creating the project war component using the war-template is now complete.
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section 2: Customizing the project WAR
Installation of the project war component using the war-template is now complete. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | | Customizing the project WAR | Customizing the project WAR | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 2 | 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
!customizeWar002.jpg!
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indent | 2 | 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
!customizeWar004.jpg!
|
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
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>
|
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
nameacronym 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,
projectName was replacedmy 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
log4jservlet.xml for editing and change the following lines substituting your short project
nameacronym 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
to be changed.changed should look similar to the following:
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.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">
|
<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 | ||
---|---|---|
| ||
|
<context:component-scan base-package="||
!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
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 project name for projectName.
There are
3 occurances of projectNamethat have to be
renamedchanged.
Code Block |
---|
applicationContext-projectName-component-scan.xml applicationContext-projectName-config.xml applicationContext-projectName-security-spring.xml applicationContext-projectName.xml<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
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
applicationContext-att.xml
|
Your Project Explorer View should look similar to the following:
!customizeWar006.jpg!
Rename the edu.mit.projectName.web package, substituting your project name for projectName.
Your Project Explorer View should look similar to the following:
<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.
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,
projectName was replacedmy 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
nameacronym 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,
projectName was replaced with att.*.Your Project Explorer View should look similar to the following:
my short project acronym was att so I replaced projectName with att.*.
Open the web.xml for editing and change the following lines substituting your short project name 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.xmlCustomizing 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 , save the changes and close the file.to the WAR template that are not reflected in the above documentation. One final thing to dois now complete. |