Adding a property editor or compiler

Create a property editor by using the IPropertyEditor interface to control how the properties of your user-defined node created in Java™ or C only, are displayed in the IBM® App Connect Enterprise Toolkit. Create a custom compiler by using the IRuntimePropertyCompiler interface; for example, to encrypt a value before sending it to the server.

Before you begin

You must complete the following tasks:
  1. Creating a user-defined node project
  2. Creating the user-defined node plug-in files
  3. Defining the node properties

About this task

The IPropertyEditor interface is used as the basis for all the node property editors in the IBM App Connect Enterprise Toolkit. You can customize the property editor to contain different kinds of controls, such as text fields and lists. See the IPropertyEditor and IRuntimePropertyCompiler interfaces in the Property editor API.

If you create a custom compiler for your user-defined node, you must install both the compiled runtime files and the user-defined node plug-ins on the integration node to which you want to deploy the node; see Packaging and distributing user-defined extensions.

If you create a message flow or a subflow that includes a user-defined node and your user-defined node has a custom compiler, be aware of the following information about adding your flow to a BAR file:
  • If you want to add your flow to a BAR file as a .msgflow file or a .subflow file, you must ensure that your custom compiler code implements the IRuntimePropertyCompiler interface. Custom property compilers in versions of WebSphere® Message Broker earlier than Version 8.0 use the IPropertyCompiler interface.
  • If you want to add your flow to a BAR file as a .cmf file, you can continue to use custom compiler code that implements the IPropertyCompiler interface.
For more information about how to add files to a BAR file, see Adding resources to a BAR file.

Creating a Java class

About this task

To create a Java class for your property editor or compiler, complete the following steps.

Procedure

  1. Switch to the Java perspective.
  2. Right-click your user-defined node project and click New > Class. If Class is not shown, click Other, select Class and click Next.
  3. Type a name for your class in the Name field.
  4. Complete the following steps, according to whether you are creating a property editor or a property compiler:
    • If you are creating a property editor:
    1. Delete any text in the Superclass text field, and click Browse.
    2. In the Choose a type field, type AbstractPropertyEditor and click OK.
      AbstractPropertyEditor implements the IPropertyEditor interface.
    • If you are creating a property compiler:
    1. Click Add next to the Interfaces field.
    2. In the Choose interfaces field, type IRuntimePropertyCompiler and click OK.
  5. Click Finish.

Testing your property editor or compiler

About this task

To test your property editor, see Testing a user-defined node.

To test your property compiler, deploy to an integration node the flow that contains your user-defined node.

A custom property editor can use Rational® Application Developer or Eclipse APIs. When you migrate to a new version of IBM App Connect Enterprise, your custom property editor might not work if the Rational Application Developer or Eclipse APIs change. Update your property editor code to comply with the changed API.