Using the Mule 4 SDK to build a connector : MuleSoft Virtual Muleys Meetups
0 likes955 views
The document provides an overview of using the Mule 4 SDK to build connectors, highlighting best practices, core components of the SDK object model, and the process of creating a custom extension. It explains the differences between Mule 4 SDK and Mule 3 devkit, emphasizing flexibility and design principles for connector development. Additionally, it presents a code walkthrough and a demonstration using a DocuSign connector as a practical example.
Using the Mule 4 SDK to build a connector : MuleSoft Virtual Muleys Meetups
- 1. All contents © MuleSoft, LLC December 2020 Chris Hughes, Strategic Advisor at MuleSoft Using the Mule 4 SDK to build a Connector
- 2. All contents © MuleSoft, LLC Agenda 1. Introduction a. What is a Connector? b. Mule 4 SDK for Java vs. Mule 3 DevKit c. Best Practices 2. Mule 4 SDK Object Model 3. How to build your own Extension 4. docu-connector Code Walkthrough 5. docu-connector Demonstration 2
- 3. All contents © MuleSoft, LLC Introduction: What is a Connector? Mule 4 provides a well-defined mechanism to extend the runtime, by creating “modules” that you can easily add to Mule applications. Examples of modules include: ● Connectors, such as HTTP ● Modules, such as the Validations module 3
- 4. All contents © MuleSoft, LLC Introduction: Mule 4 SDK vs. Mule 3 DevKit ● Mule 4 SDK replaces DevKit ● DevKit is not available for Mule 4 ● Mule 4 provides XML and Java SDKs ● Mule 4 SDK makes use of Java Annotations, but is not a code generator ● Mule 4 SDK is more flexible than DevKit and supports: ○ Transactions ○ Request-Response message sources ○ Dynamic configurations ○ Routers ○ Non-blocking operations ○ Classloading isolation 4
- 5. All contents © MuleSoft, LLC Introduction: Best Practices General Rules: ● A connector’s purpose is to bring the target system into the Mule language ● A connector should not include operations that implement specific business use cases ● Coding Rules ○ Design for Thread Safety ○ Never Access Flow Variables ○ Never Use Message Attributes as Parameters ○ Don’t Access the MuleContext 5
- 6. All contents © MuleSoft, LLC Mule 4 SDK Object Model 6
- 7. All contents © MuleSoft, LLC Mule 4 SDK Object Model Core Elements of the SDK Object Model are: ● Component ○ Given a set of parameters, a component encapsulates functionality that can be executed to produce or alter messages in a flow ● Configuration ○ A set of parameters that affect the behaviour of the module ○ Sources and Operations may depend on a Configuration for parameters ● Connection Provider ○ Handles management of connections created from a Configuration ○ Configurations may have none, one, or many Connection Providers ● Parameter ○ A value placeholder whose context can be defined within all of the above 7
- 8. All contents © MuleSoft, LLC How to build your own Extension ● https://docs.mulesoft.com/mule-sdk/1.1/getting-started ● Remember: a connector should be a generic extension to the Mule runtime (not specific to a business use case) ● Consider how the target system aligns with the Mule SDK Object Model: ○ Just because the SDK provides a ConnectionProvider annotation doesn’t mean your extension has to make use of one! ● There are some good advanced examples on GitHub, but avoid unnecessary complexity: ○ https://github.com/mulesoft/mule-email-connector ○ https://github.com/mulesoft/mule-http-connector ● Or, you could take a look at my simple DocuSign connector: ○ https://github.com/mule-org-uk/docu-connector 8
- 9. All contents © MuleSoft, LLC Why build a DocuSign Connector? ● DocuSign already exposes a REST API ● DocuSign Authentication process is: ○ JWT-based, but ○ Requires the definition, review, and promotion of an “integrator key” ○ Relies on algorithm that would be difficult (if not impossible) to implement in DataWeave ○ Easily reusable, if defined appropriately ○ https://developers.docusign.com/platform/auth/jwt/jwt-get-token/ 9
- 10. All contents © MuleSoft, LLC Time to look at some code! docu-connector Code Walkthrough 10
- 11. All contents © MuleSoft, LLC Let’s see it in action! docu-connector Demonstration 11
- 12. All contents © MuleSoft, LLC Thank you!