Google Git
Sign in
apache / jmeter-site-preview / d47eb470b25a0b4572af584c55b5ce93fe403282 / . / site / api / org / apache / jmeter / protocol / ldap / sampler / LdapExtClient.html
blob: de989de824bff6b915dd42371d4e2626d7654e85 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>LdapExtClient (Apache JMeter dist API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.jmeter.protocol.ldap.sampler, class: LdapExtClient">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache JMeter</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jmeter.protocol.ldap.sampler</a></div>
<h1 title="Class LdapExtClient" class="title">Class LdapExtClient</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.jmeter.protocol.ldap.sampler.LdapExtClient</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LdapExtClient</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Ldap Client class is main class to create ,modify, search and delete all the
LDAP functionality available
Based on the work of: author T.Elanjchezhiyan(chezhiyan@siptech.co.in)</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingEnumeration.html" title="class or interface in javax.naming" class="external-link">NamingEnumeration</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchResult.html" title="class or interface in javax.naming.directory" class="external-link">SearchResult</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#compare(javax.naming.directory.DirContext,java.lang.String,java.lang.String)" class="member-name-link">compare</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;entrydn)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Filter the data in the ldap directory</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#connect(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean,boolean)" class="member-name-link">connect</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;host,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;port,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;rootdn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;password,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;connTimeOut,
boolean&nbsp;secure,
boolean&nbsp;trustAll)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">connect to server</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createTest(javax.naming.directory.DirContext,javax.naming.directory.Attributes,java.lang.String)" class="member-name-link">createTest</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/Attributes.html" title="class or interface in javax.naming.directory" class="external-link">Attributes</a>&nbsp;attributes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;string)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Create the entry in the ldap directory for the given string</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deleteTest(javax.naming.directory.DirContext,java.lang.String)" class="member-name-link">deleteTest</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;string)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Delete the attribute from the ldap directory</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#disconnect(javax.naming.directory.DirContext)" class="member-name-link">disconnect</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">disconnect from the server</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#moddnOp(javax.naming.directory.DirContext,java.lang.String,java.lang.String)" class="member-name-link">moddnOp</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;ddn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;newdn)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">ModDN the data in the ldap directory for the given search base</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#modifyTest(javax.naming.directory.DirContext,javax.naming.directory.ModificationItem%5B%5D,java.lang.String)" class="member-name-link">modifyTest</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/ModificationItem.html" title="class or interface in javax.naming.directory" class="external-link">ModificationItem</a>[]&nbsp;mods,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;string)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Modify the attribute in the ldap directory for the given string</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingEnumeration.html" title="class or interface in javax.naming" class="external-link">NamingEnumeration</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchResult.html" title="class or interface in javax.naming.directory" class="external-link">SearchResult</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#searchTest(javax.naming.directory.DirContext,java.lang.String,java.lang.String,int,long,int,java.lang.String%5B%5D,boolean,boolean)" class="member-name-link">searchTest</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;searchBase,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;searchFilter,
int&nbsp;scope,
long&nbsp;countlim,
int&nbsp;timelim,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;attrs,
boolean&nbsp;retobj,
boolean&nbsp;deref)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Filter the data in the ldap directory for the given search base</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="connect(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean,boolean)">
<h3>connect</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a></span>&nbsp;<span class="element-name">connect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;host,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;port,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;rootdn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;password,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;connTimeOut,
boolean&nbsp;secure,
boolean&nbsp;trustAll)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">connect to server</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>host</code> - name of the server to connect</dd>
<dd><code>port</code> - port of the server to connect</dd>
<dd><code>rootdn</code> - base of the tree to operate on</dd>
<dd><code>username</code> - name of the user to use for binding</dd>
<dd><code>password</code> - password to use for binding</dd>
<dd><code>connTimeOut</code> - connection timeout for connecting the server see
"com.sun.jndi.ldap.connect.timeout"</dd>
<dd><code>secure</code> - flag whether ssl should be used</dd>
<dd><code>trustAll</code> - flag whether we should trust all certificates</dd>
<dt>Returns:</dt>
<dd>newly created <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link"><code>DirContext</code></a></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when creating the <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link"><code>DirContext</code></a> fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="disconnect(javax.naming.directory.DirContext)">
<h3>disconnect</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">disconnect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext)</span></div>
<div class="block">disconnect from the server</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - context do disconnect (may be <code>null</code>)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="searchTest(javax.naming.directory.DirContext,java.lang.String,java.lang.String,int,long,int,java.lang.String[],boolean,boolean)">
<h3>searchTest</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingEnumeration.html" title="class or interface in javax.naming" class="external-link">NamingEnumeration</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchResult.html" title="class or interface in javax.naming.directory" class="external-link">SearchResult</a>&gt;</span>&nbsp;<span class="element-name">searchTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;searchBase,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;searchFilter,
int&nbsp;scope,
long&nbsp;countlim,
int&nbsp;timelim,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;attrs,
boolean&nbsp;retobj,
boolean&nbsp;deref)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">Filter the data in the ldap directory for the given search base</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - context to perform the search on</dd>
<dd><code>searchBase</code> - base where the search should start</dd>
<dd><code>searchFilter</code> - filter this value from the base</dd>
<dd><code>scope</code> - scope for search. May be one of
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchControls.html#OBJECT_SCOPE" title="class or interface in javax.naming.directory" class="external-link"><code>SearchControls.OBJECT_SCOPE</code></a>,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchControls.html#ONELEVEL_SCOPE" title="class or interface in javax.naming.directory" class="external-link"><code>SearchControls.ONELEVEL_SCOPE</code></a> or
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchControls.html#SUBTREE_SCOPE" title="class or interface in javax.naming.directory" class="external-link"><code>SearchControls.SUBTREE_SCOPE</code></a></dd>
<dd><code>countlim</code> - max number of results to get, <code>0</code> for all entries</dd>
<dd><code>timelim</code> - max time to wait for entries (in milliseconds), <code>0</code>
for unlimited time</dd>
<dd><code>attrs</code> - list of attributes to return. If <code>null</code> all
attributes will be returned. If empty, none will be returned</dd>
<dd><code>retobj</code> - flag whether the objects should be returned</dd>
<dd><code>deref</code> - flag whether objects should be dereferenced</dd>
<dt>Returns:</dt>
<dd>result of the search</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when searching fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="compare(javax.naming.directory.DirContext,java.lang.String,java.lang.String)">
<h3>compare</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingEnumeration.html" title="class or interface in javax.naming" class="external-link">NamingEnumeration</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/SearchResult.html" title="class or interface in javax.naming.directory" class="external-link">SearchResult</a>&gt;</span>&nbsp;<span class="element-name">compare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;entrydn)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">Filter the data in the ldap directory</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - the context to operate on</dd>
<dd><code>filter</code> - filter this value from the base</dd>
<dd><code>entrydn</code> - distinguished name of entry to compare</dd>
<dt>Returns:</dt>
<dd>result of the search</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when searching fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="moddnOp(javax.naming.directory.DirContext,java.lang.String,java.lang.String)">
<h3>moddnOp</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">moddnOp</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;ddn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;newdn)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">ModDN the data in the ldap directory for the given search base</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - context to operate on</dd>
<dd><code>ddn</code> - distinguished name of object to rename</dd>
<dd><code>newdn</code> - new distinguished name of object</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when renaming fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="modifyTest(javax.naming.directory.DirContext,javax.naming.directory.ModificationItem[],java.lang.String)">
<h3>modifyTest</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">modifyTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/ModificationItem.html" title="class or interface in javax.naming.directory" class="external-link">ModificationItem</a>[]&nbsp;mods,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;string)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">Modify the attribute in the ldap directory for the given string</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - context to operate on</dd>
<dd><code>mods</code> - list of all the <a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/ModificationItem.html" title="class or interface in javax.naming.directory" class="external-link"><code>ModificationItem</code></a>s to apply on
<code>string</code></dd>
<dd><code>string</code> - distinguished name of the object to modify</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when modification fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createTest(javax.naming.directory.DirContext,javax.naming.directory.Attributes,java.lang.String)">
<h3>createTest</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a></span>&nbsp;<span class="element-name">createTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/Attributes.html" title="class or interface in javax.naming.directory" class="external-link">Attributes</a>&nbsp;attributes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;string)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">Create the entry in the ldap directory for the given string</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - context to operate on</dd>
<dd><code>attributes</code> - add all the attributes and values from the attributes object</dd>
<dd><code>string</code> - distinguished name of the subcontext to create</dd>
<dt>Returns:</dt>
<dd>newly created subcontext</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when creating subcontext fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deleteTest(javax.naming.directory.DirContext,java.lang.String)">
<h3>deleteTest</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">deleteTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html" title="class or interface in javax.naming.directory" class="external-link">DirContext</a>&nbsp;dirContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;string)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></span></div>
<div class="block">Delete the attribute from the ldap directory</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dirContext</code> - context to operate on</dd>
<dd><code>string</code> - distinguished name of the subcontext to destroy</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/NamingException.html" title="class or interface in javax.naming" class="external-link">NamingException</a></code> - when destroying the subcontext fails</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>