pub.client.ldap:registerNotification
WmPublic. Creates a notification (or "persistent search") that causes Integration Server to listen for LDAP events. When the notification gets an event, the specified service is called.
Input Parameters
url | String Optional. URL of the LDAP server to connect to. |
principal | String Optional. The principal for the LDAP server. |
credentials | String Optional. Credentials for the LDAP server. |
timeout | String Optional. Connection timeout in milliseconds. The default value is 30000 milliseconds. |
ldapEnv | Record Optional. Key/value parameters to be passed to JNDI to further define the connection environment. See your JNDI provider documentation or the Oracle JNDI documentation for more information about parameters you can pass to JNDI. |
close | String Flag that specifies whether to close the connection after the service finishes. Set to:  yes to close the connection. This is the default. no to leave the connection open and available. |
dn | String The distinguished name of the entry to be monitored. |
connectionHandle | Object Optional. Connection object returned by a previously invoked LDAP service. |
scope | String The scope of the search. Must be "object" (only search the specified directory entry, "onelevel" (only search the immediate children of the specified directory entry), or "subtree" (search the directory entry, its children, and all of their children). |
service | String The target service to be invoked when the LDAP event is retrieved. |
user | String Optional. Integration Server user to run service (the target service to be invoked when the LDAP event is retrieved). If you do not specify a user, the service runs as the Default user. Make sure user has the permissions necessary to run the service. Be careful when assigning the user because no password is required when invoking a service in this manner. It is recommended that you create a special account just for invoking the target service. |
Output Parameters
connectionHandle | Object Optional. The returned connection object. Returned only if the close parameter is set to "no". |
Usage Notes
When the pub.client.ldap:registerNotification service creates a notification, Integration Server listens for four different types of events: objectAdded, objectRemoved, objectRenamed, and objectChanged. If any one of these events is triggered, pub.client.ldap: registerNotification calls the specified target service and passes these inputs to it:
Pipeline Input | Description |
type | One of the following depending on which event was triggered - "objectAdded", "objectRemoved", "objectRenamed", "objectChanged". |
dn | Distinguished name of the entry that triggered the event. |
attributes | Any additional LDAP attributes from the event. |
oldDn | Applicable only for objectRenamed event. Distinguished name of the entry before it was renamed. |
If an error occurs, pub.client.ldap:registerNotification places an input called "exception" in the pipeline. This input includes details on the exception that occurred.
Some LDAP servers do not support persistent searches and therefore do not support notifications.
When close is set to yes, Integration Server removes the connectionHandle from the pipeline, but does not close the LDAP connection. To close the LDAP connection, set the watt.server.ldap.cleanContext server configuration parameter to true. For information about the watt.server.ldap.cleanContext server configuration parameter, see webMethods Integration Server Administrator’s Guide.
