Page tree
Skip to end of metadata
Go to start of metadata

The following are complete instructions for setting up a standard development environment for Java and Open Source projects. Generally, the instructions assume an MS-Windows based operating system.

Note: These are recommendations for a complete system. Naturally, you need to tailor these instructions if you're using a different source code control system from Subversion (for example).

Aspire is a Java-based framework. It manages its dependencies and components with Maven, and keeps crawling state information using MongoDB.

Set Up

Before you install Aspire, first install the prerequisites in the following order.

  1. Install Java
  2. Install and Configure Maven
  3. Install MongoDB 3.X

Make sure you read the Hardware and Network Considerations for Aspire 3.0.

On this page:

Install Eclipse


  1. Go to http://www.eclipse.org/downloads/ and install the latest version of Eclipse IDE for Java Developers.
    • Make sure that your 32/64 bit choice matches the Java JDK you installed (or else Eclipse will fail to start with a JVM error of -1).
  2. Unzip it to the folder of your choice.
  3. Execute Eclipse.
    • Specify a folder where your workspace will be located (can be anywhere).
  4. Check to make sure your Eclipse is using the correct JDK version:
    1. Start Eclipse.
    2. Open Menu: Window/Preferences
    3. Go to Java/Installed JREs.
    4. Check that Java 6 (or later) is installed and selected.
      • Must specify the JDK 1.7 (not a JRE) AND select it; if not, add the new VM and then select it as the default.
      • This is required so that new Maven projects will build correctly.
      • When creating new Java projects, make sure that your JRE choice is "Use default JRE", which should be pointing to your JDK.
  5. Install the "Aspire Coding Profile" for Aspire coding standards: media:Aspire_Java_Coding_Profile.xml
    1. Open up Window / Preferences.
    2. Go to Java / Code Style / Formatter.
    3. Click "Import..."
    4. Locate the "Aspire Java Coding Profile.xml" file.
    5. Click "Apply".
      • All this does is set the indentation to 2 spaces (no other coding style issues are important).

Install Subversion into Eclipse

  1. Inside eclipse, go to: Help / Install New Software...
  2. Under "Work with:" enter:
  3. Mark all checkboxes and click Next.
  4. Review items and click Next.
  5. Accept the license, click Finish, and let it install.
  6. Restart Eclipse.
  7. Create a new SVN Repository Location by going to Window / Open Perspective / Other… and selecting SVN Repository Explorer.
  8. Right click inside the SVN Repositories window and select New / Repository Location.
  9. Enter the URL of your SVN repository as the "Url" and click Finish.
  10. The application will try to connect; if it connects successfully, you will be prompted for user and password (check the box to avoid being asked to login several times).
    • Search Technologies' employees should use their standard Search Technologies username and password.

Are you using a 64-bit JVM for Eclipse?

  • You may see "JavaHL" missing library errors when you go to your Subversion repository.
  • If this is the case, you may need to install a 64-bit version of "JavaHL". Go to http://www.sliksvn.com/en/download and download and install the "SlikSVN" 64-bit Windows subversion client. It should put the SlikSVN binaries on your Windows PATH environment variable (check this). Then restart Eclipse and you should be fine.
  • See http://subclipse.tigris.org/wiki/JavaHL for more details.

Install Maven into Eclipse (m2eclipse)

Not need it by Eclipse Mars (4.5) and above

Install the plugin:

  1. Go to Help / Install New Software...
  2. Under "Work with" enter:
  3. Click to install the following items:
    1. Maven Integration (the whole thing)
  4. Click Next/Finish/Accept/Restart as necessary to complete the installation.
  5. Set Eclipse to use the jdk1.7.0_xx (this is recommended by m2eclipse):
  6. Edit the "eclipse.ini" file located in your eclipse directory.
    1. Add the following two lines to the top of the file:
      1. -vm
      2. C:\Program Files\Java\jdk1.7.0_xx\bin
      3. (specify the exact location of your JDK-7 binary)

To test that m2eclipse is working correctly:

  1. Restart Eclipse.
  2. Open up the console window: Menu: Window / Show View / Console
  3. Look for the open-console toolbar (the console with a + sign), then select "Maven Console."
  4. Make sure there are no errors (any errors will be shown in red).
  5. Wait for it to download the maven repository index.

Optional (install additional plugins):

  1. Return to Help / Install New Software...
  2. After the "Work with:" prompt, enter: http://m2eclipse.sonatype.org/sites/archives/m2e-extras-20101029/
  3. Click to install the following items:
    1. Maven Optional Components / Maven SCM handler for Subclipse
    2. Maven Optional Components / Maven issue tracking configurator for Mylyn 3.x
    3. Maven Project Configurators / WTP

In order to get Maven to Run inside Eclipse, you will need to change the JRE to JDK 1.7 or 1.8 as appropriate according to your Aspire target version:

  1. Window / Preferences
  2. Java / Installed JREs
  3. Add...
  4. "Standard VM"
  5. Click "Directory...", then locate your JDK folder, click on the JDK folder and then hit OK & Finish
  6. Back in the "Installed JREs" dialog, make sure your JDK is selected.
  7. Click OK.

Install Cygwin with Subversion Command-Line (Optional)


If you are running in Windows, then Cygwin is an extremely valuable tool for managing very large files.

  1. Go to http://www.cygwin.com/ and install the Cygwin setup.exe program
  2. Run the setup.exe program, then follow the instructions.
    • Install cygwin into C:\cygwin.
    • Make sure that Subversion is selected when installing packages.
      • In the 'Devel' category, make sure that "subversion: A version control system" is selected.
  3. Once installed, add the following environment variables to your Windows environment:
    • Go to Control Panel / System / Advanced System Settings / Environment Variables...
    • Add variables for:
      • CYGWIN => nodosfilewarning
      • Add ";C:\cygwin\bin" to the end of your PATH variable.
        • This will allow all cygwin commands to be executed directly from DOS Command windows.