org.eclipse.remote.internal.jsch.ui

Class JSchUserAuthenticator

java.lang.Object

org.eclipse.remote.internal.jsch.ui.JSchUserAuthenticator

All Implemented Interfaces:

IRemoteConnection.Service, IUserAuthenticatorService

public class JSchUserAuthenticator
extends java.lang.Object
implements IUserAuthenticatorService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSchUserAuthenticator.Factory

Field Summary

Fields inherited from interface org.eclipse.remote.core.IUserAuthenticatorService

CANCEL, ERROR, INFORMATION, NO, NONE, OK, QUESTION, WARNING, YES

Constructor Summary

Constructors

Constructor and Description
JSchUserAuthenticator(IRemoteConnection conn)

Method Summary

Modifier and Type	Method and Description
IRemoteConnection	getRemoteConnection()
int	prompt(int promptType, java.lang.String title, java.lang.String message, int[] promptResponses, int defaultResponseIndex) Prompts for additional information regarding this authentication request.
java.net.PasswordAuthentication	prompt(java.lang.String username, java.lang.String message) Authenticates the user for access.
java.lang.String[]	prompt(java.lang.String destination, java.lang.String name, java.lang.String message, java.lang.String[] prompt, boolean[] echo) Prompts the user for a number values using text fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSchUserAuthenticator

public JSchUserAuthenticator(IRemoteConnection conn)

Method Detail

getRemoteConnection

public IRemoteConnection getRemoteConnection()

Specified by:

getRemoteConnection in interface IRemoteConnection.Service

prompt

public java.net.PasswordAuthentication prompt(java.lang.String username,
                                              java.lang.String message)

Description copied from interface: IUserAuthenticatorService

Authenticates the user for access. The obtained values for user name and password will be placed into returned 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.

Specified by:

prompt in interface IUserAuthenticatorService

Parameters:

username - The initial username, or null if there is no initial username

message - An optional message to display if, e.g., previous authentication failed.

prompt

public java.lang.String[] prompt(java.lang.String destination,
                                 java.lang.String name,
                                 java.lang.String message,
                                 java.lang.String[] prompt,
                                 boolean[] echo)

Description copied from interface: IUserAuthenticatorService

Prompts the user for a number values using text fields. The labels are provided in the prompt array. Implementors will return the entered values, or null if the user cancels the prompt.

Specified by:

prompt in interface IUserAuthenticatorService

Parameters:

destination - the destination in the format like username@hostname:port

name - a name for this dialog

message - the message to be displayed to the user

prompt - labels for each of the text fields.

echo - an array to show which fields are secret

Returns:

the entered values, or null if the user canceled.

prompt

public int prompt(int promptType,
                  java.lang.String title,
                  java.lang.String message,
                  int[] promptResponses,
                  int defaultResponseIndex)

Description copied from interface: IUserAuthenticatorService

Prompts for additional information regarding this authentication request. A default implementation of this method should return the defaultResponse, whereas alternate implementations could prompt the user with a dialog.

Specified by:

prompt in interface IUserAuthenticatorService

Parameters:

promptType - one of the following values:

• NONE for a unspecified prompt type
• ERROR for an error prompt
• INFORMATION for an information prompt
• QUESTION for a question prompt
• WARNING for a warning prompt

title - the prompt title that could be displayed to the user

message - the message to display to the user

promptResponses - the possible responses to the prompt (e.g. corresponding to buttons on a dialog)

defaultResponseIndex - the default response to the prompt

Returns:

the response to the prompt