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

Quick Links to:

OVERVIEW

There are 4 sections to this document.  These sections are:

  • Step 1:
    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 2:
    This section deals editing the project's pom.xml.
  • Section 3:
    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 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.

Step 1: The mit-release-plugin-parent Maven Project Reconfiguration

  1. Check-out the maven project for the mit-release-plugin.  The SVN repository is: 
    svn+ssh://svn.mit.edu/sais-sis-common/maven/plugins/mit-release-plugin/trunk
  2. Open the mit-release-plugin maven project in your IDE.
    1. Open the pom.xml's for each of the following projects:
      • mit-release-plugin-parent
      • mit-release-plugin
      • mit-release-plugin-common
      • mit-release-plugin-integration-tests
    2. In each of the pom.xml's for the above, remove all occurances of -SNAPSHOT from the <version> tags.
      There are a total of 7 occurances that have to be changed.
      • EXAMPLE: <version>2.0.21-SNAPSHOT</version> becomes <version>2.0.21</version>

When you are satisfied that everything is correct, save the changes that you made to the pom.xml's.

The mit-release-plugin-parent Maven Project Reconfiguration is now complete

Step 2: The sais-moves-web Maven Project Reconfiguration

  1. Check-out the maven project for the sais-moves-web.  The SVN repository is: 
    svn+ssh://svn.mit.edu/sais-sis-common/sais-moves-web/trunk
  2. Open the sais-moves-web maven project in your IDE.
    1. Open the sais-moves-web project pom.xml for editting.
    2. In the <dependencies> section, add the following dependency: 
      <dependency>
    <groupId>edu.mit.maven.plugins</groupId>
    <artifactId>mit-release-plugin</artifactId>
    <version>2.0.21</version>
</dependency>
      Change the <version>, in the above, to the mit-release-plugin version that you selected in Section 1.
      The above dependency makes the source code for the mit-release-plugin available to the IDE's debugger.
    3. In the <plugins> section of the pom.xml, find the following plugin with the following groupId and artifactId: 
      <plugin>
    <groupId>edu.mit.maven.plugins</groupId>
    <artifactId>mit-release-plugin</artifactId>
    .
    .
    .
</plugin>
      Change the <version> for the above plugin to the mit-release-plugin version that you selected in Section 1.
    4. Open the log4j.xml (located in the resources folder) for editting and add the following <logger>: 
      <logger name="edu.mit.moves.shell.logging">
    <level value="INFO" />
</logger>

      If you are only interested in debugging the mit-release-plugin, you might want to changed the <level> of all the other <logger>s to FATAL.  If you do this, all output to the system console will be surpress except for the output from the mit-release-plugin.

When you are satisfied that everything is correct, save the changes that you made.

The sais-moves-web Maven Project Reconfiguration is now complete

Step 3: The Development Environment Setup

  1. Download the following files:

    The following 3 properties files are the be used solely and exclusively in the software development environment on an Educational Systems VM.  They are NOT to be deployed to the development, test or production servers.

    1. Click here to Download the sais-moves-web.properties file .  Select Save as to your ${user.home} directory.
    2. Click here to Download the sais-moves-web-build.properties file .  Select Save as to your ${user.home} directory.
    3. Click here to Download the sais-moves-web-test.properties file .  Select Save as to your ${user.home} directory.
    4. Open the sais-moves-web-build.properties file for editing and change the following properties:
      • mit.maven.release.plugin.version=2.0.21  Change the version number (2.0.21) to the mit-release-plugin version number that you selected in section 1.
      • maven.system.property.cargo.hostname=esvm-1xx.mit.edu  Change the hostname (esvm-1xx.mit.edu) to your vm's hostname.

  2. Configure your moves build directories
    1. Create the following directories:
      • C:\tmp\movesbuild\build\sais-common-conf\.m2\repository
      • C:\tmp\movesbuild\build\sais-common-conf\servers\oc4j

        Please note that the .m2 directory cannot be created using Windows Explorer.  To create the .m2 directory, you must open a cmd window, cd to the sais-common-conf directory and use mkdir to create the .m2 directory.

    2. Open a cmd window and cd to the C:\tmp\movesbuild\build\sais-common-conf\.m2 directory.  Type the following command: 
      linkd repository c:\Users\esuser\.m2\repository
      The above command will link your local maven repository to the directory C:\tmp\movesbuild\build\sais-common-conf\.m2\repository.

      Do not delete or rename the repository directory.  Deleting or Renaming the repository directory will delete your local maven repository.  Unlink the repository directory before you delete or rename.

      You can unlink the repostory directory with the following command:

      linkd repository /D

      You must be in the .m2 directory when you execute the above command.

    3. cd to the C:\tmp\movesbuild\build\sais-common-conf\servers directory.  Type the following command: 
      linkd oc4j c:\oracle-oc4j-10.1.3.5.0-server
      The above command will link your local oracle server to the directory C:\tmp\movesbuild\build\sais-common-conf\servers\oc4j.

      Do not delete or rename the oc4j directory.  Deleting or Renaming the oc4j directory will delete your local oracle server.  Unlink the oc4j directory before you delete or rename.

      You can unlink the oc4j directory with the following command:

      linkd oc4j /D

      You must be in the servers directory when you execute the above command.

  3. Configure your moves ui directories
    1. Create the following directories:
      • C:\tmp\movesbuild\ui\sais-common-conf\.m2\repository
      • C:\tmp\movesbuild\ui\sais-common-conf\servers\oc4j

        Please note that the .m2 directory cannot be created using Windows Explorer.  To create the .m2 directory, you must open a cmd window, cd to the sais-common-conf directory and use mkdir to create the .m2 directory.

    2. Open a cmd window and cd to the C:\tmp\movesbuild\ui\sais-common-conf\.m2 directory.  Type the following command: 
      linkd repository c:\Users\esuser\.m2\repository
      The above command will link your local maven repository to the directory C:\tmp\movesbuild\ui\sais-common-conf\.m2\repository.

      Do not delete or rename the repository directory.  Deleting or Renaming the repository directory will delete your local maven repository.  Unlink the repository directory before you delete or rename.

      You can unlink the repostory directory with the following command:

      linkd repository /D

      You must be in the .m2 directory when you execute the above command.

    3. Download the settings.xml (right click on this link then select Save target as....  Navigate to your ${user.home}/.m2 directory and click Save)
    1. cd to the C:\tmp\movesbuild\build\sais-common-conf\servers directory.  Type the following command:
    2. cd to the C:\tmp\movesbuild\ui\sais-common-conf\servers directory.  Type the following command: 
      linkd oc4j c:\oracle-oc4j-10.1.3.5.0-server
      The above command will link your local oracle server to the directory C:\tmp\movesbuild\ui\sais-common-conf\servers\oc4j.

      Do not delete or rename the oc4j directory.  Deleting or Renaming the oc4j directory will delete your local oracle server.  Unlink the oc4j directory before you delete or rename.

      You can unlink the oc4j directory with the following command:

      linkd oc4j /D

      You must be in the servers directory when you execute the above command.

The Development Environment Setup is now complete

Step 4: Debugging the mit-release-plugin

  1. Build and install mit-release-plugin-parent.
  2. Build, install and deploy sais-moves-web to your oracle server.
  3. Setting break points.
  4. Attaching the IDE's debugger.