Skip to content

Commit

Permalink
Update documentation for filter creation
Browse files Browse the repository at this point in the history
Updated the documentation so that it uses new newer, shorter method
names in cases where it demonstrates creating a filter from its
components.
  • Loading branch information
dirmgr committed Mar 8, 2023
1 parent b7a9f6f commit 52bb41d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/advantages/security.html
Original file line number Diff line number Diff line change
Expand Up @@ -383,10 +383,10 @@ <h3>Search Filter Construction</h3>
</p>

<pre>
Filter filter = Filter.createANDFilter(
Filter.createEqualityFilter("cn", searchText),
Filter.createEqualityFilter("sn", searchText),
Filter.createEqualityFilter("givenName", searchText));
Filter filter = Filter.and(
Filter.equals("cn", searchText),
Filter.equals("sn", searchText),
Filter.equals("givenName", searchText));
</pre>

<p>
Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started/controls.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ <h3>The LDAP Subentries Request Control</h3>
// but without including the subentries request control. This should not
// return any matching entries.
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
SearchScope.SUB, Filter.createEqualityFilter("cn", "test subentry"));
SearchScope.SUB, Filter.equals("cn", "test subentry"));
SearchResult resultWithoutControl = connection.search(searchRequest);
LDAPTestUtils.assertResultCodeEquals(resultWithoutControl,
ResultCode.SUCCESS);
Expand Down Expand Up @@ -380,7 +380,7 @@ <h3>The Matched Values Control</h3>
SearchRequest searchRequest = new SearchRequest(
"uid=test.user,ou=People,dc=example,dc=com", // Base DN
SearchScope.BASE, // Scope
Filter.createPresenceFilter("objectClass"), // Filter
Filter.present("objectClass"), // Filter
"description"); // Attributes to return.
SearchResultEntry entryRetrievedWithoutControl =
connection.searchForEntry(searchRequest);
Expand Down Expand Up @@ -508,7 +508,7 @@ <h3>The Persistent Search and Entry Change Notification Controls</h3>
<pre>
SearchRequest persistentSearchRequest = new SearchRequest(
asyncSearchListener, "dc=example,dc=com", SearchScope.SUB,
Filter.createPresenceFilter("objectClass"));
Filter.present("objectClass"));
persistentSearchRequest.addControl(new PersistentSearchRequestControl(
PersistentSearchChangeType.allChangeTypes(), // Notify change types.
true, // Only return new changes, don't match existing entries.
Expand Down Expand Up @@ -624,7 +624,7 @@ <h3>The Server-Side Sort Controls</h3>
// first name, both in ascending order.
SearchRequest searchRequest = new SearchRequest(
"ou=People,dc=example,dc=com", SearchScope.SUB,
Filter.createEqualityFilter("objectClass", "person"));
Filter.equals("objectClass", "person"));
searchRequest.addControl(new ServerSideSortRequestControl(
new SortKey("sn"), new SortKey("givenName")));
SearchResult lastNameAscendingResult;
Expand Down Expand Up @@ -714,7 +714,7 @@ <h3>The Simple Paged Results Control</h3>
int numSearches = 0;
int totalEntriesReturned = 0;
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
SearchScope.SUB, Filter.createEqualityFilter("objectClass", "person"));
SearchScope.SUB, Filter.equals("objectClass", "person"));
ASN1OctetString resumeCookie = null;
while (true)
{
Expand Down Expand Up @@ -845,7 +845,7 @@ <h3>The Virtual List View Controls</h3>
int numSearches = 0;
int totalEntriesReturned = 0;
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
SearchScope.SUB, Filter.createEqualityFilter("objectClass", "person"));
SearchScope.SUB, Filter.equals("objectClass", "person"));
int vlvOffset = 1;
int vlvContentCount = 0;
ASN1OctetString vlvContextID = null;
Expand Down
10 changes: 5 additions & 5 deletions src/com/unboundid/ldap/sdk/Filter.java
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,11 @@
* these problems, it may be better to construct filters from their individual
* components rather than their string representations, like:
* <PRE>
* Filter f1 = Filter.createPresenceFilter("objectClass");
* Filter f2 = Filter.createEqualityFilter("uid", "john.doe");
* Filter f3 = Filter.createORFilter(
* Filter.createEqualityFilter("givenName", "John"),
* Filter.createEqualityFilter("givenName", "Johnathan"));
* Filter f1 = Filter.present("objectClass");
* Filter f2 = Filter.equals("uid", "john.doe");
* Filter f3 = Filter.or(
* Filter.equals("givenName", "John"),
* Filter.equals("givenName", "Johnathan"));
* </PRE>
* In general, it is recommended to avoid creating filters from their string
* representations if any of that string representation may include
Expand Down

0 comments on commit 52bb41d

Please sign in to comment.