Chapter 13. Developing extensions for Ignite integrations

In Red Hat JBoss Developer Studio, select File New Project JBoss Fuse Fuse Ignite Extension Project.

The New Fuse Ignite Extension Project wizard opens.

Specify the versions of the extension dependencies:

Specify the following extension details:

In the syndesis-extension-definition.json file, write the code that defines the actions and their properties. You need a new action for each entrypoint. Each property corresponds to an action parameter. In Ignite, when the user selects a custom step, Ignite prompts for values for action properties. For example, a custom log step might have a level property that indicates how much information to sent to the log.

Each action that you create corresponds to a custom step in Ignite. You can use different types of code for each action. That is, you can use XML for one action and Spring Boot routes and beans for another action.

Here is the template for the .json file that contains the extension metadata, including properties that will be filled in by the user in Ignite after uploading the extension and adding its custom step to an integration:

{
  "actions": [
    {
      "actionType": "extension",
      "id": "${actionId}",
      "name": "Action Name",
      "description": "Action Description",
      "tags": [
           "xml"
      ],
      "descriptor": {
        "kind": "ENDPOINT|BEAN|STEP",
        "entrypoint": "direct:${actionId}",
        "inputDataShape": {
          "kind": "any"
        },
        "outputDataShape": {
          "kind": "any"
        },
        "propertyDefinitionSteps": []
      }
    }
  ],
  "tags": [
    "feature",
    "experimental"
  ]
}

Note: The tags are ignored in this release. They are reserved for future use.

To edit the extension dependencies, open the pom.xml file in the editor. If you add a dependency, you must define its scope. The scope for any dependency that Red Hat ships is provided, for example:

<dependency>
      <groupId>io.syndesis.integration-runtime</groupId>
      <artifactId>runtime-api</artifactId>
      <version>${syndesis.version}</version>
      <scope>provided</scope>
</dependency>
    <dependency>
      <groupId>org.apache.camel</groupId>
      <artifactId>camel-core</artifactId>
      <scope>provided</scope>
</dependency>
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <scope>provided</scope>
</dependency>

Note: You can optionally edit the Extension Id, Name, Version, Tags, or Description values.

In the Project Explorer view, open the target folder to see the generated .jar file:

The name of the .jar file follows Maven defaults: ${artifactId}-$6.3.jar

For example: ignite-extension-1.0.0-SNAPSHOT

This .jar file defines the extension steps, its required dependencies, and its metadata: Extension Id, Name, Version, Tags, and Description. For example:

{
  "name" : "Syndesis Extension (XML)",
  "description" : "A simple Syndesis Extension (XML)",
  "extensionId" : "com.mycompany:syndesis-extension-example-xml",
  "version" : "1.0.0-SNAPSHOT",
  "tags" : [ "experimental", "feature" ],
  "actions" : [ {
    "id" : "log-body",
    "name" : "simple-log-body",
    "description" : "A simple xml based logging extension",
    "descriptor" : {
      "kind" : "ENDPOINT",
      "entrypoint" : "direct:log-body",
      "inputDataShape" : {
        "kind" : "any"
      },
      "outputDataShape" : {
        "kind" : "any"
      },
      "propertyDefinitionSteps" : [ ]
    },
    "tags" : [ "xml" ],
    "actionType" : "extension"
  } ],
  "dependencies" : [ {
    "type" : "MAVEN",
    "id" : "io.syndesis.integration-runtime:runtime-api:jar:1.2.1"
  }, {
    "type" : "MAVEN",
    "id" : "org.apache.camel:camel-core:jar:2.20.1"
  }, {
    "type" : "MAVEN",
    "id" : "org.springframework.boot:spring-boot-starter:jar:1.5.8.RELEASE"
  } ],
  "properties" : { }
}