1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/**
* @copyright
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
* @endcopyright
*/
package org.apache.subversion.javahl.callback;
/**
* <p>The interface for requesting authentication credentials from the
* user. Should the javahl bindings need the matching information,
* these methodes will be called.</p>
*
* <p>This callback can also be used to provide the equivalent of the
* <code>--no-auth-cache</code> and <code>--non-interactive</code>
* arguments accepted by the command-line client.</p>
*
* @deprecated Use {@see AuthnCallback}.
*/
@Deprecated
public interface UserPasswordCallback
{
/**
* Reject the connection to the server.
*/
public static final int Reject = 0;
/**
* Accept the connection to the server <i>once</i>.
*/
public static final int AcceptTemporary = 1;
/**
* Accept the connection to the server <i>forever</i>.
*/
public static final int AcceptPermanently = 2;
/**
* If there are problems with the certifcate of the SSL-server, this
* callback will be used to deside if the connection will be used.
* @param info the probblems with the certificate.
* @param allowPermanently if AcceptPermantly is a legal answer
* @return one of Reject/AcceptTemporary/AcceptPermanently
*/
public int askTrustSSLServer(String info, boolean allowPermanently);
/**
* Ask the user for username and password
* The entered username/password is retrieved by the getUsername
* getPasswort methods.
*
* @param realm for which server realm this information is requested.
* @param username the default username
* @return Whether the prompt for authentication credentials was
* successful (e.g. in a GUI application whether the dialog box
* was canceled).
*/
public boolean prompt(String realm, String username);
/**
* ask the user a yes/no question
* @param realm for which server realm this information is
* requested.
* @param question question to be asked
* @param yesIsDefault if yes should be the default
* @return the answer
*/
public boolean askYesNo(String realm, String question,
boolean yesIsDefault);
/**
* ask the user a question where she answers with a text.
* @param realm for which server realm this information is
* requested.
* @param question question to be asked
* @param showAnswer if the answer is shown or hidden
* @return the entered text or null if canceled
*/
public String askQuestion(String realm, String question,
boolean showAnswer);
/**
* retrieve the username entered during the prompt call
* @return the username
*/
public String getUsername();
/**
* retrieve the password entered during the prompt call
* @return the password
*/
public String getPassword();
/**
* Request a user name and password from the user, and (usually)
* store the auth credential caching preference specified by
* <code>maySave</code> (used by {@link #userAllowedSave()}).
* Applications wanting to emulate the behavior of
* <code>--non-interactive</code> will implement this method in a
* manner which does not require user interaction (e.g. a no-op
* which assumes pre-cached auth credentials).
*
* @param realm The realm from which the question originates.
* @param username The name of the user in <code>realm</code>.
* @param maySave Whether caching of credentials is allowed.
* Usually affects the return value of the {@link
* #userAllowedSave()} method.
* @return Whether the prompt for authentication credentials was
* successful (e.g. in a GUI application whether the dialog box
* was canceled).
*/
public boolean prompt(String realm, String username, boolean maySave);
/**
* Ask the user a question, and (usually) store the auth
* credential caching preference specified by <code>maySave</code>
* (used by {@link #userAllowedSave()}). Applications wanting to
* emulate the behavior of <code>--non-interactive</code> will
* implement this method in a manner which does not require user
* interaction (e.g. a no-op).
*
* @param realm The realm from which the question originates.
* @param question The text of the question.
* @param showAnswer Whether the answer may be displayed.
* @param maySave Whether caching of credentials is allowed.
* Usually affects the return value of the {@link
* #userAllowedSave()} method.
* @return answer as entered or null if canceled
*/
public String askQuestion(String realm, String question,
boolean showAnswer, boolean maySave);
/**
* @return Whether the caller allowed caching of credentials the
* last time {@link #prompt(String, String, boolean)} was called.
* Applications wanting to emulate the behavior of
* <code>--no-auth-cache</code> will probably always return
* <code>false</code>.
*/
public boolean userAllowedSave();
}
|
