com.unboundid.ldap.sdk.examples.SearchRateThread Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
The newest version!
/*
* Copyright 2008-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2008-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.examples;
import java.util.List;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.Semaphore;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.DereferencePolicy;
import com.unboundid.ldap.sdk.Filter;
import com.unboundid.ldap.sdk.LDAPConnection;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.LDAPURL;
import com.unboundid.ldap.sdk.LDAPSearchException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.SearchRequest;
import com.unboundid.ldap.sdk.SearchResult;
import com.unboundid.ldap.sdk.SearchResultEntry;
import com.unboundid.ldap.sdk.SearchResultListener;
import com.unboundid.ldap.sdk.SearchResultReference;
import com.unboundid.ldap.sdk.SearchScope;
import com.unboundid.ldap.sdk.controls.ProxiedAuthorizationV2RequestControl;
import com.unboundid.ldap.sdk.controls.SimplePagedResultsControl;
import com.unboundid.util.Debug;
import com.unboundid.util.FixedRateBarrier;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ResultCodeCounter;
import com.unboundid.util.ValuePattern;
/**
* This class provides a thread that may be used to repeatedly perform searches.
*/
final class SearchRateThread
extends Thread
implements SearchResultListener
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -6714705986829223364L;
// Indicates whether a request has been made to stop running.
@NotNull private final AtomicBoolean stopRequested;
// The number of searchrate threads that are currently running.
@NotNull private final AtomicInteger runningThreads;
// The counter used to track the number of entries returned.
@NotNull private final AtomicLong entryCounter;
// The counter used to track the number of errors encountered while searching.
@NotNull private final AtomicLong errorCounter;
// The counter used to track the number of iterations remaining on the
// current connection.
@Nullable private final AtomicLong remainingIterationsBeforeReconnect;
// The counter used to track the number of searches performed.
@NotNull private final AtomicLong searchCounter;
// The value that will be updated with total duration of the searches.
@NotNull private final AtomicLong searchDurations;
// The thread that is actually performing the searches.
@NotNull private final AtomicReference searchThread;
// Indicates whether to operate in asynchronous mode.
private final boolean async;
// The connection to use for the searches.
@Nullable private LDAPConnection connection;
// The result code for this thread.
@NotNull private final AtomicReference resultCode;
// The barrier that will be used to coordinate starting among all the threads.
@NotNull private final CyclicBarrier startBarrier;
// The barrier to use for controlling the rate of searches. null if no
// rate-limiting should be used.
@Nullable private final FixedRateBarrier fixedRateBarrier;
// The page size to use for the simple paged results control, if any.
@Nullable private final Integer simplePageSize;
// The list of controls that should be included in each request.
@NotNull private final List requestControls;
// The number of iterations to request on a connection before closing and
// re-establishing it.
private final long iterationsBeforeReconnect;
// The result code counter to use for failed operations.
@NotNull private final ResultCodeCounter rcCounter;
// A reference to the searchrate tool.
@NotNull private final SearchRate searchRate;
// The search request to generate.
@NotNull private final SearchRequest searchRequest;
// The scope to use for search requests.
@NotNull private final SearchScope scope;
// The semaphore used to limit total number of outstanding asynchronous
// requests.
@Nullable private final Semaphore asyncSemaphore;
// The set of requested attributes for search requests.
@NotNull private final String[] attributes;
// The value pattern to use for proxied authorization.
@Nullable private final ValuePattern authzID;
// The value pattern to use for the base DNs.
@NotNull private final ValuePattern baseDN;
// The value pattern to use for the filters.
@NotNull private final ValuePattern filter;
// The value pattern to use for the LDAP URLs.
@Nullable private final ValuePattern ldapURL;
/**
* Creates a new search rate thread with the provided information.
*
* @param searchRate A reference to the associated searchrate
* tool.
* @param threadNumber The thread number for this thread.
* @param connection The connection to use for the searches.
* @param async Indicates whether to operate in
* asynchronous mode.
* @param baseDN The value pattern to use for the base
* DNs.
* @param scope The scope to use for the searches.
* @param dereferencePolicy The alias dereference policy to use for
* the searches.
* @param sizeLimit The maximum number of entries to return
* in response to each search request.
* @param timeLimitSeconds The maximum length of time, in seconds,
* that the server should spend processing
* each search request.
* @param typesOnly Indicates whether to return entries with
* only attribute names, or with both names
* and values.
* @param filter The value pattern for the filters.
* @param attributes The set of attributes to return.
* @param ldapURL The value pattern for the LDAP URLs.
* @param authzID The value pattern to use to generate
* authorization identities for use with
* the proxied authorization control. It
* may be {@code null} if proxied
* authorization should not be used.
* @param simplePageSize The simple page size to use in
* conjunction with the simple paged
* results request control. It may be
* {@code null} if the simple paged results
* control should not be used.
* @param requestControls A list of controls that should be
* included in every search request.
* @param iterationsBeforeReconnect The number of iterations that should be
* processed on a connection before it is
* closed and replaced with a
* newly-established connection.
* @param runningThreads An atomic integer that will be
* incremented when this thread starts,
* and decremented when it completes.
* @param startBarrier A barrier used to coordinate starting
* between all of the threads.
* @param searchCounter A value that will be used to keep track
* of the total number of searches
* performed.
* @param entryCounter A value that will be used to keep track
* of the total number of entries returned.
* @param searchDurations A value that will be used to keep track
* of the total duration for all searches.
* @param errorCounter A value that will be used to keep track
* of the number of errors encountered
* while searching.
* @param rcCounter The result code counter to use for
* keeping track of the result codes for
* failed operations.
* @param rateBarrier The barrier to use for controlling the
* rate of searches. {@code null} if no
* rate-limiting should be used.
* @param asyncSemaphore The semaphore used ot limit the total
* number of outstanding asynchronous
* requests.
*/
SearchRateThread(@NotNull final SearchRate searchRate,
final int threadNumber,
@NotNull final LDAPConnection connection,
final boolean async,
@NotNull final ValuePattern baseDN,
@NotNull final SearchScope scope,
@NotNull final DereferencePolicy dereferencePolicy,
final int sizeLimit, final int timeLimitSeconds,
final boolean typesOnly,
@NotNull final ValuePattern filter,
@NotNull final String[] attributes,
@Nullable final ValuePattern ldapURL,
@Nullable final ValuePattern authzID,
@Nullable final Integer simplePageSize,
@NotNull final List requestControls,
final long iterationsBeforeReconnect,
@NotNull final AtomicInteger runningThreads,
@NotNull final CyclicBarrier startBarrier,
@NotNull final AtomicLong searchCounter,
@NotNull final AtomicLong entryCounter,
@NotNull final AtomicLong searchDurations,
@NotNull final AtomicLong errorCounter,
@NotNull final ResultCodeCounter rcCounter,
@Nullable final FixedRateBarrier rateBarrier,
@Nullable final Semaphore asyncSemaphore)
{
setName("SearchRate Thread " + threadNumber);
setDaemon(true);
this.searchRate = searchRate;
this.connection = connection;
this.async = async;
this.baseDN = baseDN;
this.scope = scope;
this.filter = filter;
this.attributes = attributes;
this.ldapURL = ldapURL;
this.authzID = authzID;
this.simplePageSize = simplePageSize;
this.requestControls = requestControls;
this.iterationsBeforeReconnect = iterationsBeforeReconnect;
this.searchCounter = searchCounter;
this.entryCounter = entryCounter;
this.searchDurations = searchDurations;
this.errorCounter = errorCounter;
this.rcCounter = rcCounter;
this.runningThreads = runningThreads;
this.startBarrier = startBarrier;
this.asyncSemaphore = asyncSemaphore;
fixedRateBarrier = rateBarrier;
if (iterationsBeforeReconnect > 0L)
{
remainingIterationsBeforeReconnect =
new AtomicLong(iterationsBeforeReconnect);
}
else
{
remainingIterationsBeforeReconnect = null;
}
connection.setConnectionName("search-" + threadNumber);
resultCode = new AtomicReference<>(null);
searchThread = new AtomicReference<>(null);
stopRequested = new AtomicBoolean(false);
searchRequest = new SearchRequest(this, "", scope, dereferencePolicy,
sizeLimit, timeLimitSeconds, typesOnly,
Filter.createPresenceFilter("objectClass"), attributes);
}
/**
* Performs all search processing for this thread.
*/
@Override()
public void run()
{
try
{
searchThread.set(currentThread());
runningThreads.incrementAndGet();
try
{
startBarrier.await();
}
catch (final Exception e)
{
Debug.debugException(e);
}
while (! stopRequested.get())
{
if ((iterationsBeforeReconnect > 0L) &&
(remainingIterationsBeforeReconnect.decrementAndGet() <= 0))
{
remainingIterationsBeforeReconnect.set(iterationsBeforeReconnect);
if (connection != null)
{
connection.close();
connection = null;
}
}
if (connection == null)
{
try
{
connection = searchRate.getConnection();
}
catch (final LDAPException le)
{
Debug.debugException(le);
errorCounter.incrementAndGet();
final ResultCode rc = le.getResultCode();
rcCounter.increment(rc);
resultCode.compareAndSet(null, rc);
if (fixedRateBarrier != null)
{
fixedRateBarrier.await();
}
continue;
}
}
// If we're trying for a specific target rate, then we might need to
// wait until issuing the next search.
if (fixedRateBarrier != null)
{
fixedRateBarrier.await();
}
ProxiedAuthorizationV2RequestControl proxyControl = null;
if (async)
{
if (asyncSemaphore != null)
{
try
{
asyncSemaphore.acquire();
}
catch (final Exception e)
{
Debug.debugException(e);
errorCounter.incrementAndGet();
final ResultCode rc = ResultCode.LOCAL_ERROR;
rcCounter.increment(rc);
resultCode.compareAndSet(null, rc);
continue;
}
}
final SearchRateAsyncListener listener = new SearchRateAsyncListener(
searchCounter, entryCounter, searchDurations, errorCounter,
rcCounter, asyncSemaphore, resultCode);
try
{
final SearchRequest r;
if (ldapURL == null)
{
r = new SearchRequest(listener, baseDN.nextValue(),
scope, searchRequest.getDereferencePolicy(),
searchRequest.getSizeLimit(),
searchRequest.getTimeLimitSeconds(),
searchRequest.typesOnly(), filter.nextValue(), attributes);
}
else
{
final LDAPURL url = new LDAPURL(ldapURL.nextValue());
r = new SearchRequest(listener,
url.getBaseDN().toString(), url.getScope(),
searchRequest.getDereferencePolicy(),
searchRequest.getSizeLimit(),
searchRequest.getTimeLimitSeconds(),
searchRequest.typesOnly(), url.getFilter(),
url.getAttributes());
}
r.setControls(requestControls);
if (authzID != null)
{
r.addControl(new ProxiedAuthorizationV2RequestControl(
authzID.nextValue()));
}
connection.asyncSearch(r);
}
catch (final LDAPException le)
{
Debug.debugException(le);
errorCounter.incrementAndGet();
final ResultCode rc = le.getResultCode();
rcCounter.increment(rc);
resultCode.compareAndSet(null, rc);
if (asyncSemaphore != null)
{
asyncSemaphore.release();
}
continue;
}
}
else
{
try
{
if (ldapURL == null)
{
searchRequest.setBaseDN(baseDN.nextValue());
searchRequest.setFilter(filter.nextValue());
}
else
{
final LDAPURL url = new LDAPURL(ldapURL.nextValue());
searchRequest.setBaseDN(url.getBaseDN());
searchRequest.setScope(url.getScope());
searchRequest.setFilter(url.getFilter());
searchRequest.setAttributes(url.getAttributes());
}
searchRequest.setControls(requestControls);
if (simplePageSize != null)
{
searchRequest.addControl(
new SimplePagedResultsControl(simplePageSize));
}
if (authzID != null)
{
proxyControl = new ProxiedAuthorizationV2RequestControl(
authzID.nextValue());
searchRequest.addControl(proxyControl);
}
}
catch (final LDAPException le)
{
Debug.debugException(le);
errorCounter.incrementAndGet();
final ResultCode rc = le.getResultCode();
rcCounter.increment(rc);
resultCode.compareAndSet(null, rc);
continue;
}
long entriesReturned = 0L;
final long startTime = System.nanoTime();
while (true)
{
SearchResult r;
try
{
r = connection.search(searchRequest);
entriesReturned += r.getEntryCount();
}
catch (final LDAPSearchException lse)
{
Debug.debugException(lse);
r = lse.getSearchResult();
errorCounter.incrementAndGet();
entriesReturned += lse.getEntryCount();
final ResultCode rc = lse.getResultCode();
rcCounter.increment(rc);
resultCode.compareAndSet(null, rc);
if (! lse.getResultCode().isConnectionUsable())
{
connection.close();
connection = null;
}
break;
}
if (simplePageSize == null)
{
break;
}
try
{
final SimplePagedResultsControl sprResponse =
SimplePagedResultsControl.get(r);
if ((sprResponse == null) ||
(! sprResponse.moreResultsToReturn()))
{
break;
}
searchRequest.setControls(requestControls);
if (simplePageSize != null)
{
searchRequest.addControl(new SimplePagedResultsControl(
simplePageSize, sprResponse.getCookie()));
}
if (proxyControl != null)
{
searchRequest.addControl(proxyControl);
}
}
catch (final Exception e)
{
Debug.debugException(e);
break;
}
}
searchCounter.incrementAndGet();
searchDurations.addAndGet(System.nanoTime() - startTime);
entryCounter.addAndGet(entriesReturned);
}
}
// Wait for all outstanding asynchronous searches to complete before
// closing the connection.
if (asyncSemaphore != null)
{
while (asyncSemaphore.availablePermits() <
searchRate.getMaxOutstandingRequests())
{
try
{
Thread.sleep(1L);
}
catch (final Exception e)
{
Debug.debugException(e);
if (e instanceof InterruptedException)
{
Thread.currentThread().interrupt();
break;
}
}
}
}
}
finally
{
if (connection != null)
{
connection.close();
}
searchThread.set(null);
runningThreads.decrementAndGet();
}
}
/**
* Indicates that this thread should stop running. It will not wait for the
* thread to complete before returning.
*/
void signalShutdown()
{
stopRequested.set(true);
if (fixedRateBarrier != null)
{
fixedRateBarrier.shutdownRequested();
}
}
/**
* Waits for this thread to stop running.
*
* @return A result code that provides information about whether any errors
* were encountered during processing.
*/
@NotNull()
ResultCode waitForShutdown()
{
final Thread t = searchThread.get();
if (t != null)
{
try
{
t.join();
}
catch (final Exception e)
{
Debug.debugException(e);
if (e instanceof InterruptedException)
{
Thread.currentThread().interrupt();
}
}
}
resultCode.compareAndSet(null, ResultCode.SUCCESS);
return resultCode.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void searchEntryReturned(@NotNull final SearchResultEntry searchEntry)
{
// No implementation required.
}
/**
* {@inheritDoc}
*/
@Override()
public void searchReferenceReturned(
@NotNull final SearchResultReference searchReference)
{
// No implementation required.
}
}