Controls Listeners Service (com.ibi.agents.XDControlAgent)

Syntax:

com.ibi.agents.XDControlAgent

iIT Service Object:

control: Controls Listeners

Description:

The Controls Listeners service enables or disables one or more listeners or channels. This functionality enables logical control of the server configuration from within a process flow. The following are the supported control operations/actions:

start
pause
pulse
stop

Using the Controls Listeners service, the activity on one listener can control another. For example, the detection of a message in an MQ Series queue can trigger an RDBMS listener to begin working with a relational table.

Parameters:

Parameter	Description
Listener(s)	Fully qualified name of listener(s) or channel(s) to control (for example, group:inlet:listenername), can be comma-separated list. Partial names can be entered with an ending asterisk character (*), meaning all with names starting with the entry characters.
Action	Select one of the following operations/actions from the drop-down list: start. Named listener or channel is started, if necessary. It is enabled for acquiring messages. This action is selected by default. pause. Named listener or channel is disabled for acquiring messages. This may not take effect immediately. The listener or channel remains active and no resources are released. pulse. Named listener or channel is started (or enabled) to acquire messages. It runs through one acquisition cycle (for example, reading all rows in a RDBMS table) and is then stopped. Note: The pulse action can be used with pull and poll types of listeners (for example, JMS, SQL, and File). Applications that depend upon pulsing should be designed with care. stop. Named listener or channel is stopped. All resources are released.
Call at EOS?	In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. The default value is false.

Parameter

Description

Listener(s)

Fully qualified name of listener(s) or channel(s) to control (for example, group:inlet:listenername), can be comma-separated list. Partial names can be entered with an ending asterisk character (*), meaning all with names starting with the entry characters.

Action

Select one of the following operations/actions from the drop-down list:

start. Named listener or channel is started, if necessary. It is enabled for acquiring messages. This action is selected by default.
pause. Named listener or channel is disabled for acquiring messages. This may not take effect immediately. The listener or channel remains active and no resources are released.
pulse. Named listener or channel is started (or enabled) to acquire messages. It runs through one acquisition cycle (for example, reading all rows in a RDBMS table) and is then stopped.
Note: The pulse action can be used with pull and poll types of listeners (for example, JMS, SQL, and File). Applications that depend upon pulsing should be designed with care.
stop. Named listener or channel is stopped. All resources are released.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. The default value is false.

Edges:

The following table lists the available line edges for the Controls Listeners service (com.ibi.agents.XDControlAgent).

Line Edge	Description
OnError	Error
OnSuccess	Success
OnFailure	Failure
OnCustom	OnError OnSuccess OnFailure

Example:

You can use the Controls Listeners service to stop a channel that is currently running in iWay Service Manager (iSM). In a process flow, configure a Service object using the Controls Listeners service (com.ibi.agents.XDControlAgent). Click the Properties tab. For the Listener(s) parameter, specify the name of the channel that you want to stop (for example, default).

Invoke the channel that contains the Controls Listeners service process flow in the route with a valid XML document. The stop command for the default channel will be issued. If the default channel is currently running, then it will be stopped.

You can verify this action by examining the status change for the default channel in the Channel Management pane after successfully passing the XML document through the Controls Listeners service channel.

Notice that the default channel is now stopped.