Adapter Development Kit 9.12 | webMethods Adapter Development Kit Documentation | webMethods Adapter Development Kit Installation and User’s Documentation | Using the Services for Managing Namespace Nodes | Listener Services | wm.art.dev.listener:updateListenerNode
 
wm.art.dev.listener:updateListenerNode
This service updates an existing listener node.
*You must disable the listener before updating its properties, using the pub.art.listener:disableListener service.
For more information, see the webMethods Integration Server Built-In Services Reference for your release.
You must perform the following steps to populate the input pipeline:
1. Use wm.art.dev.listener:fetchListenerTemplateMetadata service to identify the supported service template properties and configure the listenerSettings input parameter.
*The value of the systemName metadata attribute is the internal name of a property. Use this internal name as the key for setting a property's value when constructing the input parameter listenerSettings.
2. Set only those properties that you want to change.
Note:
This service attempts to overlay these new values on the listener's current property values. The resulting set of merged property values are used to reconfigure the listener.
3. Update the property depending on the data type.
*If a property's data type is non-primitive (derived from java.lang.Object), you may clear a property's current value by setting its value to null.
*If a property's data type is Java primitive, then the property value cannot be cleared; however the property can be updated.
4. If you are providing explicit property values in listenerSettings parameter, then the values must conform to the underlying data types of those properties.
5. Change the connection resource that the listener uses by providing a new connectionAlias input parameter.
*If you omit the connectionAlias parameter, the listener continues to use its current connection resource.
*If you are changing only the connection resource, it is not necessary to provide the listenerSettings input parameter.
The resource domains registered by the listener templates are set in the listener's properties according to the interdependencies between the resource domains. Knowledge of these interdependencies is adapter-specific, and beyond the scope of this service. This service does not interpret resource domains.
For an example of setting an listener property, see the Java code example in wm.art.dev.listener:createListenerNode.
Input Parameters
Name
Description
listenerName
String. Required. Name of an existing listener in the format: folder:node.
connectionAlias
String. Required. Name of the connection in the format: folder:node.
listenerSettings
IData. Required. Structure for passing the listener's property values.
systemName
String. Required. Internal property name.
*The following Java data types are supported for connections: char, short, int, long, float, double, boolean, java.lang.String, java.lang.Character, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Boolean.
*Arrays are not supported.
retryLimit
String. Required. Number of times that the system must attempt to start the listener if the initial attempt fails.
retryBackoffTimeout
String. Required. Number of seconds the system must wait between each attempt to start the listener. This field is irrelevant if the value of Retry Limit is 0.
Output Parameters
None.