/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2010 Sun Microsystems, Inc.
|
* Portions Copyright 2011-2016 ForgeRock AS.
|
*/
|
package com.forgerock.opendj.ldap.tools;
|
|
import static com.forgerock.opendj.cli.ArgumentConstants.*;
|
import static com.forgerock.opendj.cli.MultiColumnPrinter.column;
|
import static com.forgerock.opendj.cli.ToolVersionHandler.newSdkVersionHandler;
|
import static com.forgerock.opendj.cli.Utils.*;
|
import static com.forgerock.opendj.ldap.tools.ToolsMessages.*;
|
import static com.forgerock.opendj.cli.CommonArguments.*;
|
|
import java.util.ArrayList;
|
import java.util.Collections;
|
import java.util.LinkedList;
|
import java.util.List;
|
|
import com.codahale.metrics.RatioGauge;
|
import com.forgerock.opendj.cli.MultiColumnPrinter;
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.forgerock.opendj.ldap.Connection;
|
import org.forgerock.opendj.ldap.ConnectionFactory;
|
import org.forgerock.opendj.ldap.DereferenceAliasesPolicy;
|
import org.forgerock.opendj.ldap.LdapException;
|
import org.forgerock.opendj.ldap.ResultCode;
|
import org.forgerock.opendj.ldap.SearchResultHandler;
|
import org.forgerock.opendj.ldap.SearchScope;
|
import org.forgerock.opendj.ldap.requests.Requests;
|
import org.forgerock.opendj.ldap.requests.SearchRequest;
|
import org.forgerock.opendj.ldap.responses.Result;
|
import org.forgerock.opendj.ldap.responses.SearchResultEntry;
|
import org.forgerock.opendj.ldap.responses.SearchResultReference;
|
import org.forgerock.util.promise.Promise;
|
|
import com.forgerock.opendj.cli.ArgumentException;
|
import com.forgerock.opendj.cli.ArgumentParser;
|
import com.forgerock.opendj.cli.BooleanArgument;
|
import com.forgerock.opendj.cli.ConnectionFactoryProvider;
|
import com.forgerock.opendj.cli.ConsoleApplication;
|
import com.forgerock.opendj.cli.MultiChoiceArgument;
|
import com.forgerock.opendj.cli.StringArgument;
|
|
/**
|
* A load generation tool that can be used to load a Directory Server with
|
* Search requests using one or more LDAP connections.
|
*/
|
public final class SearchRate extends ConsoleApplication {
|
private final class SearchPerformanceRunner extends PerformanceRunner {
|
private final class SearchStatsHandler extends UpdateStatsResultHandler<Result> implements SearchResultHandler {
|
private SearchStatsHandler(final long startTime) {
|
super(startTime);
|
}
|
|
@Override
|
public boolean handleEntry(final SearchResultEntry entry) {
|
entryCount.inc();
|
return true;
|
}
|
|
@Override
|
public boolean handleReference(final SearchResultReference reference) {
|
return true;
|
}
|
}
|
|
private final class SearchStatsThread extends StatsThread {
|
private static final int ENTRIES_PER_SEARCH_COLUMN_WIDTH = 5;
|
private static final String ENTRIES_PER_SEARCH = STAT_ID_PREFIX + "entries_per_search";
|
|
private SearchStatsThread(final PerformanceRunner perfRunner, final ConsoleApplication app) {
|
super(perfRunner, app);
|
}
|
|
@Override
|
void resetAdditionalStats() {
|
entryCount = newIntervalCounter();
|
}
|
|
@Override
|
List<MultiColumnPrinter.Column> registerAdditionalColumns() {
|
registry.register(ENTRIES_PER_SEARCH, new RatioGauge() {
|
@Override
|
protected Ratio getRatio() {
|
return Ratio.of(entryCount.refreshIntervalCount(), successCount.getLastIntervalCount());
|
}
|
});
|
return Collections.singletonList(
|
column(ENTRIES_PER_SEARCH, "Entries/Srch", ENTRIES_PER_SEARCH_COLUMN_WIDTH, 1));
|
}
|
}
|
|
private final class SearchWorkerThread extends WorkerThread {
|
private SearchRequest sr;
|
private Object[] data;
|
|
private SearchWorkerThread(final Connection connection,
|
final ConnectionFactory connectionFactory) {
|
super(connection, connectionFactory);
|
}
|
|
@Override
|
public Promise<?, LdapException> performOperation(final Connection connection,
|
final DataSource[] dataSources, final long currentTimeNs) {
|
if (sr == null) {
|
if (dataSources == null) {
|
sr = Requests.newSearchRequest(baseDN, scope, filter, attributes);
|
} else {
|
data = DataSource.generateData(dataSources, data);
|
sr =
|
Requests.newSearchRequest(String.format(baseDN, data), scope,
|
String.format(filter, data), attributes);
|
}
|
sr.setDereferenceAliasesPolicy(dereferencesAliasesPolicy);
|
} else if (dataSources != null) {
|
data = DataSource.generateData(dataSources, data);
|
sr.setFilter(String.format(filter, data));
|
sr.setName(String.format(baseDN, data));
|
}
|
|
final SearchStatsHandler handler = new SearchStatsHandler(currentTimeNs);
|
incrementIterationCount();
|
return connection.searchAsync(sr, handler).thenOnResult(handler).thenOnException(handler);
|
}
|
}
|
|
private String filter;
|
private String baseDN;
|
private SearchScope scope;
|
private DereferenceAliasesPolicy dereferencesAliasesPolicy;
|
private String[] attributes;
|
|
private SearchPerformanceRunner(final PerformanceRunnerOptions options)
|
throws ArgumentException {
|
super(options);
|
}
|
|
@Override
|
WorkerThread newWorkerThread(final Connection connection,
|
final ConnectionFactory connectionFactory) {
|
return new SearchWorkerThread(connection, connectionFactory);
|
}
|
|
@Override
|
StatsThread newStatsThread(final PerformanceRunner performanceRunner, final ConsoleApplication app) {
|
return new SearchStatsThread(performanceRunner, app);
|
}
|
}
|
|
/**
|
* The main method for SearchRate tool.
|
*
|
* @param args
|
* The command-line arguments provided to this program.
|
*/
|
public static void main(final String[] args) {
|
final int retCode = new SearchRate().run(args);
|
System.exit(filterExitCode(retCode));
|
}
|
|
private BooleanArgument verbose;
|
private BooleanArgument scriptFriendly;
|
private StatsThread.IntervalCounter entryCount = StatsThread.newIntervalCounter();
|
|
private SearchRate() {
|
// Nothing to do.
|
}
|
|
@Override
|
public boolean isInteractive() {
|
return false;
|
}
|
|
@Override
|
public boolean isScriptFriendly() {
|
return scriptFriendly.isPresent();
|
}
|
|
@Override
|
public boolean isVerbose() {
|
return verbose.isPresent();
|
}
|
|
private int run(final String[] args) {
|
// Create the command-line argument parser for use with this program.
|
final LocalizableMessage toolDescription = INFO_SEARCHRATE_TOOL_DESCRIPTION.get();
|
final ArgumentParser argParser = LDAPToolArgumentParser.builder(SearchRate.class.getName())
|
.toolDescription(toolDescription)
|
.trailingArgumentsUnbounded(1, "[filter format string] [attributes ...]")
|
.build();
|
argParser.setVersionHandler(newSdkVersionHandler());
|
argParser.setShortToolDescription(REF_SHORT_DESC_SEARCHRATE.get());
|
argParser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_RATE_TOOLS.get());
|
|
ConnectionFactoryProvider connectionFactoryProvider;
|
ConnectionFactory connectionFactory;
|
SearchPerformanceRunner runner;
|
|
StringArgument baseDN;
|
MultiChoiceArgument<SearchScope> searchScope;
|
MultiChoiceArgument<DereferenceAliasesPolicy> dereferencePolicy;
|
BooleanArgument showUsage;
|
StringArgument propertiesFileArgument;
|
BooleanArgument noPropertiesFileArgument;
|
try {
|
Utils.setDefaultPerfToolProperties();
|
|
connectionFactoryProvider = new ConnectionFactoryProvider(argParser, this);
|
runner = new SearchPerformanceRunner(new PerformanceRunnerOptions(argParser, this));
|
|
propertiesFileArgument = propertiesFileArgument();
|
argParser.addArgument(propertiesFileArgument);
|
argParser.setFilePropertiesArgument(propertiesFileArgument);
|
|
noPropertiesFileArgument = noPropertiesFileArgument();
|
argParser.addArgument(noPropertiesFileArgument);
|
argParser.setNoPropertiesFileArgument(noPropertiesFileArgument);
|
|
showUsage = showUsageArgument();
|
argParser.addArgument(showUsage);
|
argParser.setUsageArgument(showUsage, getOutputStream());
|
|
baseDN =
|
StringArgument.builder(OPTION_LONG_BASEDN)
|
.shortIdentifier(OPTION_SHORT_BASEDN)
|
.description(INFO_SEARCHRATE_TOOL_DESCRIPTION_BASEDN.get())
|
.required()
|
.valuePlaceholder(INFO_BASEDN_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
|
searchScope = searchScopeArgument();
|
argParser.addArgument(searchScope);
|
|
dereferencePolicy =
|
MultiChoiceArgument.<DereferenceAliasesPolicy>builder("dereferencePolicy")
|
.shortIdentifier('a')
|
.description(INFO_SEARCH_DESCRIPTION_DEREFERENCE_POLICY.get())
|
.allowedValues(DereferenceAliasesPolicy.values())
|
.defaultValue(DereferenceAliasesPolicy.NEVER)
|
.valuePlaceholder(INFO_DEREFERENCE_POLICE_PLACEHOLDER.get())
|
.buildAndAddToParser(argParser);
|
|
verbose = verboseArgument();
|
argParser.addArgument(verbose);
|
|
scriptFriendly = scriptFriendlySdkArgument();
|
argParser.addArgument(scriptFriendly);
|
} catch (final ArgumentException ae) {
|
final LocalizableMessage message = ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage());
|
errPrintln(message);
|
return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue();
|
}
|
|
// Parse the command-line arguments provided to this program.
|
try {
|
argParser.parseArguments(args);
|
|
// If we should just display usage or version information,
|
// then print it and exit.
|
if (argParser.usageOrVersionDisplayed()) {
|
return 0;
|
}
|
|
connectionFactory = connectionFactoryProvider.getAuthenticatedConnectionFactory();
|
runner.setBindRequest(connectionFactoryProvider.getBindRequest());
|
runner.validate();
|
} catch (final ArgumentException ae) {
|
argParser.displayMessageAndUsageReference(getErrStream(), ERR_ERROR_PARSING_ARGS.get(ae.getMessage()));
|
return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue();
|
}
|
|
final List<String> attributes = new LinkedList<>();
|
final ArrayList<String> filterAndAttributeStrings = argParser.getTrailingArguments();
|
if (!filterAndAttributeStrings.isEmpty()) {
|
/* The list of trailing arguments should be structured as follow:
|
the first trailing argument is considered the filter, the other as attributes.*/
|
runner.filter = filterAndAttributeStrings.remove(0);
|
// The rest are attributes
|
attributes.addAll(filterAndAttributeStrings);
|
}
|
runner.attributes = attributes.toArray(new String[attributes.size()]);
|
runner.baseDN = baseDN.getValue();
|
try {
|
runner.scope = searchScope.getTypedValue();
|
runner.dereferencesAliasesPolicy = dereferencePolicy.getTypedValue();
|
} catch (final ArgumentException ex1) {
|
errPrintln(ex1.getMessageObject());
|
return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue();
|
}
|
|
try {
|
/* Try it out to make sure the format string and data sources match. */
|
final Object[] data = DataSource.generateData(runner.getDataSources(), null);
|
String.format(runner.filter, data);
|
String.format(runner.baseDN, data);
|
} catch (final Exception ex1) {
|
errPrintln(LocalizableMessage.raw("Error formatting filter or base DN: " + ex1));
|
return ResultCode.CLIENT_SIDE_PARAM_ERROR.intValue();
|
}
|
|
return runner.run(connectionFactory);
|
}
|
}
|
