<html>
<head>
<base href="https://docs.jboss.org/author">
<link rel="stylesheet" href="/author/s/en/2172/19/5/_/styles/combined.css?spaceKey=TEIID&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://docs.jboss.org/author/display/TEIID/LDAP+Translator">LDAP Translator</a></h2>
<h4>Page <b>added</b> by <a href="https://docs.jboss.org/author/display/~van.halbert">Van Halbert</a>
</h4>
<br/>
<div class="notificationGreySide">
<h1><a name="LDAPTranslator-"></a><font color="#000000"><b>LDAP Translator</b></font></h1>
<p><font color="#333333">The LDAP translator, known by the type name </font><font color="#333333"><em>ldap</em></font><font color="#333333">, exposes an LDAP directory tree relationally with pushdown support for filtering via criteria. This is typically coupled with the LDAP resource adapter.</font></p>
<p><font color="#333333"><b>Execution Properties</b></font><font color="#333333"> </font></p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> <font color="#000000">Name</font> </th>
<th class='confluenceTh'> <font color="#000000">Description</font> </th>
<th class='confluenceTh'> <font color="#000000">Default</font> </th>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">SearchDerfaultBaseDN</font> </td>
<td class='confluenceTd'> <font color="#333333">Default Base DN for LDAP Searches</font> </td>
<td class='confluenceTd'> <font color="#333333">null</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">SearchDefaultScope</font> </td>
<td class='confluenceTd'> <font color="#333333">Default Scope for LDAP Searches. Can be one of SUBTREE_SCOPE, OBJECT_SCOPE, ONELEVEL_SCOPE.</font> </td>
<td class='confluenceTd'> <font color="#333333">ONELEVEL_SCOPE</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">RestrictToObjectClass</font> </td>
<td class='confluenceTd'> <font color="#333333">Restrict Searches to objectClass named in the Name field for a table</font> </td>
<td class='confluenceTd'> <font color="#333333">false</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">UsePagination</font> </td>
<td class='confluenceTd'> <font color="#333333">Use a PagedResultsControl to page through large results. This is not supported by all directory servers.</font> </td>
<td class='confluenceTd'> <font color="#333333">false</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">ExceptionOnSizeLimitExceeded</font> </td>
<td class='confluenceTd'> <font color="#333333">Set to true to throw an exception when a SizeLimitExceededException is received and a LIMIT is not properly enforced.</font> </td>
<td class='confluenceTd'> <font color="#333333">false</font> </td>
</tr>
</tbody></table>
</div>
<p><font color="#333333">There are no import settings for the ldap translator; it also does not provide metadata.</font></p>
<h3><a name="LDAPTranslator-"></a><font color="#000000"><b>Metadata Directives</b></font></h3>
<p><font color="#333333">String columns with a default value of "multivalued-concat" will concatinate all attribute values together in alphabetical order using a ? delimiter. If a multivalued attribute does not have a default value of "multivalued-concat", then any value may be returned.</font></p>
<h3><a name="LDAPTranslator-"></a><font color="#000000"><b>Native Queries</b></font></h3>
<p><font color="#333333">LDAP procedures may optionally have native queries associated with them - see </font><font color="#005e8f">[<font color="#005e8f"></font>Parameterizable Native Queries</font>|#native]<font color=""><font color="#333333"></font>. The operation prefix (select;, insert;, update;, delete; - see the native procedure logic below for more) must be present in the native-query, but it will not be issued as part of the query to the source.</font></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Example DDL for an LDAP native procedure</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
CREATE FOREIGN PROCEDURE proc (arg1 integer, arg2 string) OPTIONS ("teiid_rel:native-query" 'search;context-name=corporate;filter=(&(objectCategory=person)(objectClass=user)(!cn=$2));count-limit=5;timeout=$1;search-scope=ONELEVEL_SCOPE;attributes=uid,cn') returns (col1 string, col2 string);
</pre>
</div></div>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><font color="#333333">Parameter values have reserved characters escaped, but are otherwise directly substituted into the query.</font></td></tr></table></div>
<h4><a name="LDAPTranslator-"></a><font color="#000000"><b>Native Procedure</b></font></h4>
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><font color="#333333">This feature is turned off by default because of the security risk this exposes to execute any command against the source. To enable this feature, override the translator property called "SupportsNativeQueries" to true. Look for </font><font color="#005e8f">[<font color="#005e8f"></font>Override Execution Properties</font>|#Override Execution Properties]<font color=""><font color="#333333"></font> above.</font></td></tr></table></div>
<p><font color="#333333">LDAP translator provides a procedure with name </font><font color="#333333"><b>native</b></font><font color="#333333"> that gives ability to execute any ad-hoc native LDAP queries directly against the source without any Teiid parsing or resolving. The metadata of this procedure's execution results are not known to the Teiid, and they are returned as object array. User can use </font><font color="#005e8f">[<font color="#005e8f"></font>ARRAYTABLE</font>|ARRAYTABLE]<font color=""><font color="#333333"></font> construct to build tabular output for consumption by client applications. Since there is no known direct query language for LDAP, Teiid exposes this procedure with a simple query structure as below</font></p>
<h5><a name="LDAPTranslator-"></a><font color="#000000"><b>Search</b></font></h5>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Search Example</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
SELECT x.* FROM (call pm1.native('search;context-name=corporate;filter=(objectClass=*);count-limit=5;timeout=6;search-scope=ONELEVEL_SCOPE;attributes=uid,cn')) w,
ARRAYTABLE(w.tuple COLUMNS "uid" string , "cn" string) AS x
</pre>
</div></div>
<p><font color="#333333">from the above code, the "</font><font color="#333333"><b>search</b></font><font color="#333333">" keyword followed by below properties. Each property must be delimited by semi-colon (;) If a property contains a semi-colon (;), it should be escaped by another semi-colon - see also</font><font color="#005e8f">[<font color="#005e8f"></font>Parameterizable Native Queries</font>|#native]<font color=""><font color="#333333"></font> and the native-query procedure example above.</font></p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> <font color="#000000">Name</font> </th>
<th class='confluenceTh'> <font color="#000000">Description</font> </th>
<th class='confluenceTh'> <font color="#000000">Required</font> </th>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">context-name</font> </td>
<td class='confluenceTd'> <font color="#333333">LDAP Context name</font> </td>
<td class='confluenceTd'> <font color="#333333">Yes</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">filter</font> </td>
<td class='confluenceTd'> <font color="#333333">query to filter the records in the context</font> </td>
<td class='confluenceTd'> <font color="#333333">No</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">count-limit</font> </td>
<td class='confluenceTd'> <font color="#333333">limit the number of results. same as using LIMIT</font> </td>
<td class='confluenceTd'> <font color="#333333">No</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">timeout</font> </td>
<td class='confluenceTd'> <font color="#333333">Time out the query if not finished in given milliseconds</font> </td>
<td class='confluenceTd'> <font color="#333333">No</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">search-scope</font> </td>
<td class='confluenceTd'> <font color="#333333">LDAP search scope, one of SUBTREE_SCOPE, OBJECT_SCOPE, ONELEVEL_SCOPE</font> </td>
<td class='confluenceTd'> <font color="#333333">No</font> </td>
</tr>
<tr>
<td class='confluenceTd'> <font color="#333333">attributes</font> </td>
<td class='confluenceTd'> <font color="#333333">attributes to retrieve</font> </td>
<td class='confluenceTd'> <font color="#333333">Yes</font> </td>
</tr>
</tbody></table>
</div>
<h5><a name="LDAPTranslator-"></a><font color="#000000"><b>Delete</b></font></h5>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Delete Example</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
SELECT x.* FROM (call pm1.native('delete;uid=doe,ou=people,o=teiid.org')) w,
ARRAYTABLE(w.tuple COLUMNS "updatecount" integer) AS x
</pre>
</div></div>
<p><font color="#333333">form the above code, the "</font><font color="#333333"><b>delete</b></font><font color="#333333">" keyword followed the "DN" string. All the string contents after the "delete;" used as DN.</font></p>
<h5><a name="LDAPTranslator-"></a><font color="#000000"><b>Create or Update</b></font></h5>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Create Example</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
SELECT x.* FROM
(call pm1.native('create;uid=doe,ou=people,o=teiid.org;attributes=one,two,three', 'one', 2, 3.0)) w,
ARRAYTABLE(w.tuple COLUMNS "update_count" integer) AS x
</pre>
</div></div>
<p><font color="#333333">form the above code, the "</font><font color="#333333"><b>create</b></font><font color="#333333">" keyword followed the "DN" string. All the string contents after the "create;" is used as DN. It also takes one property called "attributes" which is comma separated list of attributes. The values for each attribute is specified as separate argument to the "native" procedure.</font></p>
<p><font color="#333333">Update is similar to create</font></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Update Example</b></div><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: sql; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
SELECT x.* FROM
(call pm1.native('update;uid=doe,ou=people,o=teiid.org;attributes=one,two,three', 'one', 2, 3.0)) w,
ARRAYTABLE(w.tuple COLUMNS "update_count" integer) AS x
</pre>
</div></div>
<div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/author/images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><font color="#333333">By default the name of the procedure that executes the queries directly is called </font><font color="#333333"><b>native</b></font><font color="#333333">, however user can</font><br/>
<font color="#333333">set override execution property vdb.xml file to change it.</font></td></tr></table></div>
<h3><a name="LDAPTranslator-"></a><font color="#000000"><b>JCA Resource Adapter</b></font></h3>
<p><font color="#333333">The resource adapter for this translator provided through "LDAP Data Source", Refer to Admin Guide for configuration.</font></p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://docs.jboss.org/author/users/removespacenotification.action?spaceKey=TEIID">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://docs.jboss.org/author/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://docs.jboss.org/author/display/TEIID/LDAP+Translator">View Online</a>
|
<a href="https://docs.jboss.org/author/display/TEIID/LDAP+Translator?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>