This documentation is for WSO2 Developer Studio version 3.7.0. View documentation for the latest release.
Page Comparison - Creating ESB Artifacts (v.1 vs v.2) - Developer Studio 3.7.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Open the Developer Studio Dashboard (choose Developer Studio -> Open Dashboard) and click Template in the ESB Enterprise Service Bus area.
  2. Select Import a Template and click Next.
  3. Specify the XML file that defines the template by typing its full pathname or clicking Browse and navigating to the file.
  4. In the Save Template In field, specify an existing ESB Config Project in your workspace where you want to save the template, or click Create new Project to create a new ESB Config Project and save the template configuration there.
  5. If there are multiple template definitions in the file, click Create ESB Artifacts, and then select the templates you want to import.
  6. Click Finish. The templates you selected are created in the subfolders of the src/main/synapse-config/templates folder under the ESB Config project you specified, and the first template appears in the editor.

Creating a mediator

A mediator project allows you to create a custom mediator that performs some logic on a message. You

...

can create a new mediator project, or you

...

can import an existing mediator project from the workspace.

Info

Because a mediator is an extension to the server that applies to all applications, do not deploy the mediator as a Composite application.

...

Creating a mediator

Follow these steps to create a new mediatorOnce the mediator project is finalised, you can export it as a deployable artifact by right-clicking on the project and selecting Export Project as Deployable Archive. This creates a JAR file that you can deploy to a WSO2 ESB. Alternatively, you can import an existing mediator .

...

group the mediator project as a Composite Application Project, create a Composite Application Archive (CAR), and deploy it to the ESB.

Info

From ESB 4.8.1 onwards, a URL classloader is used to load classes in the mediator (class mediators are not deployed as OSGi bundles). Therefore, it is only possible to refer to the class mediator from artifacts packed in the same CAR file in which the class mediator is packed. Accessing the class mediator from an artifact packed in another CAR file is not possible. However, it is possible to refer to the class mediator from a sequence packed in the same CAR file and call that sequence from any other artifact packed in other CAR files.

Anchor
create-mediator
create-mediator
Creating a mediator project

Follow these steps to create a new mediator. Alternatively, you can import a mediator project.

  1. Open the Developer Studio Dashboard (click Developer Studio > Open Dashboard) and click click Mediator Project in  in the ESB Enterprise Service Bus area.
  2. Leave the first option selected and click click Next.
    The  The New Mediator Creation Wizard appears.



  3. Do the following:
    1. Type a unique name for the project.
    2. Specify the package and class names you are creating.
    3. Optionally specify the location where you want to save the project (or leave the default location specified).
    4. Optionally specify the working set, if any, that you want to include in this project.
  4. A Maven POM file will be generated automatically for this project. If you want to include parent POM information in the file from another project in this workspace, click click Next, click the the Specify Parent from Workspace check  check box, and then select the parent project.
  5. Click Click Finish.

The mediator project is created in the workspace location you specified with a new mediator class that extends extends org.apache.synapse.mediators.AbstractMediator.

Importing a

...

Java Mediator Project 

Follow these the steps below to import an existing mediator project into an ESB Config project. Alternatively, you can create a new mediatora Java mediator project (that includes a Java class, which extends the org.apache.synapse.mediators.AbstractMediator class) to WSO2 Developer Studio.

  1. Open the Developer Studio Dashboard (choose click Developer Studio - > Open Dashboard) and click click Mediator Project in  in the ESB Enterprise Service Bus area.
  2. Select Select Import From Workspace and click  and click Next.
  3. Specify the mediator project in this workspace that you want to import. Only projects with source files that extend extend org.apache.synapse.mediators.AbstractMediator are  are listed. Optionally, you can change the location where the mediator project will be created and add it to working sets.
  4. Click Finish Finish.

The mediator project you selected is created in the location you specified, and the project now has the added project nature .

Info

The mediator projects you create using WOS2 Developer Studio are of the org.wso2.developerstudio.eclipse.artifact.mediator.project.nature nature by default. Follow the steps below to view this nature added to the <PROJECT_NAME>/target/.

...

project file of the Java mediator project you imported.

  • Click the View Menu icon, and click Customize View.
    Image Added
  • Deselect .*resources, and click OK.
    Image Added
Info

For information on importing a mediator project, which you created using WSO2 Developer Studio, see Importing Existing Projects.

You can export this mediator project as a deployable artifact by right-clicking on the project and selecting Export Project as Deployable Archive. This creates a JAR file that you can deploy to a WSO2 ESB. Alternatively, you can group the mediator project as a Composite Application Project, create a Composite Application Archive (CAR), and deploy it to the ESB.

...