public interface IRemoteConnection
Modifier and Type | Interface and Description |
---|---|
static interface |
IRemoteConnection.Service
The interface that is extend by services provided for this remote connection.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FILE_SEPARATOR_PROPERTY |
static java.lang.String |
LINE_SEPARATOR_PROPERTY |
static java.lang.String |
LOCALE_CHARMAP_PROPERTY |
static java.lang.String |
OS_ARCH_PROPERTY |
static java.lang.String |
OS_NAME_PROPERTY |
static java.lang.String |
OS_VERSION_PROPERTY |
static java.lang.String |
PATH_SEPARATOR_PROPERTY |
static java.lang.String |
USER_HOME_PROPERTY |
Modifier and Type | Method and Description |
---|---|
void |
addConnectionChangeListener(IRemoteConnectionChangeListener listener)
Register a listener that will be notified when this connection's status changes.
|
void |
close()
Close the connection.
|
void |
fireConnectionChangeEvent(int type)
Notify all listeners when this connection's status changes.
|
java.lang.String |
getAttribute(java.lang.String key)
Get an attribute for a connection.
|
IRemoteConnectionType |
getConnectionType()
Get the connection type of this connection
|
java.lang.String |
getName()
Get unique name for this connection.
|
java.lang.String |
getProperty(java.lang.String key)
Gets the remote system property indicated by the specified key.
|
java.lang.String |
getSecureAttribute(java.lang.String key)
Get an attribute that is stored in secure storage, such as passwords.
|
<T extends IRemoteConnection.Service> |
getService(java.lang.Class<T> service)
Get the service for this remote connection that implements the given interface.
|
IRemoteConnectionWorkingCopy |
getWorkingCopy()
Return a working copy to allow setting and changing of attributes.
|
<T extends IRemoteConnection.Service> |
hasService(java.lang.Class<T> service)
Does this connection support the given service.
|
boolean |
isOpen()
Test if the connection is open.
|
void |
open(org.eclipse.core.runtime.IProgressMonitor monitor)
Open the connection.
|
void |
removeConnectionChangeListener(IRemoteConnectionChangeListener listener)
Remove a listener that will be notified when this connection's status changes.
|
static final java.lang.String OS_NAME_PROPERTY
static final java.lang.String OS_VERSION_PROPERTY
static final java.lang.String OS_ARCH_PROPERTY
static final java.lang.String FILE_SEPARATOR_PROPERTY
static final java.lang.String PATH_SEPARATOR_PROPERTY
static final java.lang.String LINE_SEPARATOR_PROPERTY
static final java.lang.String USER_HOME_PROPERTY
static final java.lang.String LOCALE_CHARMAP_PROPERTY
IRemoteConnectionType getConnectionType()
java.lang.String getName()
<T extends IRemoteConnection.Service> T getService(java.lang.Class<T> service)
service
- the interface the required service must implementsorg.eclipse.core.runtime.CoreException
<T extends IRemoteConnection.Service> boolean hasService(java.lang.Class<T> service)
service
- The service to be testedvoid open(org.eclipse.core.runtime.IProgressMonitor monitor) throws RemoteConnectionException
monitor
- the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done()
on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot
be cancelled.RemoteConnectionException
void close()
boolean isOpen()
java.lang.String getProperty(java.lang.String key)
key
- the name of the propertyjava.lang.String getAttribute(java.lang.String key)
key
- java.lang.String getSecureAttribute(java.lang.String key)
key
- IRemoteConnectionWorkingCopy getWorkingCopy()
void addConnectionChangeListener(IRemoteConnectionChangeListener listener)
listener
- void removeConnectionChangeListener(IRemoteConnectionChangeListener listener)
listener
- void fireConnectionChangeEvent(int type)
RemoteConnectionChangeEvent
for a list of event
types.event
- event type indicating the nature of the event