org.eclipse.jsch.core
Interface IJSchLocation
-
public interface IJSchLocation
This interface provides access to the specific portions of
the location string for use by ssh2 connection
and the user authenticator.
This interface is not intended to be implemented by clients.
-
Since:
- 1.1
-
See Also:
-
IUserAuthenticator
,
IPasswordStore
Field Summary
|
static int
|
USE_DEFAULT_PORT
port value which indicates to a connection method to use the default port |
USE_DEFAULT_PORT
static final int USE_DEFAULT_PORT
- port value which indicates to a connection method to use the default port
-
See Also:
-
Constant Field Values
getHost
String getHost()
- Returns the host where the repository is located
-
-
Returns:
- host name
getPort
int getPort()
- Returns the port to connect to or USE_DEFAULT_PORT if
the connection method is to use its default port.
-
-
Returns:
- port number
setUsername
void setUsername(
String username)
- Sets the user information used for this location
-
-
Parameters:
-
username
- user name
getUsername
String getUsername()
- Return the user name
-
-
Returns:
- user name
setPassword
void setPassword(
String password)
- Sets the user password used for this location
-
-
Parameters:
-
password
- password
getPassword
String getPassword()
- Return the password
-
-
Returns:
- password
setComment
void setComment(
String comment)
- Sets the comment for this location. This comment will be displayed
in prompting for the password.
-
-
Parameters:
-
comment
-
getComment
String getComment()
- Return the comment
-
-
Returns:
- comment
setPasswordStore
void setPasswordStore(
IPasswordStore store)
- Sets the password store used for this location
-
-
Parameters:
-
store
- password store
getPasswordStore
IPasswordStore getPasswordStore()
- Return the password store.
-
-
Returns:
- password store.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.