Creating a Channel

In this section:

How to:

A channel binds a port to a listener managed by iWay Application Protocol Adapter for LDAP. A defined port must be associated with a channel in order for you to listen for events that take place in an LDAP system.

The procedures in this topic describe how to create, edit, or delete a channel using the Events node in iWay Explorer.


Top of page

x
Procedure: How to Create a Channel
  1. Connect to the Events node in iWay Explorer and expand the LDAP node.

  2. Right-click the Channels node, and click Add Channel from the menu.

    The following image shows the Add Channel dialog box that opens, where you supply information about the channel.

    1. In the Name field, type a name for the channel, for example, LDAP_Channel.
    2. In the Description field, optionally type a brief description (optional).
    3. From the Protocol drop-down list, select LDAP Listener.
    4. Under Port Name, select the check box for each port that this channel will bind to the listener.
  3. Click Next.

    The Define channel properties dialog box opens, as shown in the following image.

    The following tabs are available:

  4. Click Finish when you are done.

    The following image shows the channel that you added, which appears beneath the Channels node in the Events area of iWay Explorer. In this example, the channel is named LDAP_Channel.

    You are ready to start the channel to listen for events.

  5. Right-click the channel, for example, LDAP_Channel, and click Start from the menu.

    The channel is now active and will listen for events on the LDAP system based on the configuration settings that were specified for the channel.

  6. To stop the channel at any time, right-click the channel, and click Stop from the menu.

Top of page

x
Procedure: How to Edit a Channel

After you create a channel, you can edit the information that you provided during the creation procedure.

  1. In the Events node of iWay Explorer, locate the name of the channel that you want to edit, for example, LDAP_Channel.
  2. Right-click the channel, and click Edit from the menu.

    The Edit Channel dialog box opens. It displays the values that you supplied when you created the channel.

  3. Use the fields on the dialog box to modify the properties as desired. You cannot change the name of the channel or its protocol.
  4. Click Next on the Edit Channel dialog box to open the Define Channel Properties dialog box.
  5. Use the tabs and fields on this dialog box to modify the properties as desired.
  6. Click Finish on the Define Channel Properties dialog box when you have made your edits.

    The modified properties are applied to the channel.


Top of page

x
Procedure: How to Delete a Channel
  1. Expand the Channels node in the Events area of iWay Explorer to locate the name of the channel that you want to delete, for example, LDAP_Channel.
  2. Right-click the channel, and click Delete from the menu.

    iWay Explorer displays a prompt, asking you to confirm the deletion of the selected channel, as shown in the following image.

  3. Click OK to proceed with the deletion.

Top of page

x
Configuring the Ldap Connection Configuration Tab

This section describes how to configure the Ldap Connection Configuration tab during the channel configuration process, which is shown in the following image.

The parameters available in the Ldap Connection Configuration tab are listed and described in the following table:

Parameter

Description

Ldap Connection Factory

The connection factory class that is used to access the LDAP server. The default connection factory implementation is com.sun.jndi.ldap.LdapCtxFactory, as provided by Java SDK.

Ldap Connection Url

The connection URL that is used to identify the LDAP server and connection context. This URL can use the following formats:

  • For unsecured access:
    LDAP://machinename.network:portnumber

    where:

    machinename

    Is the name of the system hosting the LDAP server.

    network

    Is the network of the LDAP server (such as mycompany.com).

    portnumber

    Is the port number of the LDAP server.

  • For secured access:
    LDAPS://machinename.network:sslportnumber

    where:

    machinename

    Is the name of the system hosting the LDAPS Directory Server.

    network

    Is the network of the LDAPS Directory Server (such as mycompany.com).

    sslportnumber

    Is the SSL port number of the LDAPS Directory Server.

Ldap Authentication

The authentication mechanism that is used to connect to the LDAP server. Currently, the adapter supports User ID and Password authentication of the simple bind standard.

Ldap User

The user password used that is used to access the LDAP server.

Ldap Password

A valid password that is associated with the user name.

Ldap Base DN

The relative entry point of the LDAP tree. If this field is empty, then the root DN is used.

Ldap Protocol

Currently, the adapter supports LDAP version 2 and LDAP version 3, as per target server requirements.

Select one of the following LDAP versions from the drop down list:

  • LDAP v3 (default)
  • LDAP v2

Referral Handling

Select one of the following options from the drop-down list:

  • ignore (default)
  • follow


Top of page

x
Configuring the Event Strategy Configuration Tab

This section describes how to configure the Event Strategy Configuration tab during the channel configuration process, which is shown in the following image.

The parameters available in the Event Strategy Configuration tab are listed and described in the following table:

Parameter

Description

Directory Synchronization Polling Interval

Active Directory synchronization requires periodic polling to check for changes to the LDAP directory. The polling interval defaults to 0 seconds.

Ldap Event Detection Strategy

Select one of the following options from the drop-down list:

  • Active Directory Synchronization

    Active Directory Synchronization is the directory synchronization mechanism that is provided by Active Directory Server and the only way events are captured from Active Directory. This strategy can also be used for any other LDAP provider types that support directory synchronization.

  • Asynchronous Ldap Notification

    The asynchronous LDAP notification strategy registers event listeners with the LDAP server. Most servers other than Active Directory Server, support this protocol. This does not involve any polling and the notifications are in real-time.

Note: Active Directory Server event capture is only supported when using the LDAP version 3 protocol.

Search Filter

Sets a search filter, which is used to limit the scope of events captured (for example, cn=*ein*).


Top of page

x
Configuring the Asynchronous Event Subscription Configuration Tab

This section describes how to configure the Asynchronous Event Subscription Configuration tab during the channel configuration process, which is shown in the following image.

The parameters available in the Asynchronous Event Subscription Configuration tab are listed and described in the following table:

Parameter

Description

Add Event

Any changes that involve Add operations to the LDAP directory entries are captured and the notifications will be broadcasted.

Update Event

Any changes that involve Update operations to the LDAP directory entries are captured and the notifications will be broadcasted.

Delete Event

Any changes that involve Delete operations to the LDAP directory entries are captured and the notifications will be broadcasted.

Rename Event

Any changes that involve Rename operations to the LDAP directory entries are captured and the notifications will be broadcasted.

Attribute Filter

Sets an attribute filter, which is used to limit the scope of events captured. For example, a configured channel may only be interested in events pertaining to all employees that belong to the Toronto division of a certain company (ou=Toronto).


iWay Software