Page History

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

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

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

This section deals with creating a Maven jar project using the jar-template.  You should notice that in this section:
# Items 1 - 8 deal with checking out and disconnecting the jar template from the SVN repository.
# Items 9 - 10 deal with cleanup and renaming the jar template.
# Items 11 - 19 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:* | #Customizing the project JAR]

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

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

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.
   

When satisfied that everything is correct, click

Finish.

Image Added

!setupJarTemplate002.jpg!

!setupJarTemplate004.jpg!

    svn+ssh://svn.mit.edu/es-projects/es-project-template/jar-template/trunk

Image Added

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.
Image Added
When satisfied that everything is correct, click Next.
The Repository Location Properties panel is a warning panel.
indent22

!setupJarTemplate007.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/jar-template/trunk

as shown in the following panel:
indent22

!setupJarTemplate008.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.
indent22 !setupJarTemplate010.jpg! Yes.

Open the Eclipse Project Explorer View.  The view should look as follows:
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:
Image Added
When satisfied that everything is correct, click Finish OK.

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

<name>jar-template</name>

<name>csf-att</name>

Right click on the renamed project and select Configure > Convert to Maven Project
Expand your project and it should look similar to the following:
Image Added

Right click on the renamed project and select Team > Share Project...
Select SVN as shown below:
Image Added
When satisfied that everything is correct, click Next.

Select Create a new repository location as shown below:
Image Addedindent22

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

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!

Right click on the jar-template project and select Rename....
Replace jar-template with the projectArtifactId that you have previously selected.
indent22

{color:red}Prefix a *csf-* to the projectArtifactId to denote that this is the jar component of your project.{color}

For example: If my projectArtifactId was att, then my panel would look like the following:
indent22 !setupJarTemplate016.jpg!
When satisfied that everything is correct, click OK Next.

!setupJarTemplate018.jpg!

!setupJarTemplate020.jpg!

!setupJarTemplate022.jpg!

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.  A logical grouping
would be by 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 jar project
would be created under the *es-projects/att* directory in the SVN repository.  This is shown
in the following panel:

!setupJarTemplate024.jpg!

!setupJarTemplate026.jpg!

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

!setupJarTemplate028.jpg!

!setupJarTemplate030.jpg!

!setupJarTemplate032.jpg!

!setupJarTemplate034.jpg!

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

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

   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 panel:
   Image Added
   Don't forget to enter your User name and Password,
   When satisfied that everything is correct, click Next.

2. When the following panel is display notifying you that a new SVN entry will be created:
   Image Added
   When satisfied that everything is correct, click OK.
3. Do the following:
             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:
   Image Added
   When satisfied that everything is correct, click Next.
4. Nothing to do here.  This is an information panel similar to the following panel:
   Image Added
   When satisfied that everything is correct, click Finish.
5. When a panel similar to the one below is display, enter a comment.
   This is the initial SVN check-in (svn commit) for the JAR project:
   Image Added
   When satisfied that everything is correct, click OK.
6. When the SVN commit has completed, the Eclipse - Project Explorer View should look similar to the following.
   Image Added

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

Section 2: Customizing the project JAR

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:

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

!customizeJar002.jpg!

!customizeJar004.jpg!

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

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

    <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" />

    <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" />

    <param name="File" value="log/projectName.log" />applicationContext-csf-projectName.xml
    applicationContext-csf-projectName-component-scan.xml
    <param name="File" value="log/applicationContext-csf-projectName-config.xml
    applicationContext-csf-projectName.log" />-security.xml

    applicationContext-csf-att.xml

    <param name="File" value="log/att.log" />applicationContext-csf-att-component-scan.xml
    applicationContext-csf-att-config.xml
    <param name="File" value="log/csf-att.log" />applicationContext-csf-att-security.xml

    <import <context:component-scan base-package="edu.mit.projectName.web"resource="classpath*:applicationContext-csf-projectName.xml" />
    <import resource="classpath*:applicationContext-csf-projectName-config-test.xml" />

    <context:component-scan base-package="edu.mit.att.web">

<import resource="classpath*:applicationContext-csf-att.xml" />
    <import resource="classpath*:applicationContext-csf-att-config-test.xml" />

    applicationContext<value>classpath:csf-projectName-component-scan.xmltest.properties</value>
    applicationContext<value>classpath:csf-projectName-configtest.xml
properties</value>

    applicationContext<value>classpath:csf-projectNameatt-security-spring.xmltest.properties</value>
    applicationContext-projectName.xml<value>classpath:csf-att-test.properties</value>

    applicationContext-attcsf-component-scan.xml
    applicationContext-att-configprojectName-config-test.xml
    applicationContextcsf-attprojectName-security-springtest.xml
    applicationContext-att.xml

properties

!customizeJar006.jpg!

    applicationContext-csf-att-config-test.xml
    csf-att-test.properties

Customizing the project JAR is now complete.

1. 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.
   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.
2. Commit the changes to the SVN repository.

Customizing the project JAR pom.xml is now complete.

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

is now complete.

!jarPomXml002.jpg!