Contact Us 1-800-596-4880
  1. Homepage
  2. Anypoint Code Builder

  3. Configure External Libraries for Mule Projects

Configure External Libraries for Mule Projects

logo cloud IDE Cloud IDE

logo desktop IDE Desktop IDE

External libraries are project-level dependencies that Mule applications require to support certain connectors and components, such as Database connectors or Spring-based components. Anypoint Code Builder provides a guided interface to add, edit, and delete external libraries, and automatically manages the corresponding entries in the project POM file.

External library configurations apply at the project level. Any change to a configured library affects all components in the project that require that library.

Before You Begin

When You Need to Configure an External Library

Anypoint Code Builder prompts you to configure an external library when you add or configure a component that requires additional dependencies. For example, this can occur when you:

  • Add a Database connector connection

  • Configure a Spring-based component

  • Use a custom component that depends on external libraries

You can also manage external libraries from the project-level configuration, independent of a specific component.

Add an External Library

You can add an external library from the component configuration or from the project-level library configuration interface.

Add external libraries from one of these sources:

  • Recommended libraries

  • Maven dependencies

  • Local files

Open the library configuration interface from a component:

  1. In the canvas, select a component that requires an external library.

  2. In the component configuration panel, locate the Required Libraries list.

  3. Click the Configure library icon.

    Anypoint Code Builder opens the Library Configuration page. Changes made on this page apply to the entire project.

Some components provide recommended libraries that match the component requirements.

  1. Open the Library Configuration page.

  2. Select Recommended Library.

    The interface shows the library to add to the project.

  3. Click Apply.

    The IDE adds the recommended library to the project POM file and applies it to all components that require it.

Add a Maven Dependency

Search Maven Central or manually specify Maven coordinates to add a dependency.

  1. Open the Library Configuration page.

  2. Select Maven Dependency.

  3. In the Search Maven Central Repository field, search for a dependency or enter the required Maven fields manually.

  4. Specify values for Group ID, Artifact ID, and Version.

  5. Optionally, configure additional fields such as Scope.

  6. Click Apply.

Only libraries that meet the required criteria appear in component library fields after configuration.

Add a Library from a Local File

Add a dependency from a local file, such as a JAR or an external POM file.

  1. Open the Library Configuration page.

  2. Select Local File.

  3. Select a file from your system.

    Anypoint Code Builder automatically populates the Maven fields based on the selected file.

  4. Override the populated values if required.

  5. Click Apply.

If you select an external POM file, it takes precedence over any POM embedded in the artifact file.

Edit or Delete an External Library

Edit or remove an existing library configuration.

  1. Open the Library Configuration page.

  2. Select the configured library.

  3. Use the available actions to update or delete the library.

    Deleting a library removes it from the project POM file and affects all components that use the library.