blob: 1b60765d33f34353433a1087ff30046d7b3d5528 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2007 JCraft,Inc. and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Atsuhiko Yamanaka, JCraft,Inc. - initial API and implementation
*******************************************************************************/
package org.eclipse.jsch.core;
import org.eclipse.jsch.internal.core.IUserAuthenticator;
/**
* 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.
* @see IUserAuthenticator
* @see IPasswordStore
* @since 1.1
*/
public interface IJSchLocation{
/**
* port value which indicates to a connection method to use the default port
*/
public static int USE_DEFAULT_PORT=0;
/**
* Returns the host where the repository is located
* @return host name
*/
public String getHost();
/**
* Returns the port to connect to or USE_DEFAULT_PORT if
* the connection method is to use its default port.
* @return port number
*/
public int getPort();
/**
* Sets the user information used for this location
* @param username user name
*/
public void setUsername(String username);
/**
* Return the user name
* @return user name
*/
public String getUsername();
/**
* Sets the user password used for this location
* @param password password
*/
public void setPassword(String password);
/**
* Return the password
* @return password
*/
public String getPassword();
/**
* Sets the comment for this location. This comment will be displayed
* in prompting for the password.
* @param comment
*/
public void setComment(String comment);
/**
* Return the comment
* @return comment
*/
public String getComment();
/**
* Sets the password store used for this location
* @param store password store
*/
public void setPasswordStore(IPasswordStore store);
/**
* Return the password store.
* @return password store.
*/
public IPasswordStore getPasswordStore();
}
|