com.unboundid.scim.tools

Class SCIMQueryRate

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.scim.tools.SCIMQueryRate

public class SCIMQueryRate
extends com.unboundid.util.CommandLineTool

This class provides a tool that can be used to query a SCIM server repeatedly using multiple threads. It can help provide an estimate of the query performance that a SCIM server is able to achieve. The query filter may be a value pattern as described in the ValuePattern class. This makes it possible to query over a range of resources rather than repeatedly performing queries with the same filter.

All of the necessary information is provided using command line arguments. Supported arguments are as follows:

• "-h {address}" or "--hostname {address}" -- Specifies the address of the SCIM server. If this isn't specified, then a default of "localhost" will be used.
• "-p {port}" or "--port {port}" -- Specifies the port number of the SCIM server. If this isn't specified, then a default port of 80 will be used.
• "--contextPath {path}" -- specifies the context path of the SCIM server. If no context path is specified, then the default value '/' is used.
• "--authID {userName}" -- Specifies the authentication ID to use when authenticating using basic auth.
• "-w {password}" or "--authPassword {password}" -- Specifies the password to use when authenticating using basic auth or a password-based SASL mechanism.
• "--bearerToken {b64token}" -- Specifies the OAuth2 bearer token to use when authenticating using OAuth
• "--resourceName {resource-name}" -- specifies the name of resources to be queried. If this isn't specified, then a default of "User" will be used.
• "-x" or "--xml" -- Specifies XML format in requests rather than JSON format.
• "-f {filter}" or "--filter {filter}" -- specifies the filter to use for the queries. It may be a simple filter, or it may be a value pattern to express a range of filters. If this isn't specified, then no filtering is requested.
• "-A {name}" or "--attribute {name}" -- specifies the name of an attribute that should be included in resources returned from the server. If this isn't specified, then all resource attributes will be requested. Multiple attributes may be requested with multiple instances of this argument.
• "-t {num}" or "--numThreads {num}" -- specifies the number of concurrent threads to use when performing the queries. If this is not provided, then a default of one thread will be used.
• "-i {sec}" or "--intervalDuration {sec}" -- specifies the length of time in seconds between lines out output. If this is not provided, then a default interval duration of five seconds will be used.
• "-I {num}" or "--numIntervals {num}" -- specifies the maximum number of intervals for which to run. If this is not provided, then it will run forever.
• "-r {queries-per-second}" or "--ratePerSecond {queries-per-second}" -- specifies the target number of queries to perform per second. It is still necessary to specify a sufficient number of threads for achieving this rate. If this option is not provided, then the tool will run at the maximum rate for the specified number of threads.
• "--warmUpIntervals {num}" -- specifies the number of intervals to complete before beginning overall statistics collection.
• "--timestampFormat {format}" -- specifies the format to use for timestamps included before each output line. The format may be one of "none" (for no timestamps), "with-date" (to include both the date and the time), or "without-date" (to include only time time).
• "-c" or "--csv" -- Generate output in CSV format rather than a display-friendly format.

Constructor Summary

Constructors

Constructor and Description
SCIMQueryRate(OutputStream outStream, OutputStream errStream) Creates a new instance of this tool.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToolArguments(com.unboundid.util.args.ArgumentParser parser)
com.unboundid.ldap.sdk.ResultCode	doToolProcessing() Performs the actual processing for this tool.
LinkedHashMap<String[],String>	getExampleUsages()
String	getToolDescription() Retrieves the description for this tool.
String	getToolName() Retrieves the name for this tool.
static void	main(String[] args) Parse the provided command line arguments and make the appropriate set of changes.
static com.unboundid.ldap.sdk.ResultCode	main(String[] args, OutputStream outStream, OutputStream errStream) Parse the provided command line arguments and make the appropriate set of changes.

Methods inherited from class com.unboundid.util.CommandLineTool

createArgumentParser, defaultsToInteractiveMode, doExtendedArgumentValidation, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOut, getToolVersion, getTrailingArgumentsPlaceholder, out, registerShutdownHook, runTool, supportsInteractiveMode, supportsPropertiesFile, wrapErr, wrapOut

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SCIMQueryRate

public SCIMQueryRate(OutputStream outStream,
             OutputStream errStream)

Creates a new instance of this tool.

Parameters:

outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.

errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.

Method Detail

main

public static void main(String[] args)

Parse the provided command line arguments and make the appropriate set of changes.

Parameters:

args - The command line arguments provided to this program.

main

public static com.unboundid.ldap.sdk.ResultCode main(String[] args,
                                     OutputStream outStream,
                                     OutputStream errStream)

Parse the provided command line arguments and make the appropriate set of changes.

Parameters:

args - The command line arguments provided to this program.

outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.

errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.

Returns:

A result code indicating whether the processing was successful.

getToolName

public String getToolName()

Retrieves the name for this tool.

Specified by:

getToolName in class com.unboundid.util.CommandLineTool

Returns:

The name for this tool.

getToolDescription

public String getToolDescription()

Retrieves the description for this tool.

Specified by:

getToolDescription in class com.unboundid.util.CommandLineTool

Returns:

The description for this tool.

addToolArguments

public void addToolArguments(com.unboundid.util.args.ArgumentParser parser)
                      throws com.unboundid.util.args.ArgumentException

Specified by:

addToolArguments in class com.unboundid.util.CommandLineTool

Throws:

com.unboundid.util.args.ArgumentException

getExampleUsages

public LinkedHashMap<String[],String> getExampleUsages()

Overrides:

getExampleUsages in class com.unboundid.util.CommandLineTool

doToolProcessing

public com.unboundid.ldap.sdk.ResultCode doToolProcessing()

Performs the actual processing for this tool. In this case, it gets a connection to the directory server and uses it to perform the requested searches.

Specified by:

doToolProcessing in class com.unboundid.util.CommandLineTool

Returns:

The result code for the processing that was performed.