30 Jul, 2015

1 commit


27 Jul, 2015

1 commit

  • This commit makes all tools consistent in the way that if no arguments are provided on the command line (or only the non prompt argument for interactive tools), tool prints the error and the help reference message on error stream.
    Changes details:
    * ArgumentParser
    ** Create method displayMessageAndUsageReference(), this method is used by tools to print both an error message and the help usage reference message
    ** getHelpUsageReference() has been moved from SubCommandArgumentParser
    
    * DSConfig
    ** displayErrorMessageAndUsageReference() has been moved to ArgumentParser
    
    * CreateRCScript
    ** Moves the server root path check after the argument parsing in order to have a consistent error message if arguments are invalid.
    
    * RebuildIndex
    * VerifyIndex
    ** Removed dead code which printed usage if no args were provided (if so, an argument exception is raised before).
    
    * MakeLDIF
    ** Add a main method for test purpose
    
    * ArgumentParserToolsTestCase
    ** Test that tools are consistent if an invalid argument is provided or if no args are provided.
    
    Tools modified by this commit are the following:
    Server tools
    * Does not print usage anymore
    ** backup
    ** base64 (only if no args are provided)
    ** control-panel
    ** create-rc-script
    ** dbtest
    ** dsjavaproperties
    ** dsreplication
    ** encode-password
    ** export-ldif
    ** import-ldif
    ** ldapcompare
    ** ldapdelete
    ** ldapmodify
    ** ldappasswordmodify
    ** ldapsearch
    ** ldif-diff
    ** ldifmodify
    ** ldifsearch
    ** make-ldif
    ** manage-account
    ** manage-tasks
    ** rebuild-index
    ** restore
    ** setup
    ** start-ds
    ** status
    ** stop-ds
    ** uninstall
    ** upgrade
    ** verify-index
    
    * Usage reference message added
    ** base64 (only if invalid args are provided)
    
    SDK tools
    * Does not print usage anymore
    ** addrate
    ** makeldif
    
    * Usage reference message added
    ** authrate
    ** ldapcompare
    ** ldapmodify
    ** ldappasswordmodify
    ** ldapsearch
    ** ldifdiff
    ** ldifmodify
    ** ldifsearch
    ** modrate
    ** searchrate
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12701 41b1ffd8-f28e-4786-ab96-9950f0a78031
    gaetan
     

20 Jul, 2015

1 commit

  • * Note that this migration just solved compilation issues, it does not try to take benefits from the apis enhancements.
    * The major change is that org.forgerock.opendj.ldap.ResultHandler has been renamed to org.forgerock.opendj.ldap.LdapResultHandler.java to prevent conflicts with the org.forgerock.util.promise.ResultHandler
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12687 41b1ffd8-f28e-4786-ab96-9950f0a78031
    gaetan
     

17 Jul, 2015

1 commit

  • Factorize code for tools message printing.
    * opendj-cli/src/main/java/com/forgerock/opendj/cli/Utils.java
    ** Introduce handly methods to print a message/string on a stream.
    * Other files uses the methods described above.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12684 41b1ffd8-f28e-4786-ab96-9950f0a78031
    gaetan
     

19 Jun, 2015

1 commit


08 Jun, 2015

1 commit


28 May, 2015

2 commits


26 May, 2015

1 commit


06 May, 2015

1 commit

  • Review: Matt (uppon the shoulder)
    This commit replaces Java 6 occurences by Java 7 in messages.
    It also performs the Java version check against Java 7.
    
    * org.opends.quicksetup.util.Utils.java
    ** Use opendj-cli check java version, this allow us to remove old check process based on CompatibleJava
    
    * Other changes are just messages or text update.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12208 41b1ffd8-f28e-4786-ab96-9950f0a78031
    gaetan
     

27 Apr, 2015

1 commit


20 Apr, 2015

1 commit

  • - Used java 7 diamond operator
    - Compressed javadocs to a single line
    - Added toString()
    - Extracted methods
    
    Argument.java:
    In getDoubleValues(), fixed copied/pasted error message.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12121 41b1ffd8-f28e-4786-ab96-9950f0a78031
    JnRouvignac
     

08 Apr, 2015

1 commit


07 Apr, 2015

1 commit


02 Apr, 2015

2 commits

  • Whitespace is not generally significant in doc sources
    except where markup specifies that it is
    such as within ProgramListing, Screen, and LiteralLayout elements.
    
    Some usage messages in the generated reference docs
    are formatted for use in terminal windows,
    with significant whitespace and newlines
    that get lost when pulled as is into the documentation source.
    
    This patch works around usage() message content
    that contains significant whitespace, specifically newlines.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12023 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     
  • * opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java
    ** Add backend type short and long optiion
    
    * opendj-core/src/main/java/org/forgerock/opendj/ldap/MemoryBackend.java
    ** Change code to allow root DSE sub-entriees
    
    * opendj-server-legacy/resource/config/config.ldif
    ** Remove harcoded userRoot backend ldif definition
    
    * opendj-server-legacy/src/main/java/org/opends/quicksetup/UserData.java
    ** Add backend type argument
    
    *  opendj-server-legacy/src/main/java/org/opends/quicksetup/installer/Installer.java
    ** Forward backend type argument to ConfigureDS
    
    * opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/BackendImpl.java
    ** Check if storage db directory exists before trying to remove all storage files
    
    * opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureDS.java
    ** Adapt the way to configure server base DNs
    
    * opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDS.java
    ** Add method to retrieve all available backend types from the config framework
    ** Adapt console UI to add the backend type choice
    
    * opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDSArgumentParser.java
    ** Add the backend type argument
    
    * opendj-server-legacy/src/messages/org/opends/messages/tool.properties
    ** Add messages related to console UI
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12022 41b1ffd8-f28e-4786-ab96-9950f0a78031
    gaetan
     

01 Apr, 2015

1 commit


31 Mar, 2015

1 commit

  • This patch splits the dsconfig man page into a dsconfig page
    that lists the subcommands, and a page per subcommand.
    
    In the Reference the subcommands pages are included
    in their own reference section,
    because there's no good way to present the whole list
    in the midst of the tools reference.
    
    As a side effect this patch makes it possible to build PDF again
    (and to build man pages) without running out of memory.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@12011 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     

24 Mar, 2015

1 commit

  • *****  opendj-cli *****
    * ArgumentConstants.java
    ** Add constant for testonly long option
    
    * CommonArguments.java
    ** Removes getTestOnly(...) static method as it is only used in InstallDS.
    
    * cli.properties
    ** Removes INFO_ARGUMENT_DESCRIPTION_TESTONLY message and migrate it to server tool.properties to have consistant import in InstallDS.java
    
    ***** opendj-ldap-toolkit *****
    * resources/.../_script_util.bat
    ** Replace short option call by long option call
    
    ***** opendj-server-legacy *****
    * resources/.../bin/_script-util.sh _script-util.bat
    ** Replace short option call by long option call
    
    * InstallDSArgumentParser.java
    ** Inline static call to CommonArguments
    
    * tools.properties
    ** Add testonly argument information message
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11968 41b1ffd8-f28e-4786-ab96-9950f0a78031
    gaetan
     

17 Mar, 2015

1 commit

  • Implement plugin for generating RefEntry source files
    
    This patch adds a Mojo for generating DocBook XML RefEntry sources.
    
    The tools to document must be on the project class path.
    
    Apply fixes suggested by Jean-Noël in CR-6372
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11933 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     

11 Mar, 2015

1 commit

  • This first patch makes it possible to get a full refentry when running 
    OPENDJ_JAVA_ARGS="-Dorg.forgerock.opendj.gendoc=true" <command> -?
    with any command.
    
    This is a subtask of the following issue:
    OPENDJ-386 Move to single reference document
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11890 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     

26 Feb, 2015

1 commit


25 Feb, 2015

1 commit


20 Feb, 2015

1 commit


19 Feb, 2015

4 commits


18 Feb, 2015

1 commit

  • This patch moves to FreeMarker templates to lay out generated content.
    It also moves English strings to properties files.
    
    It would no doubt be possible to reduce the number of templates for dsconfig
    by appending to the FreeMarker model instead of appending strings.
    
    This patch is part of the work for
    OPENDJ-386 Single reference document, especially for dsconfig.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11788 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     

13 Feb, 2015

1 commit

  • This patch is like r11722, but for the LDAP SDK tools.
    
    This patch does not resolve the fact that duplicate tools exist.
    I have, however, logged OPENDJ-1810 regarding that point.
    Duplication should disappear in the move to a single set of tools.
    
    This is a subtask of the following issue:
    OPENDJ-386 Move to single reference document
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11735 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     

12 Feb, 2015

1 commit

  • This patch adds supplemental documentation
    for what is already part of the hand-written reference
    to the generated reference content.
    For example, descriptions that are longer in the hand-written reference
    than in the generated reference content
    are now included in the generated reference content.
    
    This patch does not, however, add additional reference sections
    that are not currently part of generated content,
    such as EXIT CODES, EXAMPLES, SEE ALSO, etc.
    
    This is a subtask of the following issue:
    OPENDJ-386 Move to single reference document
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11722 41b1ffd8-f28e-4786-ab96-9950f0a78031
    mark
     

10 Feb, 2015

1 commit


06 Feb, 2015

1 commit


05 Feb, 2015

1 commit

  • …ough subcommand options
    
    Further improvements after CR-5982.
    
    DSConfig.java:
    In appendUsage(), excluded HelpSubCommandHandler + found a better API to access the correct data (previous data were incorrect).
    
    SubCommandArgumentParser.java:
    Do not unnecessarily create StringBuilders appended to other StringBuilders.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11679 41b1ffd8-f28e-4786-ab96-9950f0a78031
    JnRouvignac
     

03 Feb, 2015

4 commits

  • SubCommandArgumentParser.java:
    After r11664, getUsage(Argument) should call setUsageOrVersionDisplayed() itself.
    
    ManageAccountTestCase.java:
    Extracted method manageAccountMain(), the change to SubCommandArgumentParser will fix the tests.
    
    DsconfigOptionsTestCase.java:
    For testGenerateDoc() failure, calling DSConfig with "-?" option and "org.forgerock.opendj.gendoc" property set now returns SUCCESS while it was not before. This is due to r11664 which stops dsconfig execution after generating the documentation. This test assertion did not make sense to me.
    
    *.java:
    Code cleanup
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11672 41b1ffd8-f28e-4786-ab96-9950f0a78031
    JnRouvignac
     
  • This is a problem since switching to using the opendj-cli argument classes.
    This happens because the opendj-cli tools check the new "com.forgerock.opendj.ldap.tools.scriptName" property instead of the opends property "org.opends.server.scriptName" that is still set by the server tools.
    Fixed by also checking the legacy opends property.
    Factorized the code from ArgumentParser, SubCommandArgumentParser and DSConfig.
    
    
    ArgumentParser.java:
    Added constant PROPERTY_SCRIPT_NAME_LEGACY.
    Extracted methods getScriptNameOrJava(), getLocalizableScriptName() and getScriptName().
    
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11668 41b1ffd8-f28e-4786-ab96-9950f0a78031
    JnRouvignac
     
  • …ough subcommand options
    
    Left code generating the reference documentation in opendj-cli SubCommandArgumentParser, so it can be reused with other tools using SubCommandArgumentParser.
    Created SubCommandUsageHandler interface to allow outputing additional documentation + implemented it in opendj-config DSConfig, this way the code can access all the config classes and generate the reference documentation inline with the command usage.
    
    
    SubCommandArgumentParser.java:
    Added subCommandUsageHandler field + setter.
    In toRefSect2(), used subCommandUsageHandler to output additional documentation.
    
    DSConfig.java:
    Created inner class DSConfigSubCommandUsageHandler + copied code from ConfigGuideGeneration to here.
    
    git-svn-id: https://svn.forgerock.org/opendj/trunk@11666 41b1ffd8-f28e-4786-ab96-9950f0a78031
    JnRouvignac
     
  • git-svn-id: https://svn.forgerock.org/opendj/trunk@11665 41b1ffd8-f28e-4786-ab96-9950f0a78031
    JnRouvignac
     

30 Jan, 2015

1 commit


28 Jan, 2015

1 commit