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
|
/*******************************************************************************
* Copyright (c) 2000, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Atsuhiko Yamanaka, JCraft,Inc. - adding promptForKeyboradInteractive method
* - copying this class from cvs.core plug-in.
*******************************************************************************/
package org.eclipse.jsch.internal.core;
import org.eclipse.jsch.core.IJSchLocation;
/**
* IUserAuthenticators are used to ensure that the user
* is validated for ssh2 access to the remote.
* @since 1.1
*/
public interface IUserAuthenticator{
/**
* Button id for an "Ok" button (value 0).
*/
public int OK_ID=0;
/**
* Button id for a "Cancel" button (value 1).
*/
public int CANCEL_ID=1;
/**
* Button id for a "Yes" button (value 2).
*/
public int YES_ID=2;
/**
* Button id for a "No" button (value 3).
*/
public int NO_ID=3;
/**
* Constant for a prompt with no type (value 0).
*/
public final static int NONE=0;
/**
* Constant for an error prompt (value 1).
*/
public final static int ERROR=1;
/**
* Constant for an information prompt (value 2).
*/
public final static int INFORMATION=2;
/**
* Constant for a question prompt (value 3).
*/
public final static int QUESTION=3;
/**
* Constant for a warning dialog (value 4).
*/
public final static int WARNING=4;
/**
* Authenticates the user for access to a given repository.
* The obtained values for user name and password will be placed
* into the supplied user info object. Implementors are allowed to
* save user names and passwords. The user should be prompted for
* user name and password if there is no saved one, or if <code>retry</code>
* is <code>true</code>.
*
* @param location The repository location to authenticate the user for or <code>null</code>
* if this authentication is not for a CVS repository location.
* @param userInfo The object to place user validation information into.
* @param message An optional message to display if, e.g., previous authentication failed.
*/
public void promptForUserInfo(IJSchLocation location,
IUserInfo userInfo, String message);
/**
* Prompts the user for a number values using text fields. The labels are provided in
* the <core>prompt</code> array. Implementors will return the entered values, or null if
* the user cancel the prompt.
*
* @param location The repository location to authenticate the user for or <code>null</code>
* if this authentication is not for a CVS repository location.
* @param destination The destination in the format like username@hostname:port
* @param name A name about this dialog.
* @param instruction A message for the instruction.
* @param prompt Labels for text fields.
* @param echo the array to show which fields are secret.
* @return the entered values, or null if the user canceled.
*/
public String[] promptForKeyboradInteractive(IJSchLocation location,
String destination, String name, String instruction, String[] prompt,
boolean[] echo);
/**
* Prompts the authenticator for additional information regarding this authentication
* request. A default implementation of this method should return the <code>defaultResponse</code>,
* whereas alternate implementations could prompt the user with a dialog.
*
* @param location the repository location for this authentication or <code>null</code>
* if this authentication is not for a CVS repository location.
* @param promptType one of the following values:
* <ul>
* <li> <code>NONE</code> for a unspecified prompt type </li>
* <li> <code>ERROR</code> for an error prompt </li>
* <li> <code>INFORMATION</code> for an information prompt </li>
* <li> <code>QUESTION </code> for a question prompt </li>
* <li> <code>WARNING</code> for a warning prompt </li>
* </ul>
* @param title the prompt title that could be displayed to the user
* @param message the prompt
* @param promptResponses the possible responses to the prompt
* @param defaultResponseIndex the default response to the prompt
* @return the response to the prompt
*/
public int prompt(IJSchLocation location, int promptType,
String title, String message, int[] promptResponses,
int defaultResponseIndex);
/**
* The host key for the given location has changed.
* @param location
* @return true if new host key should be accepted
*/
public boolean promptForHostKeyChange(IJSchLocation location);
}
|
