org.eclipse.ptp.remote.core

Interface IRemoteConnectionManager

public interface IRemoteConnectionManager

Interface for managing connections to remote systems.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCAL_CONNECTION_NAME The name of the connection for local services.

Method Summary

Methods

Modifier and Type	Method and Description
IRemoteConnection	getConnection(String name) Gets the remote connection corresponding to the supplied name.
IRemoteConnection	getConnection(URI uri) Gets the remote connection corresponding to the supplied URI.
IRemoteConnection[]	getConnections() Get all the connections for this service provider.
IRemoteConnection	newConnection(String name) Creates a new remote connection named with supplied name.
void	removeConnection(IRemoteConnection connection) Remove a connection and all resources associated with it.

Field Detail

LOCAL_CONNECTION_NAME

static final String LOCAL_CONNECTION_NAME

The name of the connection for local services. There is only one connection for local services.

Since:

7.0

See Also:

Constant Field Values

Method Detail

getConnection

IRemoteConnection getConnection(String name)

Gets the remote connection corresponding to the supplied name.

Parameters:

name - name of the connection (as returned by IRemoteConnection.getName())

Returns:

remote connection or null if no connection exists

getConnection

IRemoteConnection getConnection(URI uri)

Gets the remote connection corresponding to the supplied URI.

Parameters:

uri - URI containing a schema for this remote connection

Returns:

remote connection or null if no connection exists or the schema is incorrect

Since:

4.0

getConnections

IRemoteConnection[] getConnections()

Get all the connections for this service provider.

Returns:

connections that we know about

newConnection

IRemoteConnection newConnection(String name)
                                throws RemoteConnectionException

Creates a new remote connection named with supplied name. The connection attributes will be the default for the implementation.

Parameters:

name - name of the connection

Returns:

a new connection with the supplied name

Throws:

RemoteConnectionException - if connection creation failed

Since:

5.0

removeConnection

void removeConnection(IRemoteConnection connection)
                      throws RemoteConnectionException

Remove a connection and all resources associated with it.

Parameters:

connection - connection to remove

Throws:

RemoteConnectionException - if the connection could not be removed