Package org.opends.server.tools

Class EncodePassword

java.lang.Object
com.forgerock.opendj.cli.Tool
org.opends.server.tools.EncodePassword
All Implemented Interfaces:
Closeable, AutoCloseable
public final class EncodePassword extends com.forgerock.opendj.cli.Tool
This program provides a utility that may be used to interact with the password storage schemes defined in the Directory Server. In particular, it can encode a clear-text password using a specified scheme, and it can also determine whether a given encoded password is the encoded representation of a given clear-text password. Alternately, it can be used to obtain a list of the available password storage scheme names.

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.forgerock.opendj.cli.Tool

    com.forgerock.opendj.cli.Tool.Style

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    main(String[] args)
    Processes the command-line arguments and performs the requested action.
    static com.forgerock.opendj.cli.ReturnCode
    mainEncodePassword(String[] args, ServerContext serverContext, PrintStream out, PrintStream err)
    Processes the command-line arguments and performs the requested action.
    com.forgerock.opendj.cli.ReturnCode
    run(String... args)
    Run this Tool tool with the provided arguments.

    Methods inherited from class com.forgerock.opendj.cli.Tool

    askPort, close, confirmAction, enableConsoleLoggingIfVerbose, errPrintln, errPrintln, errPrintln, errPrintlnSurroundedByBlankLines, errPrintVerboseMessage, flush, flushLogStream, getErrorStream, getErrStream, getInputStream, getOutputStream, isFullyInteractive, isQuiet, isScriptFriendly, isVerbose, logVerboseMessage, mayPrompt, parseArguments, pressReturnToContinue, print, println, println, println, printlnNoWrap, printlnSurroundedByBlankLines, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readValidatedInput, readValidatedInputOrThrow, report

    Methods inherited from class java.lang.Object

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

  • Method Details

    • main

      public static void main(String[] args)
      Processes the command-line arguments and performs the requested action.
      Parameters:
      args - The command-line arguments provided to this program.

    • mainEncodePassword

      public static com.forgerock.opendj.cli.ReturnCode mainEncodePassword(String[] args, ServerContext serverContext, PrintStream out, PrintStream err)
      Processes the command-line arguments and performs the requested action.
      Parameters:
      args - The command-line arguments provided to this program.
      serverContext - The server context, or null if the tool should initialize the server context itself.
      out - The output stream to use for standard output, or null if standard output is not needed.
      err - The output stream to use for standard error, or null if standard error is not needed.
      Returns:
      An integer value that indicates whether processing was successful.

    • run

      public com.forgerock.opendj.cli.ReturnCode run(String... args) throws com.forgerock.opendj.cli.ClientException
      Description copied from class: com.forgerock.opendj.cli.Tool
      Run this Tool tool with the provided arguments. Output and errors will be written on the provided streams.

      This method can be used to run the tool programmatically.

      Overrides:
      run in class com.forgerock.opendj.cli.Tool
      Parameters:
      args - Arguments set to pass to the tool.
      Returns:
      0 if all processing completed successfully, or non-zero if an error occurred.
      Throws:
      com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.