Eclipse Plug-in Developer Guide (Galileo) - UserInfoPrompter (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jsch.ui
Class UserInfoPrompter


java.lang.Object
  
org.eclipse.jsch.ui.UserInfoPrompter

All Implemented Interfaces:: com.jcraft.jsch.UIKeyboardInteractive, com.jcraft.jsch.UserInfo

public class UserInfoPrompter
extends Object
implements com.jcraft.jsch.UserInfo, com.jcraft.jsch.UIKeyboardInteractive
extends Object
implements com.jcraft.jsch.UserInfo, com.jcraft.jsch.UIKeyboardInteractive

A UserInfo prompter implementation that can be used when connecting a Session.

Clients may instantiate or subclass this class.

Since:: 1.0
See Also:: IJSchService.createSession(String, int, String), IJSchService.connect(Session, int, org.eclipse.core.runtime.IProgressMonitor)

Constructor Summary

UserInfoPrompter (com.jcraft.jsch.Session session)
          Create a prompter for the given session.

Method Summary

String getPassphrase ()


String getPassword ()


com.jcraft.jsch.Session getSession ()
          Return the session to which this prompter is assigned.

String[] promptKeyboardInteractive ( String destination, String name, String instruction, String[] prompt, boolean[] echo)


boolean promptPassphrase ( String message)


boolean promptPassword ( String message)


boolean promptYesNo ( String question)


void setPassphrase ( String passphrase)
          Set the pass phrase to be used when connecting the session.

void setPassword ( String password)
          Set the password to be used when connecting the session.

void showMessage ( String message)


Methods inherited from class java.lang. Object

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

Constructor Detail

UserInfoPrompter

public UserInfoPrompter(com.jcraft.jsch.Session session)

Create a prompter for the given session. This constructor will associate this prompter with the session using Session.setUserInfo(UserInfo).

Parameters:: session - the session

Method Detail

getSession

public com.jcraft.jsch.Session getSession()

Return the session to which this prompter is assigned.

Returns:: the session to which this prompter is assigned

getPassphrase

public 
String getPassphrase()

Specified by:: getPassphrase in interface com.jcraft.jsch.UserInfo

getPassword

public 
String getPassword()

Specified by:: getPassword in interface com.jcraft.jsch.UserInfo

setPassphrase

public void setPassphrase(
String passphrase)

Set the pass phrase to be used when connecting the session. Return null if the pass phrase is not known.

Parameters:: passphrase - the pass phrase to be used when connecting the session or null

setPassword

public void setPassword(
String password)

Set the password to be used when connecting the session. Return null if the password is not known.

Parameters:: password - the password to be used when connecting the session or null

promptPassphrase

public boolean promptPassphrase(
String message)

Specified by:: promptPassphrase in interface com.jcraft.jsch.UserInfo

promptPassword

public boolean promptPassword(
String message)

Specified by:: promptPassword in interface com.jcraft.jsch.UserInfo

promptKeyboardInteractive

public 
String[] promptKeyboardInteractive(
String destination,
                                          
String name,
                                          
String instruction,
                                          
String[] prompt,
                                          boolean[] echo)

Specified by:: promptKeyboardInteractive in interface com.jcraft.jsch.UIKeyboardInteractive

promptYesNo

public boolean promptYesNo(
String question)

Specified by:: promptYesNo in interface com.jcraft.jsch.UserInfo

showMessage

public void showMessage(
String message)

Specified by:: showMessage in interface com.jcraft.jsch.UserInfo