Anypoint connector dev kit
- 2. 2 Anypoint Connector DevKit The MuleSoft Anypoint DevKit, or simply DevKit, enables the development of MuleSoft Anypoint Connectors. An Anypoint 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 1. See detailed instructions here on how to install: Java JDK version 8, Apache Maven, Anypoint Studio, and Anypoint DevKit Plugin to build and test your connector. You can develop a connector using Windows, Mac, or Linux. 2. New Connector: o Anypoint Connector Developer Guide - Set up Anypoint Studio and install the connector plugin. Existing Connector: o 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 Development Steps 3. Determine resource access - Each resource has a different access method, such as REST, SOAP, FTP, or the Java SDK features. 4. 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. 5. 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. 6. Add connector @ attribute annotations - Create code for your connector containing the @ attributes that Mule uses to designate the important parts of your connector. 7. Code tests - Tests can be unit tests, functional tests, and Studio interoperability tests. 8. 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.
- 5. 5 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. • 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.
- 6. 6 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. Connector Architecture Connectors operate within Mule applications, which are built up from Mule Flows, and external resources, which are the targeted resources.
- 7. 7 Connectors on Mule: Connectors are categorized based on the functionality. Accounting & Finance Connectors Business Processes & Administration Connectors e-Commerce Connectors Education & Government Connectors Enterprise IT Connectors Healthcare Connectors Human Resources Connectors Manufacturing & Operations Connectors Marketing & Business Analytics Connectors
- 8. 8 Connectors on Mule: A Mule connector has two operational sides. The Mule-facing side communicates with a resource’s target-facing client side to enable content to travel between the Mule applications, and the external target-facing resource. Mule-Facing Functionality From the Mule-facing side, a connector consists of: • Main Java class. Java code that you annotate with the @Connector attribute. See the Anypoint DevKit API Reference for information about Anypoint Connector DevKit annotations. See Java annotations for information on how annotations work. • Connector attributes. Properties of the @Connector class that you annotate with the @Configurable attribute. • Methods. Functionality that you annotate with the @Processor attribute.