Page History

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.

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

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.
   Image Added
   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.
   Image Added
   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-common-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.
   Image Added
   When satisfied that everything is correct, click Next.

4. The Repository Location Properties panel is a warning panel.
   Image Added
   You do not want to normalize the URL!
   click No.

5. In the Select Resourcepanel, select

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

   as shown in the following panel:
   Image Added
   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.
   Image Added

!setupJarTemplate002.jpg!

Section 2: Customizing the project JAR

• Please read the OVERVIEW before continuing.

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

3. 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 satisfied with the changes, save and close the file.

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

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

!customizeWar002.jpg!

!customizeWar004.jpg!

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.

One final thing to do

!pomXml002.jpg!