com.jcraft.jsch.UserInfo Interface Reference
Allows user interaction. More...
Public Member Functions | |
| String | getPassword () |
| Returns the password entered by the user. | |
| boolean | promptPassphrase (String message) |
| Prompts the user for a passphrase for a public key. | |
| String | getPassphrase () |
| Returns the passphrase entered by the user. | |
Package Functions | |
| boolean | promptPassword (String message) |
| Prompts the user for a password used for authentication for the remote server. | |
Detailed Description
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 javax.swing.JOptionPane.
- See also:
- Session.setUserInfo
Definition at line 51 of file UserInfo.java.
Member Function Documentation
| String com.jcraft.jsch.UserInfo.getPassphrase | ( | ) |
Returns the passphrase entered by the user.
This should be only called after a successful promptPassphrase.
Implemented in edu.rice.cs.hpc.remote.tunnel.PortForwarding.MyUserInfo, and edu.rice.cs.hpc.remote.tunnel.RemoteUserInfo.
Referenced by com.jcraft.jsch.UserAuthPublicKey.start(), and com.jcraft.jsch.ChannelAgentForwarding.write().
| String com.jcraft.jsch.UserInfo.getPassword | ( | ) |
Returns the password entered by the user.
This should be only called after a successful promptPassword.
Implemented in edu.rice.cs.hpc.remote.tunnel.PortForwarding.MyUserInfo, and edu.rice.cs.hpc.remote.tunnel.RemoteUserInfo.
Referenced by com.jcraft.jsch.UserAuthPassword.start().
| boolean com.jcraft.jsch.UserInfo.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.
Implemented in edu.rice.cs.hpc.remote.tunnel.PortForwarding.MyUserInfo, and edu.rice.cs.hpc.remote.tunnel.RemoteUserInfo.
Referenced by com.jcraft.jsch.UserAuthPublicKey.start(), and com.jcraft.jsch.ChannelAgentForwarding.write().
| boolean com.jcraft.jsch.UserInfo.promptPassword | ( | String | message | ) | [package] |
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.
Implemented in edu.rice.cs.hpc.remote.tunnel.PortForwarding.MyUserInfo, and edu.rice.cs.hpc.remote.tunnel.RemoteUserInfo.
Referenced by com.jcraft.jsch.UserAuthPassword.start().
The documentation for this interface was generated from the following file:
- edu.rice.cs.hpc.remote/external/com/jcraft/jsch/UserInfo.java
