Listeners


Introduction

Listeners are used for inbound connections to the Integration Server. They are needed for the following connection types:

  • RPC Listener connections

  • Reliable RPC Listener connections

  • Direct RPC Listener connections

  • Direct Reliable RPC Listener connections

Use the Integration Server Wrapper to create:

  • RPC Listener and Direct RPC Listener connections with listeners

  • Reliable and Direct Reliable RPC Listener connections with listeners, notifications, triggers and document types

Creating and Updating Listeners

Use the Integration Server Wrapper to create or update listeners. See Step 3: Create or Update an Adapter Connection and Step 4c: Create a Connection and Related Adapter Listener in the Integration Server Wrapper documentation.

Depending on the connection type, the following objects will be generated:

  • RPC Listener and Direct RPC Listener connections
    • The connection and the listener.

    • For all services specified in the "Service Names" field that do not exist, an empty flow service with the corresponding signature is created.

  • Reliable RPC Listener and Direct Reliable RPC Listener connections
    • The connection and the listener.

    • A listener notification, a messaging trigger and a notification publish document.

    • For all services specified in the "Service Names" field that do not exist, an empty flow service with the corresponding signature is created

    • For all services specified in the "Service Names" field that do exist, and if the input signature of the service does not include the notification publish document, a wrapper flow service is generated which implements the signature mapping.

Configuring Listeners

You change the configuration of EntireX Adapter Listeners using the IS Administration Console.

Start of instruction setTo configure a listener

  1. In the Adapters menu in the IS Administration Console's navigation area, click EntireX Adapter.

  2. In the EntireX Adapter menu, click Listeners.

  3. The Listeners screen shows all existing listeners. Only disabled listeners can be configured. If a listener is enabled, select Disabled in the State column. Then click Edit.

  4. On the Listener screen, in the EntireX Adapter section, the following fields can be changed:

    Field Description
    Connection Name This setting should not be changed. Otherwise the listener may no longer work.
    Retry Limit The number of times the adapter tries to reconnect if the adapter fails to connect, or loses connection with the EntireX Broker or Direct RPC. Default: 10.
    Retry Backoff Timeout The number of seconds that elapse between each of the retries specified in the retry limit. Default: 20.
    EntireX Subprogram Names A list of subprogram names, separated by blanks. This list and the following list of service names is generated by the Designer.
    Service Names A list of Integration Server services, separated by blanks. Each service corresponds to a subprogram name. For the subprogram the service at the same position in the list is called. The lists must have the same number of names.
    Minimum Listener Threads The number of worker threads for this listener that should be started when the listener is enabled. If set to 0, worker threads are started on demand. Default: 1.
    Maximum Listener Threads The maximum number of listener threads to start. Default: 1. If the listener is using one of the reliable listener connections, the value cannot be greater than 1.
    Entry Handler Service The name of an Integration Server service that will be called in addition before the listener calls a service listed in Service Names. The specification pub.wmentirex.listener:entryExitHandlerSpecification describes the interface of the handler service.
    Exit Handler Service The name of an Integration Serverservice that will be called in addition after the listener has called a service listed in Service Names. The specification pub.wmentirex.listener:entryExitHandlerSpecification describes the interface of the handler service. If the listener is using one of the reliable listener connections, this field cannot be specified.
    Execute Service with Client Credentials If enabled, the RPC client has to provide RPC user ID and RPC password. These credentials are then used to execute the Integration Server service.

    Default: false.

    Parameters for Fixed-length Strings See Configure the Formatting of Decimal and Alphanumeric Parameters.
    Null Value Suppression See Configuring Null Value Suppression.
  5. Save the listener.

  6. Enable the listener if needed.