Class ConsolePasswordFinder

java.lang.Object
net.schmizz.sshj.userauth.password.ConsolePasswordFinder
All Implemented Interfaces:
PasswordFinder

public class ConsolePasswordFinder extends Object implements PasswordFinder
A PasswordFinder that reads a password from a console
  • Field Details

    • DEFAULT_FORMAT

      public static final String DEFAULT_FORMAT
      See Also:
    • console

      private final Console console
    • promptFormat

      private final String promptFormat
    • maxTries

      private final int maxTries
    • numTries

      private int numTries
  • Constructor Details

    • ConsolePasswordFinder

      public ConsolePasswordFinder()
    • ConsolePasswordFinder

      public ConsolePasswordFinder(Console console)
    • ConsolePasswordFinder

      public ConsolePasswordFinder(Console console, String promptFormat, int maxTries)
  • Method Details

    • reqPassword

      public char[] reqPassword(Resource<?> resource)
      Description copied from interface: PasswordFinder
      Request password for specified resource.

      This method may return null when the request cannot be serviced, e.g. when the user cancels a password prompt.

      Specified by:
      reqPassword in interface PasswordFinder
      Parameters:
      resource - the resource for which password is being requested
      Returns:
      the password or null
    • shouldRetry

      public boolean shouldRetry(Resource<?> resource)
      Description copied from interface: PasswordFinder
      If password turns out to be incorrect, indicates whether another call to PasswordFinder.reqPassword(Resource) should be made.

      This method is geared at interactive implementations, and stub implementations may simply return false.

      Specified by:
      shouldRetry in interface PasswordFinder
      Parameters:
      resource - the resource for which password is being requested
      Returns:
      whether to retry requesting password for a particular resource
    • checkFormatString

      private static void checkFormatString(String promptFormat)