LDAPLoadValve

Warning

This valve is blocking - this may hurt throughput and cause performance issues since other pipes won't be able to execute while this valve is waiting on a long-running operation in the same instance of the pipes module, for example due to a network request, disk access or similar. Try to limit the usage of blocking valves, try to ensure that they are fast to execute, and if needed, consider deploying multiple instances of the pipes module.

Note

Valve for loading an entry from an LDAP Directory.

If no items exist in the Current Item Set (CIS), the valve will perform the configured load and populate the CIS with the loaded entry (if found). If items exist in CIS the valve operates on them and will process all items surviving the common item filtering rules.

When in item iteration mode, loaded entries will be merged to the current item, even if the item identifiers doesn’t match.

Supports attributes configuration to specify which attributes to include in load.

Properties

Name	Description	Default value	Mandatory	Supports property expansion
connection_ref	Id of LDAP connection to use. Must refer to a connection of type 'LDAP'.		Yes	No
attributes	List of attributes to load.		No	No
item_id_pattern	Regex pattern for item id's to perform operations on. Items with id's that doesnt match the regex will be filter out.	'.*' (include all items )	No	No
dn	DN		Yes	Yes
binary_attrs	List of attributes that should be treated as binary.		No	No

Example Configuration

{
    "name": "LDAPLoadValve",
    "config": { 
        "connection_ref":"b0f2ddff-9585-47c5-9286-2bee2b731197",
        "dn":"cn={{item.name}},dc=example,dc=com",
        "attributes":"cn,uid,mail,mobile" 
    }
}

Tags

Valve LDAP