Interface UserPasswordCallback
- All Known Subinterfaces:
UserPasswordSSHCallback
,UserPasswordSSLCallback
public interface UserPasswordCallback
The interface for requesting authentication credentials from the user. Should the javahl bindings need the matching information, these methodes will be called.
This callback can also be used to provide the equivalent of the
--no-auth-cache
and --non-interactive
arguments accepted by the command-line client.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Accept the connection to the server forever.static final int
Accept the connection to the server once.static final int
Reject the connection to the server. -
Method Summary
Modifier and TypeMethodDescriptionjava.lang.String
askQuestion
(java.lang.String realm, java.lang.String question, boolean showAnswer) ask the user a question where she answers with a text.java.lang.String
askQuestion
(java.lang.String realm, java.lang.String question, boolean showAnswer, boolean maySave) Ask the user a question, and (usually) store the auth credential caching preference specified bymaySave
(used byuserAllowedSave()
).int
askTrustSSLServer
(java.lang.String info, boolean allowPermanently) If there are problems with the certifcate of the SSL-server, this callback will be used to deside if the connection will be used.boolean
askYesNo
(java.lang.String realm, java.lang.String question, boolean yesIsDefault) ask the user a yes/no questionjava.lang.String
retrieve the password entered during the prompt calljava.lang.String
retrieve the username entered during the prompt callboolean
prompt
(java.lang.String realm, java.lang.String username) Ask the user for username and password The entered username/password is retrieved by the getUsername getPasswort methods.boolean
prompt
(java.lang.String realm, java.lang.String username, boolean maySave) Request a user name and password from the user, and (usually) store the auth credential caching preference specified bymaySave
(used byuserAllowedSave()
).boolean
-
Field Details
-
Reject
static final int RejectReject the connection to the server.- See Also:
-
AcceptTemporary
static final int AcceptTemporaryAccept the connection to the server once.- See Also:
-
AcceptPermanently
static final int AcceptPermanentlyAccept the connection to the server forever.- See Also:
-
-
Method Details
-
askTrustSSLServer
int askTrustSSLServer(java.lang.String info, boolean allowPermanently) If there are problems with the certifcate of the SSL-server, this callback will be used to deside if the connection will be used.- Parameters:
info
- the probblems with the certificate.allowPermanently
- if AcceptPermantly is a legal answer- Returns:
- one of Reject/AcceptTemporary/AcceptPermanently
-
prompt
boolean prompt(java.lang.String realm, java.lang.String username) Ask the user for username and password The entered username/password is retrieved by the getUsername getPasswort methods.- Parameters:
realm
- for which server realm this information is requested.username
- the default username- Returns:
- Whether the prompt for authentication credentials was successful (e.g. in a GUI application whether the dialog box was canceled).
-
askYesNo
boolean askYesNo(java.lang.String realm, java.lang.String question, boolean yesIsDefault) ask the user a yes/no question- Parameters:
realm
- for which server realm this information is requested.question
- question to be askedyesIsDefault
- if yes should be the default- Returns:
- the answer
-
askQuestion
java.lang.String askQuestion(java.lang.String realm, java.lang.String question, boolean showAnswer) ask the user a question where she answers with a text.- Parameters:
realm
- for which server realm this information is requested.question
- question to be askedshowAnswer
- if the answer is shown or hidden- Returns:
- the entered text or null if canceled
-
getUsername
java.lang.String getUsername()retrieve the username entered during the prompt call- Returns:
- the username
-
getPassword
java.lang.String getPassword()retrieve the password entered during the prompt call- Returns:
- the password
-
prompt
boolean prompt(java.lang.String realm, java.lang.String username, boolean maySave) Request a user name and password from the user, and (usually) store the auth credential caching preference specified bymaySave
(used byuserAllowedSave()
). Applications wanting to emulate the behavior of--non-interactive
will implement this method in a manner which does not require user interaction (e.g. a no-op which assumes pre-cached auth credentials).- Parameters:
realm
- The realm from which the question originates.username
- The name of the user inrealm
.maySave
- Whether caching of credentials is allowed. Usually affects the return value of theuserAllowedSave()
method.- Returns:
- Whether the prompt for authentication credentials was successful (e.g. in a GUI application whether the dialog box was canceled).
-
askQuestion
java.lang.String askQuestion(java.lang.String realm, java.lang.String question, boolean showAnswer, boolean maySave) Ask the user a question, and (usually) store the auth credential caching preference specified bymaySave
(used byuserAllowedSave()
). Applications wanting to emulate the behavior of--non-interactive
will implement this method in a manner which does not require user interaction (e.g. a no-op).- Parameters:
realm
- The realm from which the question originates.question
- The text of the question.showAnswer
- Whether the answer may be displayed.maySave
- Whether caching of credentials is allowed. Usually affects the return value of theuserAllowedSave()
method.- Returns:
- answer as entered or null if canceled
-
userAllowedSave
boolean userAllowedSave()- Returns:
- Whether the caller allowed caching of credentials the
last time
prompt(String, String, boolean)
was called. Applications wanting to emulate the behavior of--no-auth-cache
will probably always returnfalse
.
-