The MuleSoft Anypoint DevKit enables the development of MuleSoft Anypoint Connectors. It provides a development environment including Java JDK, Apache Maven, Anypoint Studio, and a DevKit plugin. It supports creating new connectors or importing existing connector projects. The DevKit features include visual design tools, Maven support, authentication mechanisms, data modeling options, testing capabilities, and annotation-based implementation.
2. 2
Overview
The MuleSoft Anypoint DevKit , or simply DevKit , enables the development
of MuleSoft Anypoint Connectors.
A MuleSoft connector is an extension module to the MuleSoft Anypoint
Platform, with modules that ease the interconnection of third-party systems
and APIs with Mule applications.
3. 3
Development Steps
Development environment: Install Java JDK version 7, Apache Maven,
Anypoint Studio, and Anypoint DevKit Plugin to build and test your
connector. You can develop a connector using Windows, Mac, or Linux.
New Connector - Create an Anypoint project - Set up Anypoint Studio and
install the connector plugin. Existing Connector - Click File > Import >
Anypoint Studio > Anypoint Connector Project from External Location,
choose a URL or a .zip file, and complete the wizard to locate and import
the project. See also Creating a SOAP Connector and Creating a REST
Connector.
4. 4
Data Gateway is a Salesforce package which you install via Salesforce
AppExchange. After you isntall the package, you can access the Data
Gateway Designer, which allows you to quickly and easily create a new
gateway to your desired external data source. After you’ve configured your
gateway, you can publish it – make it available to the external entities that
you specify – as well as see existing objects in your data source, and
create new objects.
5. 5
Determine resource access - Each resource has a different access
method, such as REST, SOAP, FTP, or the Java SDK features.
Choose an authentication mechanism - Mule supports OAuth V1 or V2, and
username and password authentication (known as connection
management), which can be used for protocols such as API Key, SAML,
NTLM, Kerberos, or LDAP.
6. 6
Choose the connector’s data model - Models can be static Java objects or
dynamic objects. You can use DataSense - Determine what information the
target resource expects.
Add connector @ attribute annotations - Create code for your connector
containing the @ attributes that Mule uses to designate the important parts
of your connector.
7. 7
Code tests - Tests can be unit tests, functional tests, and Studio
interoperability tests.
Document your connector - MuleSoft provides a template that helps you fill
in the blanks to create documentation to help your staff and to help others
understand the features and use of your connector.
Package your connector.
8. 8
Supported EDI Document Types
B2B Portal 1.0.0 Beta (Trading Partner Management and Message
Tracking)
AS2 and EDI X12 Purchase Order Walkthrough
FTPS and EDI X12 Purchase Order Walkthrough
9. 9
DevKit Features
Features DevKit provides:
Visual design and implementation using Anypoint Studio with an Eclipse-
based interface that simplifies and speeds up development.
Maven support.
Connector packaging tools.
Authentication support for multiple types of authentication, including OAuth
and username and password authentication.
10. 10
DevKit Features
DataSense support to acquire remote metadata.
Extensive testing capability.
Examples, training, and support to simplify development startup.
Batch, Query Pagination, and DataSense Query Language support.
DevKit is a annotations-based tool, with a wide set of available annotations
to support its features. For a complete list of DevKit annotations, see the
Annotation Reference.
11. 11
What is a Connector?
An Anypoint connector is an extension module that eases the interaction
between a Mule application and external resources, such as a databases
or APIs, through REST, SOAP, or the Java SDK.
As reusable components that hide API complexity from the integration
developer, custom connectors facilitate integration with SaaS and on-
premise web services, applications, and data sources. Connectors built
using Anypoint DevKit in Anypoint Studio, running Mule runtime
environments, act as extensions of Mule Anypoint Platform.