Page History

Info
Help is available by sending an email to csf-support@mit.edu Have any suggestion on how improve this wiki? Please give us your feedback at csf-support@mit.edu

Panel

Quick Links to:

Table of Contents

minLevel	3
maxLevel	3

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. Please note that the dialog screen shots in Section 1-3, 1-5, 1-7 and 1-13 shows the old SVN location of the jar-template.

Panel

Anchor

	overview
	overview

OVERVIEW

This document contain the instruction on how to install and configure your project's 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:
This section deals with creating a Maven jar project using the jar-template. You . There is nothing new here and you should know how to do the above relative to the Eclipse IDE that you are using.
You should notice that in this section:
1. Items 1 - 8 deal with checking out and disconnecting the jar template from the SVN repository.
2. Items 9 - 12 deal with cleanup, renaming the jar template and converting the project to a Maven project.
3. Items 13 - 20 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:
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:
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
Section 4:
This section deals with changes that have been made to the JAR template that are not reflected in the documentation.

It should take you approximately 10 - 20 minutes to get your jar component created and customized.

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

!setupJarTemplate004.jpg!

Image Added
When satisfied that everything is correct, click Next.

In the Enter Repository Location Information panel do the following:
for the URL:field enter:

Panel

Anchor

	Creating the project jar component using the jar-template
	Creating the project jar component using the jar-template

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.

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


!setupJarTemplate002.jpg!

indent

2

Code Block
svn+ssh://svn.mit.edu/es-projectscommon-services-framework/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.

indent22 !setupJarTemplate006.jpg!

Image Added

When satisfied that everything is correct, click Next.

The Repository Location Properties panel is a warning panel.
indent22 !setupJarTemplate007.jpg!

Image Added
You do not want to normalize the URL!
click No.

In the Select Resourcepanel, select

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

as shown in the following panel:

indent22


!setupJarTemplate008.jpg!

Image Added
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.
indent22


!setupJarTemplate010.jpg!

Image Added
When satisfied that everything is correct, click Finish.

Your Eclipse - Project Explorer View should now look similar to the following:

Image Added

indent22


!setupJarTemplate011.jpg!

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


!setupjarTemplate012.jpg!

Image Added
When satisfied that everything is correct, click Yes.

Open the Eclipse - Navigator View indent22


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

Open the Eclipse Project Explorer View. The view should look as follows:
indent22 !setupJarTemplate014.jpg!

Image Added
Right click on the jar-template project and select Rename....
Replace jar-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.
Prefix a csf- to the short project acronym to denote that this is the jar component of your project.
For example: If my short project acronym was att, then my panel would look like the following:
indent22 !setupJarTemplate016.jpg!

Image Added
When satisfied that everything is correct, click OK.

The Eclipse - Project Explorer View should look similar to the following:

Image Added

Minimize your IDE, and open Windows Explorer (user finder on the MAC). Navigate to the home directory of your jar project. With a text editor, open the .projectfile. Find the following line:

Code Block
<name>jar-template</name>

and replace jar-template with the short project acronym that you have previously selected.
Prefix a csf- to the short project acronym to denote that this is the jar component of your project.
For example: If my short project acronym was att, then the line would look like the following:

Code Block
<name>csf-att</name>

When you are satisfied that everything is correct, save your change and close the .project file.
Maximize your IDE.

indent22


!setupJarTemplate018.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:
indent22 !setupJarTemplate019.jpg!

Image Added

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


!setupJarTemplate020.jpg!

Image Added
When satisfied that everything is correct, click Next.

Select Create a new repository location as shown below:
indent22 !setupJarTemplate022.jpg!

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

indent11 If my *SVN project identifier* is *

If my SVN project identifier is academic-att

*

,

then

the

SVN

URL

would

be:

{

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

*

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

1

{color:red}
Please

read

the
[*
OVERVIEW
* | #overview]
before

continuing.
{color}
Run Eclipse. From the Project Explorer View, open the Maven JAR project that you want to customize.
Your Project Explorer View should look similar to the following:
Image Added

Expand your project, then expand src/main/resources.
Your Project Explorer View should look similar to the following:
!customizeJar004.jpg!

Image Added

Open the applicationContext-csf-projectName

-config

.xml for editing and change the following lines substituting your short project acronym for projectName.

The are 3 occurances of projectName that have to be changed.

Panel

Anchor

	Customizing the project JAR
	Customizing the project JAR

Section 2: Customizing the project JAR

indent

1

indent

2


!customizeJar002.jpg!

indent

2

Code Block


    <bean id="csfProjectNameMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="commonHibernateMappingResources">
    <bean id="hibernateCsfProjectNameMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="csfProjectNameMappingResources">

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

Code Block


    <bean id="csfAttMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="commonHibernateMappingResources">
    <bean id="hibernateCsfAttMappingResources" class="org.springframework.beans.factory.config.ListFactoryBean" parent="csfAttMappingResources">

In the above example, ProjectName was replaced with the short project acronym Att.
When you are satisifed with the changes, save and close the file.Open the applicationContext-csf-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-csf-projectName-component-scan.xml" />
    <import resource="classpath*:applicationContext-csf-projectName-config.xml" />
    <import resource="classpath*:applicationContext-csf-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-csf-att-component-scan.xml" />
    <import resource="classpath*:applicationContext-csf-att-config.xml" />
    <import resource="classpath*:applicationContext-csf-att-security-spring.xml" />

In the above example, projectName was replaced with the short project acronym att.
When you are

satisifed

satisfied 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-csf-projectName.xml applicationContext-csf-projectName-component-scan.xml applicationContext-csf-projectName-config.xml applicationContext-csf-projectName-security.xml

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

Code Block
applicationContext-csf-att.xml applicationContext-csf-att-component-scan.xml applicationContext-csf-att-config.xml applicationContext-csf-att-security.xml

In the above example, projectName was replaced with the short project acronym att.
Your Project Explorer View should look similar to the following:
Image Added
When you are satisfied with the changes, save and close the file.

From 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 short project acronym for projectName.
There are 2 occurances of projectNamethat have to be changed.

Code Block
<import resource="classpath:applicationContext-csf-projectName.xml" /> <import resource="classpath:applicationContext-csf-projectName-config-test.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-csf-att.xml" /> <import resource="classpath:applicationContext-csf-att-config-test.xml" />

When you are satisfied with the changes, save and close the file.

From the Project Explorer View, expand src/test/resources. Open the applicationContext-csf-projectName-config-test.xml for editing and change the following lines substituting your short project acronym for projectName.
There are 2 occurances of projectNamethat have to be changed.

Code Block
<value>classpath:csf-projectName-test.properties</value> <value>classpath:csf-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:csf-att-test.properties</value> <value>classpath:csf-att-test.properties</value>
indent
2	2	!customizeJar006.jpg!

When you are

satisifed

satisfied 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 2 files that have to be renamed.

Code Block
applicationContext-csf-projectName-config-test.xml csf-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-csf-att-config-test.xml csf-att-test.properties

Commit all changes to the SVN repository.

Customizing the project JAR is now complete.

{color:red}

Please

read

the

[*

OVERVIEW

* | #overview]

before

continuing.

{color}

Run Eclipse. From the Project Explorer View, open the Maven JAR 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 panel. From time to time the jar-template is updated and, as a result, the Configuration Instructions are changed. The instructions found in the pom.xml will ALWAYS be up-to-date and may differ from what is display in the panel below.

!jarPomXml002.jpg!

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

Commit the changes to the SVN repository.

Customizing the project JAR pom.xml is now complete.

Panel

Anchor

	Customizing the project JAR pom.xml
	Customizing the project JAR pom.xml

Section 3: Customizing the project JAR pom.xml

indent

1

indent

2

Panel

Anchor

	One final thing to do
	One final thing to do

Section 4: One final thing to do

There may have been changes made to the JAR template that are not reflected in the above documentation.
The final task that must be done is to search the entire project for any occurance of projectName.
Open any file that contain projectName for editing and change projectName to your short project acronym.

Child pages

Versions Compared

Old Version 33

New Version Current

Key

OVERVIEW

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

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

{color:red}
Please

read

the
[*
OVERVIEW
* | #overview]
before

continuing.
{color}
Run Eclipse. From the Project Explorer View, open the Maven JAR project that you want to customize.
Your Project Explorer View should look similar to the following:
Image Added

Section 2: Customizing the project JAR

Customizing the project JAR is now complete.

Customizing the project JAR pom.xml is now complete.

Section 3: Customizing the project JAR pom.xml

Section 4: One final thing to do

One final thing to do is now complete.

Child pages

Page History

Versions Compared

Old Version 33

New Version Current

Key

OVERVIEW

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

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} Run Eclipse. From the Project Explorer View, open the Maven JAR project that you want to customize. Your Project Explorer View should look similar to the following: Image Added

Customizing the project JAR is now complete.

Section 3: Customizing the project JAR pom.xml

Customizing the project JAR pom.xml is now complete.

Section 4: One final thing to do

One final thing to do is now complete.

{color:red}
Please

read

the
[*
OVERVIEW
* | #overview]
before

continuing.
{color}
Run Eclipse. From the Project Explorer View, open the Maven JAR project that you want to customize.
Your Project Explorer View should look similar to the following:
Image Added