ACC SHELL

Path : /usr/share/doc/packages/yast2-ldap-client/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-ldap-client/autodocs/LdapPopup.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html>
 <head>
  <title>
Configuration of LDAP</title>
  <style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
 </head>
 <body>
  <div class="header">
   <i>YaST2 Developers Documentation:</i>
   <a href="index.html">
    <b>
Configuration of LDAP</b>
   </a>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
   <hr />
  </div>
  <div class="menu">
   <img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
   <br />
   <br />
   <a href="index.html">functions</a>
   <br />
   <a href="files.html">files</a>
   <br />
   <a href="intro.html">intro</a>
  </div>
  <div class="main">
   <div class="sigbox">
    <table class="padtbl">
     <tr>
      <td>
       <h1>
Configuration of LDAP</h1>
      </td>
      <td class="filecell">modules/LdapPopup.ycp</td>
     </tr>
     <tr>
      <td>Additional user interface functions: special edit popups</td>
     </tr>
     <tr>
      <td>
       <ul>
        <li>Jiri Suchomel <jsuchome@suse.cz></li>
       </ul>
      </td>
     </tr>
     <tr>
      <td>
       <p>This module has an unstable interface.</p>
      </td>
     </tr>
    </table>
    <table class="padtbl">
     <tr>
      <td>

 Popups for editing the values of LDAP configuration tables.

       <h1>Imports</h1>
       <ul>
        <li>Label</li>
        <li>Ldap</li>
        <li>Popup</li>
        <li>Wizard</li>
       </ul>
       <h1>Global Functions</h1>
       <ul>
        <li>
         <a href="#AddDefaultValue">AddDefaultValue (list available, list conflicts)</a>
        </li>
        <li>
         <a href="#BrowseTree">BrowseTree (string root_dn)</a>
        </li>
        <li>
         <a href="#EditAttribute">EditAttribute (map settings)</a>
        </li>
        <li>
         <a href="#InitAndBrowseTree">InitAndBrowseTree (string root_dn, map connection)</a>
        </li>
        <li>
         <a href="#NewModule">NewModule (list available, list conflicts)</a>
        </li>
        <li>
         <a href="#PasswordPolicyDialog">PasswordPolicyDialog (map ppolicy)</a>
        </li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#generate_value_list">generate_value_list ()</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="BrowseTree">global
     <b>BrowseTree (string root_dn)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Popup for browsing LDAP tree and selecting the DN
 WARNING we expect that LDAP connection is already correctly initialized !</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">root_dn</span>
       </td>
       <td class="descbox">the starting point (root of tree); if empty string is
 given, the search for available bases will be done automatically</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">DN of selected item, empty string when canceled</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="InitAndBrowseTree">global
     <b>InitAndBrowseTree (string root_dn, map connection)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Open the LDAP Browse popup and initialize initialize LDAP connection
 before.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">root_dn</span>
       </td>
       <td class="descbox">the starting point (root of tree); if empty string is
 given, the search for available bases will be done automatically</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">connection</span>
       </td>
       <td class="descbox">init map with information passed to ldap agent
 (see ldap agent '.ldap' Execute call documentation)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">DN of selected item, empty string when canceled</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="EditAttribute">global
     <b>EditAttribute (map settings)
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;string&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Generic popup for editing attribute's value</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">settings</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">of atrtibute values (edited or unchanged)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="generate_value_list">local
     <b>generate_value_list ()
      <span class="a"> -&gt; </span>
      <span class="t">term</span>
     </b>
    </span>
   </div>
   <p>
 Helper for creating items for EditAttribute Popup</p>
   <div class="sigbox">
    <span class="sig" id="NewModule">global
     <b>NewModule (list available, list conflicts)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 Popup for adding new configuration module</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">available</span>
       </td>
       <td class="descbox">list of possible object classes for new module</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">conflicts</span>
       </td>
       <td class="descbox">list of forbidden names ('cn' values)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">of new module (contains its name and object class)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="AddDefaultValue">global
     <b>AddDefaultValue (list available, list conflicts)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 Popup for adding new default value (default value is template's attribute)</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">available</span>
       </td>
       <td class="descbox">list of possible attributes</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">conflicts</span>
       </td>
       <td class="descbox">list of attributes already set</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">of new "default value" (contains attribute name and value)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="PasswordPolicyDialog">global
     <b>PasswordPolicyDialog (map ppolicy)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 dialog for Password Policy configuration object</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">ppolicy</span>
       </td>
       <td class="descbox">data with Password Policy object to be edited (as obtained from LDAP search)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">with modifications of ppolicy object, nil in case of `cancel</td>
      </tr>
     </table>
    </dd>
   </dl>
  </div>
  <div class="footer">
   <hr />
   <i>YaST2 Developers Documentation</i>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
  </div>
 </body>
</html>

ACC SHELL 2018