Package 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
Fields Modifier and Type Field Description static int
USE_DEFAULT_PORT
port value which indicates to a connection method to use the default port
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getComment()
Return the commentString
getHost()
Returns the host where the repository is locatedString
getPassword()
Return the passwordIPasswordStore
getPasswordStore()
Return the password store.int
getPort()
Returns the port to connect to or USE_DEFAULT_PORT if the connection method is to use its default port.String
getUsername()
Return the user namevoid
setComment(String comment)
Sets the comment for this location.void
setPassword(String password)
Sets the user password used for this locationvoid
setPasswordStore(IPasswordStore store)
Sets the password store used for this locationvoid
setUsername(String username)
Sets the user information used for this location
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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
- Comment to be displayed in password prompt.
-
getComment
String getComment()
Return the comment- Returns:
- Comment to be displayed in password prompt.
-
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.
-
-