Anypoint Connector DevKit
Anypoint™ Connector DevKit provides the tools and interfaces for building custom Anypoint Connectors for use with Mule ESB. 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 DevKit function in Mule Studio and Mule ESB runtime environments as extensions of the core product.
This documentation contains all the information you need to build custom Anypoint Connectors which:
- access SOAP-based, RESTful, and Java client library-based APIs
- support OAuth and basic authentication, as well as other authentication methods
- provide advanced design-time functionality such as Mule DataSense support
- support runtime attributes like connection pooling, instance pooling, and multi-tenancy (needed to run in CloudHub)
- DevKit Shortcut to Success
- Anypoint Connector Concepts
- Setting Up a DevKit Development Environment
- Preparing API Access or a Sandbox Environment
- Creating a Connector Project
- Installing and Testing Your Connector
- Authentication and Connection Management
- Connector Attributes Operations and Data Model
- Developing DevKit Connector Tests
- Creating DevKit Connector Documentation
- Packaging Your Connector for Release
- DevKit Connector Examples
- DevKit Advanced Topics
- HTTP Callbacks
- Integrating Connectors with the Mule Life Cycle
- Handling Data Types for Configurable Properties
- Architectural Considerations with DevKit and the Mule Container
- Injecting Mule Managers into Anypoint Connectors
- Supporting DataSense with Dynamic Data Models
- Implementing DataSense Query Language Support
The DevKit documentation assumes that you have a working knowledge of Mule, Mule Studio, and Java development in general. It also assumes you have explored some existing connectors and are familiar with how to use them. It also assumes that you have access to a sandbox environment for the target system or source, and documentation of the Web service it exposes. Though this documentation provides how-to information for tasks requiring Maven, you ideally have some familiarity with Java development using Eclipse or IntelliJ, the Maven build manager, and basic Maven concepts.
In addition to a general familiarity with the Java language, you specifically need to understand the use of Java annotations. DevKit's functionality is exposed to connector developers through Java annotations that inject code into your connector classes. The injected code provides the interface between the connector and Mule that would otherwise require each connector developer to include extensive boilerplate code. This documentation explains each DevKit-specific annotation in context with examples. If you are not familiar with annotations in general, refer to a brief explanation of Java annotations.
- Begin at the beginning with the Anypoint Connector Concepts.
- If you're eager to jump in and start writing code immediately, picking up the concepts as you go, begin with the DevKit Shortcut to Success.
Problem already solved!
Before digging into DevKit, take into account that there are already dozens of existing connectors built to integrate with Mule. Browse our library of community-built and company-built connectors to see if someone has already tackled the integration challenge you're facing.