Contact Us 1-800-596-4880
  1. Homepage
  2. Connector DevKit (3.8)
  3. Getting Started with Anypoint Connector Development

  4. Setting Up Your Development Environment

Setting Up Your Development Environment

DevKit is compatible only with Studio 6 and Mule 3. To build Mule 4 connectors, see the Mule SDK documentation.

This topic explains how to prepare a development environment that includes all the components required to develop Anypoint Connectors.

Prerequisites

You must have the following components installed and working in your local environment:

The sections below describe the specific details necessary for setting up your connector development environment.

Anypoint Studio

Although you can use any Java IDE with Maven support, it’s strongly recommended that you use Anypoint Studio, as it streamlines and simplifies several of the steps needed to build your connector.

To build connector projects, you must first install the Anypoint Connector DevKit add-on into Anypoint Studio.

If you have not already installed Anypoint Studio, follow the detailed instructions to install. For a quick introduction to Anypoint Studio, review Anypoint Studio Essentials.

JDK

Oracle makes the Java Development Kit (JDK) freely available for all supported platforms, including Windows, Mac OS X and Linux. Download version 7 or version 8 as appropriate for your platform and install.

Anypoint Studio must be configured to reference the location of your JDK rather than your JRE. To set JDK as Anypoint Studio’s installed JRE:

  1. Open Anypoint Studio.

  2. Open Preferences.

    • Windows and Linux: Window > Preferences.

    • Mac: Anypoint Studio > Preferences.

  3. Expand Java.

  4. Select Installed JREs.

  5. If Anypoint Studio is referencing the JRE rather than the JDK, edit the record and remap it to the root of your JDK installation.

installed jres
When referencing the root of your JRE instead of a JDK, Maven will be unable to resolve the DevKit-required dependency com.sun:tools:jar:1.6. An error describing the inability to resolve this dependency will show up in the console when the build process kicks off.

Apache Maven

Apache Maven provides a build manager that Anypoint Studio uses to build connector projects.

See Maven in Five Minutes for a brief introduction to the concepts and basic commands.

  1. Download the Maven distribution from the Apache Maven download page.

    Important: For Windows use, only download Maven 3.1.1, which is available by scrolling down the Apache Maven download page.

  2. Unpack the download to a folder on your local drive.

  3. Create an environment variable called M2_HOME, then set it to the folder into which you unpacked Maven.

  4. Update the PATH environment variable to include the path to Maven binaries.

    • Windows: add the following to the PATH variable: %M2_HOME%\bin

    • Mac or Linux: add the following to the PATH variable: $M2_HOME/bin

For more detailed instructions and installation options, see the Maven download page; instructions for different platforms are available below the download links.

Installing the DevKit Plugin in Studio

To install the DevKit Plugin:

  1. To use DevKit in Studio, you must have Apache Maven installed on your local drive:

    1. To confirm you have Maven installed open the Anypoint Studio preferences (on a Mac click Anypoint > Preferences, on a Windows computer, click Window > Preferences).

    2. Navigate to Anypoint Studio > Maven Settings and ensure that Maven installation home directory points to the directory in which you installed Maven.

    3. Click Test Maven Configuration to ensure that Maven is correctly configured.

  2. From the Help menu in Anypoint Studio, click Install New Software:

    InstallNewSoftware

  3. In the Install menu’s Work with drop-down menu, click the down arrow and click Anypoint DevKit Update Site. Click the checkbox for Anypoint DevKit Plugin, and click Next.

    If the Anypoint DevKit Update Site is not available in the dropdown list, click Add and copy this URL to the repository
    Location: http://studio.mulesoft.org/r5/devkit
    AddOns-Update-Site

  4. Proceed through the remaining steps in the wizard to install.

  5. Restart Studio.

See Also