This page explains how to install connectors, uninstall connectors, and work with connector dependencies in both Anypoint Studio and Maven.
Note that the information on this page applies to operation-based connectors only. All endpoint-based connectors are bundled automatically with Anypoint Studio and cannot be installed or updated individually via an update site.
If you don’t use Studio, you can specify endpoint-based connectors as required transports when you generate a project using the Maven mule-project-archetype.
Anypoint Exchange lets you view details on a connector. However to install a connector, you need to first open Anypoint Studio.
In Anypoint Studio, click the Anypoint Exchange icon in the taskbar.
When Exchange opens, search for the connector to install, click Install, and follow the prompts to install the connector.
If a connector or connector version is not available from Anypoint Exchange, you can install the connector using Anypoint Studio.
Verify if a connector is already installed by clicking Help > Installation Details and searching for the connector. Click Close.
Click Help > Install New Software.
Set Work With to
Anypoint Connectors Update Site.
Expand a category and click the checkbox for the connector you want to install.
Click Next, Next, I accept the terms of the license agreement, Finish, and restart Studio when prompted.
From a Mule Project in Studio, search for the connector and drag it to the Canvas.
Under the Anypoint Studio menu, select About Anypoint Studio.
In the About Anypoint Studio window, click Installation Details to display a list of the connectors you have installed on your instance of Anypoint Studio.
In the Installed Software tab, select the line item you wish to uninstall, then click Uninstall
To uninstall more than one item, click to select the first line item, then hold down the
CRTLkey (PC) or
commandkey (Mac) as you click other line items.
Click Finish to uninstall the item(s) you selected.
To uninstall a connector, remove the Maven dependency for that connector from your
Automatic Dependency Management
In an Anypoint Studio project that does not include Maven support, when you add a connector to your flow, Studio automatically adds all of its dependencies (including
.jar files) to your project’s classpath. Mule manages each connector’s dependencies as an Eclipse user library. Because Studio adds a connector’s dependencies to your project’s classpath, you can reference connector classes within other projects in your Anypoint Studio instance.
In an Anypoint Studio project that is built with Maven support, when you add a connector to your flow, Studio automatically adds the dependency (and the inclusion element to the maven-mule-plugin, if needed) to your pom file. Then, it refreshes your project dependencies based on the new contents of your pom file, and the connector (and its transitive dependencies) will appear referenced in your project’s "Referenced Libraries" section as a set of references to
.jar files in your local m2 repository.
Refer to [Deploying Mule Applications] for more information on managing your user libraries in Studio.
Manually Adding Connector Dependencies
Complete the following procedures to manually add connector dependencies to your project’s classpath in Studio.
In the Package Explorer pane, right-click on your project’s name, then select Build Path > Add Libraries.
In the Add Libraries wizard, select Anypoint Connector Dependencies, then click Next.
Check the boxes associated with the connector dependencies you wish to add to your project’s classpath.
Click Finish to add the dependencies.
If you are installing a connector as a Maven dependency, ensure that you complete the following three steps for each connector:
To make any connector module available to a Mavenized Mule application, first add the following repositories to you
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<repositories> <repository> <id>mulesoft-releases</id> <name>MuleSoft Repository</name> <url>https://repository.mulesoft.org/releases/</url> <layout>default</layout> </repository> <repository> <id>mulesoft-snapshots</id> <name>MuleSoft Snapshot Repository</name> <url>https://repository.mulesoft.org/snapshots/</url> <layout>default</layout> </repository> </repositories>
Then add the module as a dependency to your project, replacing
insert-artifcactID-herewith the artifactID of the specific module you are adding and replacing RELEASE with the version of this module.
1 2 3 4 5
<dependency> <groupId>org.mule.modules</groupId> <artifactId>insert-artifactId-here</artifactId> <version>RELEASE</version> </dependency>
If you plan to use this module inside a Mule application, you need to add it to the packaging process. As such, the final zip file which will contain your flows and Java code will also contain this module and its dependencies. Add a special inclusion to the configuration of the Mule-Maven plugin for this module, replacing
insert-artifactID-herewith the artifactID of the specific module you are adding.
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<plugin> <groupId>org.mule.tools</groupId> <artifactId>maven-mule-plugin</artifactId> <extensions>true</extensions> <configuration> <excludeMuleDependencies>false</excludeMuleDependencies> <inclusions> <inclusion> <groupId>org.mule.modules</groupId> <artifactId>insert-artifactId-here</artifactId> </inclusion> </inclusions> </configuration> </plugin>