Building and Running From Source

Before beginning, make sure you have installed the following software:

• Java 8 SDK
• Tomcat 7 (If developing the web interface)
• MySQL Server (If building the web interface)

Follow the steps described in the Correlator Installation Guide excluding the deployment instructions if Tomcat or MySQL haven't been configured.

The following instructions are intended for Ubuntu 16.04 LTS. Other development platforms will require different steps but the final configuration should be the same.

JetBrains IntelliJ IDEA

ASTAM Correlator can be built with any edition of IntelliJ but requires Ultimate edition to deploy and debug the web interface. IntelliJ Community edition can be used if only building the plugins.

Download the appropriate IntelliJ edition and clone the ASTAM Correlator if necessary.

Import the Project

Open the IntelliJ startup page by either running a new instance of IntelliJ or closing the currently-opened project using File->Close Project.

1. Click Import Project.
2. Navigate to and select the astam-correlator folder created when cloning this repository.
3. Select Import project from external model and select the Maven option, if prompted; click Next.
4. Check the Search for projects recursively option to be On, leave the remaining options as-is, click Next.
5. Check all options except for enterprise, click Next.
6. Uncheck the module labeled 0.0.1-SNAPSHOT [threadfix-main] if displayed. Uncheck the eclipse:parent:0.1.0 entry if the Eclipse plugin will not be changed. Enable all other modules in the list. Click next.
7. Select your JDK (minimum JDK 7, preferred JDK 8), click Next.
8. Change the project name if desired, then click Finish.

IntelliJ will automatically import all Maven dependencies for the ASTAM Correlator. Modules will not be displayed until their dependencies have been loaded. This may take some time.

Modify Database Connection Properties (Web Application)

The Correlator will need credentials to access the database. Modify the file /<ASTAM-CORR.-ROOT>/threadfix-main/src/main/resources/jdbc.properties as necessary. See the Correlator Installation Guide for more information.

Set up the Deploy profile (Web Application)

1. Click on the Run menu in the toolbar and select Edit Configurations.
2. Click the + icon on the top left of the window and scroll down until you see Tomcat listed. Expand the option and select Local.
3. Click the Configure button for the Application Server and select the root directory of your Tomcat installation.
4. Uncheck the After launch option.
5. At the bottom of the window there will be a warning: No artifacts marked for deployment. Click the Fix button on the bottom right, and select the option threadfix:war exploded.
6. Click OK.
7. Click the Run menu in the toolbar and select Debug..., then select the deployment profile that you created in the earlier steps.
8. The project will begin to build and deploy to Tomcat. Navigate to https://localhost:8080/ to access your instance of the ASTAM Correlator.