com.jcraft.jsch

Interface UserInfo

public interface UserInfo

Allows user interaction. The application can provide an implementation of this interface to the Session to allow for feedback to the user and retrieving information (e.g. passwords, passphrases or a confirmation) from the user.

If an object of this interface also implements UIKeyboardInteractive, it can also be used for keyboard-interactive authentication as described in RFC 4256.

Most of the examples include an implementation of this interface based on Swings JOptionPane.

See Also:

Session.setUserInfo(com.jcraft.jsch.UserInfo)

Method Summary

Modifier and Type	Method and Description
String	getPassphrase() Returns the passphrase entered by the user.
String	getPassword() Returns the password entered by the user.
boolean	promptPassphrase(String message) Prompts the user for a passphrase for a public key.
boolean	promptPassword(String message) Prompts the user for a password used for authentication for the remote server.
boolean	promptYesNo(String message) Prompts the user to answer a yes-no-question.
void	showMessage(String message) Shows an informational message to the user.

Method Detail

promptPassword

boolean promptPassword(String message)

Prompts the user for a password used for authentication for the remote server.

Parameters:

message - the prompt string to be shown to the user.

Returns:

true if the user entered a password. This password then can be retrieved by getPassword().

getPassword

String getPassword()

Returns the password entered by the user. This should be only called after a successful promptPassword(java.lang.String).

promptPassphrase

boolean promptPassphrase(String message)

Prompts the user for a passphrase for a public key.

Parameters:

message - the prompt message to be shown to the user.

Returns:

true if the user entered a passphrase. The passphrase then can be retrieved by getPassphrase().

getPassphrase

String getPassphrase()

Returns the passphrase entered by the user. This should be only called after a successful promptPassphrase(java.lang.String).

promptYesNo

boolean promptYesNo(String message)

Prompts the user to answer a yes-no-question.

Note: These are currently used to decide whether to create nonexisting files or directories, whether to replace an existing host key, and whether to connect despite a non-matching key.

Parameters:

message - the prompt message to be shown to the user.

Returns:

true if the user answered with "Yes", else false.

showMessage

void showMessage(String message)

Shows an informational message to the user.

Parameters:

message - the message to show to the user.