Skip to content

Commit 52bb41d

Browse files
committed
Update documentation for filter creation
Updated the documentation so that it uses new newer, shorter method names in cases where it demonstrates creating a filter from its components.
1 parent b7a9f6f commit 52bb41d

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/advantages/security.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -383,10 +383,10 @@ <h3>Search Filter Construction</h3>
383383
</p>
384384

385385
<pre>
386-
Filter filter = Filter.createANDFilter(
387-
Filter.createEqualityFilter("cn", searchText),
388-
Filter.createEqualityFilter("sn", searchText),
389-
Filter.createEqualityFilter("givenName", searchText));
386+
Filter filter = Filter.and(
387+
Filter.equals("cn", searchText),
388+
Filter.equals("sn", searchText),
389+
Filter.equals("givenName", searchText));
390390
</pre>
391391

392392
<p>

docs/getting-started/controls.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ <h3>The LDAP Subentries Request Control</h3>
263263
// but without including the subentries request control. This should not
264264
// return any matching entries.
265265
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
266-
SearchScope.SUB, Filter.createEqualityFilter("cn", "test subentry"));
266+
SearchScope.SUB, Filter.equals("cn", "test subentry"));
267267
SearchResult resultWithoutControl = connection.search(searchRequest);
268268
LDAPTestUtils.assertResultCodeEquals(resultWithoutControl,
269269
ResultCode.SUCCESS);
@@ -380,7 +380,7 @@ <h3>The Matched Values Control</h3>
380380
SearchRequest searchRequest = new SearchRequest(
381381
"uid=test.user,ou=People,dc=example,dc=com", // Base DN
382382
SearchScope.BASE, // Scope
383-
Filter.createPresenceFilter("objectClass"), // Filter
383+
Filter.present("objectClass"), // Filter
384384
"description"); // Attributes to return.
385385
SearchResultEntry entryRetrievedWithoutControl =
386386
connection.searchForEntry(searchRequest);
@@ -508,7 +508,7 @@ <h3>The Persistent Search and Entry Change Notification Controls</h3>
508508
<pre>
509509
SearchRequest persistentSearchRequest = new SearchRequest(
510510
asyncSearchListener, "dc=example,dc=com", SearchScope.SUB,
511-
Filter.createPresenceFilter("objectClass"));
511+
Filter.present("objectClass"));
512512
persistentSearchRequest.addControl(new PersistentSearchRequestControl(
513513
PersistentSearchChangeType.allChangeTypes(), // Notify change types.
514514
true, // Only return new changes, don't match existing entries.
@@ -624,7 +624,7 @@ <h3>The Server-Side Sort Controls</h3>
624624
// first name, both in ascending order.
625625
SearchRequest searchRequest = new SearchRequest(
626626
"ou=People,dc=example,dc=com", SearchScope.SUB,
627-
Filter.createEqualityFilter("objectClass", "person"));
627+
Filter.equals("objectClass", "person"));
628628
searchRequest.addControl(new ServerSideSortRequestControl(
629629
new SortKey("sn"), new SortKey("givenName")));
630630
SearchResult lastNameAscendingResult;
@@ -714,7 +714,7 @@ <h3>The Simple Paged Results Control</h3>
714714
int numSearches = 0;
715715
int totalEntriesReturned = 0;
716716
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
717-
SearchScope.SUB, Filter.createEqualityFilter("objectClass", "person"));
717+
SearchScope.SUB, Filter.equals("objectClass", "person"));
718718
ASN1OctetString resumeCookie = null;
719719
while (true)
720720
{
@@ -845,7 +845,7 @@ <h3>The Virtual List View Controls</h3>
845845
int numSearches = 0;
846846
int totalEntriesReturned = 0;
847847
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
848-
SearchScope.SUB, Filter.createEqualityFilter("objectClass", "person"));
848+
SearchScope.SUB, Filter.equals("objectClass", "person"));
849849
int vlvOffset = 1;
850850
int vlvContentCount = 0;
851851
ASN1OctetString vlvContextID = null;

src/com/unboundid/ldap/sdk/Filter.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -200,11 +200,11 @@
200200
* these problems, it may be better to construct filters from their individual
201201
* components rather than their string representations, like:
202202
* <PRE>
203-
* Filter f1 = Filter.createPresenceFilter("objectClass");
204-
* Filter f2 = Filter.createEqualityFilter("uid", "john.doe");
205-
* Filter f3 = Filter.createORFilter(
206-
* Filter.createEqualityFilter("givenName", "John"),
207-
* Filter.createEqualityFilter("givenName", "Johnathan"));
203+
* Filter f1 = Filter.present("objectClass");
204+
* Filter f2 = Filter.equals("uid", "john.doe");
205+
* Filter f3 = Filter.or(
206+
* Filter.equals("givenName", "John"),
207+
* Filter.equals("givenName", "Johnathan"));
208208
* </PRE>
209209
* In general, it is recommended to avoid creating filters from their string
210210
* representations if any of that string representation may include

0 commit comments

Comments
 (0)