From dd191612403bc6e43be84c7942ac06dece82dfa0 Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Mon, 09 Jan 2012 00:06:48 +0000
Subject: [PATCH] Fix OPENDJ-128: Improve usage information provided with xxxrate tools
---
opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties | 23 +++++++----
opendj-sdk/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml.vm | 6 +-
opendj-sdk/opendj3/opendj-ldap-toolkit/pom.xml | 6 ++
opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/ArgumentParser.java | 14 +++---
opendj-sdk/opendj3/pom.xml | 15 ++++++-
opendj-sdk/opendj3/opendj-ldap-sdk/pom.xml | 4 -
opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml | 14 +++---
7 files changed, 51 insertions(+), 31 deletions(-)
diff --git a/opendj-sdk/opendj3/opendj-ldap-sdk/pom.xml b/opendj-sdk/opendj3/opendj-ldap-sdk/pom.xml
index 33be3af..53b2fae 100644
--- a/opendj-sdk/opendj3/opendj-ldap-sdk/pom.xml
+++ b/opendj-sdk/opendj3/opendj-ldap-sdk/pom.xml
@@ -22,7 +22,7 @@
!
! CDDL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -43,8 +43,6 @@
<dependency>
<groupId>org.forgerock.commons</groupId>
<artifactId>i18n-core</artifactId>
- <version>1.2.0</version>
- <scope>compile</scope>
</dependency>
<dependency>
<groupId>org.glassfish.grizzly</groupId>
diff --git a/opendj-sdk/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml.vm b/opendj-sdk/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
index ae611a8..a8df266 100644
--- a/opendj-sdk/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
+++ b/opendj-sdk/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -108,8 +108,8 @@
</p>
<ul>
<li><a href="http://builds.forgerock.org/view/OpenDJ/job/OpenDJ3/lastStableBuild/org.forgerock.opendj$opendj-ldap-sdk/artifact/org.forgerock.opendj/opendj-ldap-sdk/${currentSDKversion}/opendj-ldap-sdk-${currentSDKversion}.jar">opendj-ldap-sdk-${currentSDKversion}.jar</a> - OpenDJ LDAP SDK</li>
- <li><a href="http://maven.forgerock.org/repo/releases/org/forgerock/commons/i18n-core/1.2.0/i18n-core-1.2.0.jar">i18n-core-1.2.0.jar</a> - ForgeRock Commons I18N Framework</li>
- <li><a href="http://search.maven.org/remotecontent?filepath=org/glassfish/grizzly/grizzly-framework/2.1.2/grizzly-framework-2.1.2.jar">grizzly-framework-2.1.2.jar</a> - Grizzly IO Framework</li>
+ <li><a href="http://maven.forgerock.org/repo/releases/org/forgerock/commons/i18n-core/${i18nFrameworkVersion}/i18n-core-${i18nFrameworkVersion}.jar">i18n-core-${i18nFrameworkVersion}.jar</a> - ForgeRock Commons I18N Framework</li>
+ <li><a href="http://search.maven.org/remotecontent?filepath=org/glassfish/grizzly/grizzly-framework/2.1.7/grizzly-framework-2.1.7.jar">grizzly-framework-2.1.7.jar</a> - Grizzly IO Framework</li>
<li><a href="http://search.maven.org/remotecontent?filepath=org/glassfish/gmbal/gmbal-api-only/3.0.0-b023/gmbal-api-only-3.0.0-b023.jar">gmbal-api-only-3.0.0-b023.jar</a> - Glassfish Management API</li>
<li><a href="http://search.maven.org/remotecontent?filepath=org/glassfish/external/management-api/3.0.0-b012/management-api-3.0.0-b012.jar">management-api-3.0.0-b012.jar</a> - Glassfish Common Management API</li>
</ul>
diff --git a/opendj-sdk/opendj3/opendj-ldap-toolkit/pom.xml b/opendj-sdk/opendj3/opendj-ldap-toolkit/pom.xml
index d0dd34f..03786ef 100644
--- a/opendj-sdk/opendj3/opendj-ldap-toolkit/pom.xml
+++ b/opendj-sdk/opendj3/opendj-ldap-toolkit/pom.xml
@@ -22,7 +22,7 @@
!
! CDDL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -51,6 +51,10 @@
<version>${project.version}</version>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.forgerock.commons</groupId>
+ <artifactId>i18n-core</artifactId>
+ </dependency>
</dependencies>
<build>
<plugins>
diff --git a/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/ArgumentParser.java b/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/ArgumentParser.java
index faee42c..66a0283 100644
--- a/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/ArgumentParser.java
+++ b/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/ArgumentParser.java
@@ -23,6 +23,7 @@
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
+ * Portions copyright 2012 ForgeRock AS.
*/
package com.forgerock.opendj.ldap.tools;
@@ -812,13 +813,6 @@
void getUsage(final StringBuilder buffer)
{
usageOrVersionDisplayed = true;
- if ((toolDescription != null) && (toolDescription.length() > 0))
- {
- buffer.append(wrapText(toolDescription.toString(), MAX_LENGTH - 1));
- buffer.append(EOL);
- buffer.append(EOL);
- }
-
final String scriptName = System.getProperty(PROPERTY_SCRIPT_NAME);
if ((scriptName == null) || (scriptName.length() == 0))
{
@@ -843,6 +837,12 @@
}
buffer.append(EOL);
buffer.append(EOL);
+ if ((toolDescription != null) && (toolDescription.length() > 0))
+ {
+ buffer.append(wrapText(toolDescription.toString(), MAX_LENGTH - 1));
+ buffer.append(EOL);
+ buffer.append(EOL);
+ }
buffer.append(INFO_SUBCMDPARSER_WHERE_OPTIONS_INCLUDE.get());
buffer.append(EOL);
buffer.append(EOL);
diff --git a/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties b/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
index bb49818..49e6c80 100755
--- a/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
+++ b/opendj-sdk/opendj3/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
@@ -119,7 +119,7 @@
INFO_TIME_IN_DAYS_HOURS_MINUTES_SECONDS=%d days, %d hours, %d minutes, %d \
seconds
INFO_ARGPARSER_USAGE=Usage:
-INFO_SUBCMDPARSER_WHERE_OPTIONS_INCLUDE=Where {options} include:
+INFO_SUBCMDPARSER_WHERE_OPTIONS_INCLUDE=Command options:
ERR_MENU_BAD_CHOICE_SINGLE=Invalid response. Please enter a valid \
menu option
INFO_MENU_PROMPT_SINGLE=Enter choice:
@@ -376,9 +376,9 @@
property values used for command line arguments
INFO_DESCRIPTION_NO_PROP_FILE=No properties file will be \
used to get default command line argument values
-INFO_DESCRIPTION_GENERAL_ARGS=General Options
-INFO_DESCRIPTION_IO_ARGS=Utility Input/Output Options
-INFO_DESCRIPTION_LDAP_CONNECTION_ARGS=LDAP Connection Options
+INFO_DESCRIPTION_GENERAL_ARGS=General options:
+INFO_DESCRIPTION_IO_ARGS=Utility input/output options:
+INFO_DESCRIPTION_LDAP_CONNECTION_ARGS=LDAP connection options:
INFO_FILE_PLACEHOLDER={file}
INFO_KEYSTOREPATH_PLACEHOLDER={keyStorePath}
INFO_TRUSTSTOREPATH_PLACEHOLDER={trustStorePath}
@@ -428,19 +428,26 @@
ERR_DECODE_CONTROL_FAILURE=# %s
INFO_SEARCHRATE_TOOL_DESCRIPTION=This utility can be used to measure \
search throughput and response time of a directory service using \
- user-defined searches
+ user-defined searches.\n\n\
+ Example:\n\n\ \ searchrate -p 1389 -b "dc=example,dc=com" \\\n\
+ \ \ \ \ -g "rand(names.txt)" "(uid=%%s)" -A -F -c 4 -t 4
INFO_SEARCHRATE_TOOL_DESCRIPTION_BASEDN=Base DN format string.
INFO_MODRATE_TOOL_DESCRIPTION=This utility can be used to measure \
modify throughput and response time of a directory service using \
- user-defined modifications
+ user-defined modifications.\n\n\
+ Example:\n\n\ \ modrate -p 1389 -D "cn=directory manager" -w password \\\n\
+ \ \ \ \ -b "uid=%%s,ou=people,dc=example,dc=com" -g "rand(names.txt)" \\\n\
+ \ \ \ \ 'description:%%2$s' -g "randstr(16)" -A -F -c 4 -t 4
INFO_MODRATE_TOOL_DESCRIPTION_TARGETDN=Target entry DN format string
INFO_AUTHRATE_TOOL_DESCRIPTION=This utility can be used to measure \
bind throughput and response time of a directory service using \
- user-defined bind or search-then-bind operations. Format strings may be \
+ user-defined bind or search-then-bind operations.\n\nFormat strings may be \
used in the bind DN option as well as the authid and authzid SASL bind \
options. A search operation may be used to retrieve the bind DN by \
specifying the base DN and a filter. The retrieved entry DN will be appended \
- as the last argument in the argument list when evaluating format strings.
+ as the last argument in the argument list when evaluating format strings.\n\n\
+ Example:\n\n\ \ authrate -p 1389 -D "uid=%%s,ou=people,dc=example,dc=com" \\\n\
+ \ \ \ \ -w password -g "rand(names.txt)" -c 10 -f
INFO_OUTPUT_LDIF_FILE_PLACEHOLDER={file}
INFO_LDIFMODIFY_DESCRIPTION_OUTPUT_FILENAME=Write updated entries to %s \
instead of stdout
diff --git a/opendj-sdk/opendj3/pom.xml b/opendj-sdk/opendj3/pom.xml
index 5fd1871..1ec421b 100644
--- a/opendj-sdk/opendj3/pom.xml
+++ b/opendj-sdk/opendj3/pom.xml
@@ -22,7 +22,7 @@
!
! CDDL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -110,6 +110,7 @@
<site-out>${basedir}/target/site</site-out>
<legalnotice>${basedir}/target/docbkx/html/legalnotice.html</legalnotice>
<siteDistributionURL>scp://forgerock.org/var/www/vhosts/opendj.forgerock.org/httpdocs</siteDistributionURL>
+ <i18nFrameworkVersion>1.4.0</i18nFrameworkVersion>
</properties>
<build>
<plugins>
@@ -782,7 +783,7 @@
<plugin>
<groupId>org.forgerock.commons</groupId>
<artifactId>i18n-maven-plugin</artifactId>
- <version>1.2.0</version>
+ <version>${i18nFrameworkVersion}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -852,6 +853,16 @@
</repository>
-->
</repositories>
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.forgerock.commons</groupId>
+ <artifactId>i18n-core</artifactId>
+ <version>${i18nFrameworkVersion}</version>
+ <scope>compile</scope>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
<dependencies>
<dependency>
<groupId>org.easytesting</groupId>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
index 20db56b..4edc165 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<chapter xml:id='chap-get-sdk'
@@ -118,15 +118,15 @@
<filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/lib/</filename>.</para>
<screen>(UNIX)
$ export CLASSPATH=/path/to/lib/gmbal-api-only-3.0.0-b023.jar:$CLASSPATH
-$ export CLASSPATH=/path/to/lib/grizzly-framework-2.1.2.jar:$CLASSPATH
-$ export CLASSPATH=/path/to/lib/i18n-core-1.2.0.jar:$CLASSPATH
+$ export CLASSPATH=/path/to/lib/grizzly-framework-2.1.7.jar:$CLASSPATH
+$ export CLASSPATH=/path/to/lib/i18n-core-1.4.0.jar:$CLASSPATH
$ export CLASSPATH=/path/to/lib/management-api-3.0.0-b012.jar:$CLASSPATH
$ export CLASSPATH=/path/to/lib/opendj-ldap-sdk-<?eval ${currentSDKversion}?>.jar:$CLASSPATH
</screen>
<screen>(Windows)
C:\>set CLASSPATH=\\path\to\lib\gmbal-api-only-3.0.0-b023.jar:%CLASSPATH%
-C:\>set CLASSPATH=\\path\to\lib\grizzly-framework-2.1.2.jar:%CLASSPATH%
-C:\>set CLASSPATH=\\path\to\lib\i18n-core-1.2.0.jar:%CLASSPATH%
+C:\>set CLASSPATH=\\path\to\lib\grizzly-framework-2.1.7.jar:%CLASSPATH%
+C:\>set CLASSPATH=\\path\to\lib\i18n-core-1.4.0.jar:%CLASSPATH%
C:\>set CLASSPATH=\\path\to\lib\management-api-3.0.0-b012.jar:%CLASSPATH%
C:\>set CLASSPATH=\\path\to\lib\opendj-ldap-sdk-<?eval ${currentSDKversion}?>.jar:%CLASSPATH%</screen>
</step>
@@ -191,9 +191,9 @@
</step>
<step>
<para>Set your CLASSPATH to include the OpenDJ LDAP SDK library,
- <filename>opendj-ldap-sdk-<?eval ${currentSDKversion}?>.jar</filename>,
+ <filename>opendj-ldap-sdk-<?eval ${currentSDK4ersion}?>.jar</filename>,
the I18N core library, <filename>i18n-core-1.2.0.jar</filename>, the Grizzly
- framework, <filename>grizzly-framework-2.1.2.jar</filename>, and the
+ framework, <filename>grizzly-framework-2.1.7.jar</filename>, and the
GlassFish management APIs, <filename>gmbal-api-only-3.0.0-b023.jar</filename>
& <filename>management-api-3.0.0-b012.jar</filename>
under <filename>opendj-ldap-toolkit-<?eval ${currentSDKversion}?>/lib/</filename>.</para>
--
Gitblit v1.10.0