org.eclipse.remote.internal.core

Class RemoteConnectionWorkingCopy

java.lang.Object

org.eclipse.remote.internal.core.RemoteConnectionWorkingCopy

All Implemented Interfaces:

IRemoteConnection, IRemoteConnectionWorkingCopy

public class RemoteConnectionWorkingCopy
extends java.lang.Object
implements IRemoteConnectionWorkingCopy

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.remote.core.IRemoteConnection

IRemoteConnection.Service

Field Summary

Fields inherited from interface org.eclipse.remote.core.IRemoteConnection

FILE_SEPARATOR_PROPERTY, LINE_SEPARATOR_PROPERTY, LOCALE_CHARMAP_PROPERTY, OS_ARCH_PROPERTY, OS_NAME_PROPERTY, OS_VERSION_PROPERTY, PATH_SEPARATOR_PROPERTY, USER_HOME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
RemoteConnectionWorkingCopy(RemoteConnection original) Edit Connection
RemoteConnectionWorkingCopy(RemoteConnectionType connectionType, java.lang.String name) New Connection.

Method Summary

Methods

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.
IRemoteConnection	getOriginal() Returns the original connection this working copy was created from.
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> T	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> boolean	hasService(java.lang.Class<T> service) Does this connection support the given service.
boolean	isDirty() Returns whether this connection has been modified since it was last saved or created.
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.
IRemoteConnection	save() Saves this working copy to its original connection and returns a handle to the resulting connection.
void	setAttribute(java.lang.String key, java.lang.String value) Set an implementation dependent attribute for the connection.
void	setName(java.lang.String name) Set the name for this connection
void	setSecureAttribute(java.lang.String key, java.lang.String value) Set an attribute such as a password that's stored in secure storage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteConnectionWorkingCopy

public RemoteConnectionWorkingCopy(RemoteConnectionType connectionType,
                           java.lang.String name)

New Connection.

RemoteConnectionWorkingCopy

public RemoteConnectionWorkingCopy(RemoteConnection original)

Edit Connection

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IRemoteConnection

Get unique name for this connection.

Specified by:

getName in interface IRemoteConnection

Returns:

connection name

setName

public void setName(java.lang.String name)

Description copied from interface: IRemoteConnectionWorkingCopy

Set the name for this connection

Specified by:

setName in interface IRemoteConnectionWorkingCopy

getAttribute

public java.lang.String getAttribute(java.lang.String key)

Description copied from interface: IRemoteConnection

Get an attribute for a connection. NOTE: the attributes do not include any security related information (e.g. passwords, keys, etc.)

Specified by:

getAttribute in interface IRemoteConnection

Returns:

the attribute value, or empty string if not defined.

setAttribute

public void setAttribute(java.lang.String key,
                java.lang.String value)

Description copied from interface: IRemoteConnectionWorkingCopy

Set an implementation dependent attribute for the connection. Attributes keys supported by the connection can be obtained using #getAttributes(). Attributes are persisted along with connection information.

Specified by:

setAttribute in interface IRemoteConnectionWorkingCopy

Parameters:

key - attribute key

value - attribute value

getSecureAttribute

public java.lang.String getSecureAttribute(java.lang.String key)

Description copied from interface: IRemoteConnection

Get an attribute that is stored in secure storage, such as passwords.

Specified by:

getSecureAttribute in interface IRemoteConnection

Returns:

the attribute value, or empty string if not defined.

setSecureAttribute

public void setSecureAttribute(java.lang.String key,
                      java.lang.String value)

Description copied from interface: IRemoteConnectionWorkingCopy

Set an attribute such as a password that's stored in secure storage.

Specified by:

setSecureAttribute in interface IRemoteConnectionWorkingCopy

addConnectionChangeListener

public void addConnectionChangeListener(IRemoteConnectionChangeListener listener)

Description copied from interface: IRemoteConnection

Register a listener that will be notified when this connection's status changes.

Specified by:

addConnectionChangeListener in interface IRemoteConnection

removeConnectionChangeListener

public void removeConnectionChangeListener(IRemoteConnectionChangeListener listener)

Description copied from interface: IRemoteConnection

Remove a listener that will be notified when this connection's status changes.

Specified by:

removeConnectionChangeListener in interface IRemoteConnection

fireConnectionChangeEvent

public void fireConnectionChangeEvent(int type)

Description copied from interface: IRemoteConnection

Notify all listeners when this connection's status changes. See {RemoteConnectionChangeEvent for a list of event types.

Specified by:

fireConnectionChangeEvent in interface IRemoteConnection

getConnectionType

public IRemoteConnectionType getConnectionType()

Description copied from interface: IRemoteConnection

Get the connection type of this connection

Specified by:

getConnectionType in interface IRemoteConnection

Returns:

connection type

getWorkingCopy

public IRemoteConnectionWorkingCopy getWorkingCopy()

Description copied from interface: IRemoteConnection

Return a working copy to allow setting and changing of attributes.

Specified by:

getWorkingCopy in interface IRemoteConnection

Returns:

working copy of remote

getService

public <T extends IRemoteConnection.Service> T getService(java.lang.Class<T> service)

Description copied from interface: IRemoteConnection

Get the service for this remote connection that implements the given interface.

Specified by:

getService in interface IRemoteConnection

Parameters:

service - the interface the required service must implements

Returns:

the desired service or null if there is no such service available

hasService

public <T extends IRemoteConnection.Service> boolean hasService(java.lang.Class<T> service)

Description copied from interface: IRemoteConnection

Does this connection support the given service.

Specified by:

hasService in interface IRemoteConnection

Parameters:

service - The service to be tested

Returns:

true if this connection supports the service

getOriginal

public IRemoteConnection getOriginal()

Description copied from interface: IRemoteConnectionWorkingCopy

Returns the original connection this working copy was created from. Returns null if this is a new connection.

Specified by:

getOriginal in interface IRemoteConnectionWorkingCopy

Returns:

original connection

isDirty

public boolean isDirty()

Description copied from interface: IRemoteConnectionWorkingCopy

Returns whether this connection has been modified since it was last saved or created.

Specified by:

isDirty in interface IRemoteConnectionWorkingCopy

Returns:

true if the connection has been modified

save

public IRemoteConnection save()
                       throws RemoteConnectionException

Description copied from interface: IRemoteConnectionWorkingCopy

Saves this working copy to its original connection and returns a handle to the resulting connection. Has no effect if this connection does not need saving.

Specified by:

save in interface IRemoteConnectionWorkingCopy

Returns:

saved connection

Throws:

RemoteConnectionException

open

public void open(org.eclipse.core.runtime.IProgressMonitor monitor)
          throws RemoteConnectionException

Description copied from interface: IRemoteConnection

Open the connection. Must be called before the connection can be used.

Specified by:

open in interface IRemoteConnection

Parameters:

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.

Throws:

RemoteConnectionException

close

public void close()

Description copied from interface: IRemoteConnection

Close the connection. Must be called to terminate the connection.

Specified by:

close in interface IRemoteConnection

isOpen

public boolean isOpen()

Description copied from interface: IRemoteConnection

Test if the connection is open.

Specified by:

isOpen in interface IRemoteConnection

Returns:

true if connection is open.

getProperty

public java.lang.String getProperty(java.lang.String key)

Description copied from interface: IRemoteConnection

Gets the remote system property indicated by the specified key. The connection must be open prior to calling this method.

Specified by:

getProperty in interface IRemoteConnection

Parameters:

key - the name of the property

Returns:

the string value of the property, or null if no property has that key