org.eclipse.ptp.remote.ui
Interface IRemoteUIConnectionManager

All Known Implementing Classes:

AbstractRemoteUIConnectionManager

public interface IRemoteUIConnectionManager

Interface for providing connection management operations in the UI. Clients can call these methods to open generic dialogs for operations on connections.

Field Summary

static String	CONNECTION_ADDRESS_HINT
static String	CONNECTION_PORT_HINT
static String	CONNECTION_TIMEOUT_HINT
static String	LOGIN_USERNAME_HINT

Method Summary

IRemoteConnection	newConnection(Shell shell) Create a new connection.
IRemoteConnection	newConnection(Shell shell, String[] attrHints, String[] attrHintValues) Create a new connection using the remote service provider new connection dialog.
void	openConnectionWithProgress(Shell shell, IRunnableContext context, IRemoteConnection connection) Attempt to open a connection using a progress monitor.
void	updateConnection(Shell shell, IRemoteConnection connection) Change a connection configuration.

Field Detail

CONNECTION_ADDRESS_HINT

static final String CONNECTION_ADDRESS_HINT

Since:

5.0

See Also:

Constant Field Values

CONNECTION_PORT_HINT

static final String CONNECTION_PORT_HINT

Since:

5.0

See Also:

Constant Field Values

CONNECTION_TIMEOUT_HINT

static final String CONNECTION_TIMEOUT_HINT

Since:

5.0

See Also:

Constant Field Values

LOGIN_USERNAME_HINT

static final String LOGIN_USERNAME_HINT

Since:

5.0

See Also:

Constant Field Values

Method Detail

newConnection

IRemoteConnection newConnection(Shell shell)

Create a new connection. The implementation can choose to do this in any way, but typically will use a dialog or wizard.

Parameters:

shell - shell used to display dialogs

Returns:

newly created remote connection or null if none created

newConnection

IRemoteConnection newConnection(Shell shell,
                                String[] attrHints,
                                String[] attrHintValues)

Create a new connection using the remote service provider new connection dialog. If attrHints and attrHintValues are provided then the dialog will attempt to use these values as the default values for the appropriate dialog fields.

Parameters:

shell - shell used to display dialog

attrHints - array containing attribute hints

attrHintValues - array containing default values for each attribute specified in attrHints

Returns:

the newly created connection or null if none created

Since:

5.0

openConnectionWithProgress

void openConnectionWithProgress(Shell shell,
                                IRunnableContext context,
                                IRemoteConnection connection)

Attempt to open a connection using a progress monitor. Can be called on either open or closed connections, and will initialize the remote services if necessary. Users should check connection.isOpen() on return to determine if the connection was actually opened.

Parameters:

shell - shell used to display dialogs

context - runnable context for displaying progress indicator. Can be null.

connection - connection to open

Since:

5.0

updateConnection

void updateConnection(Shell shell,
                      IRemoteConnection connection)

Change a connection configuration. The implementation can chose to do this in any way, but typically will use a dialog or wizard.

Parameters:

shell - shell used to display dialogs

connection - connection to modify