org.eclipse.rse.files.ui.resources
Interface ISystemMountPathMapper

All Known Implementing Classes:

DefaultMountPathMapper

public interface ISystemMountPathMapper

This interface is used to provide a common way of mapping mounted resources to the temp files project. Since local mounts can change or be removed (i.e. disconnected) this provides a way for a vender to remap a particular resource if the vender software is able to determine the new mount location. Implementors of this interface should register their mappers via the mountPathMapper extension point.

Method Summary

String	getActualHostFor(String hostname, String remotePath) Returns the corresponding hostname for the specified path on the specified host.
String	getMountedMappingFor(String hostname, String remotePath) Returns the local system path that can be used for copying the replica back to remote.
String	getWorkspaceMappingFor(String hostname, String remotePath) Returns the qualified workspace path for a replica of this mounted file.
boolean	handlesMappingFor(String hostname, String remotePath) Indicates whether this mapper handles remapping of the specified resource

Method Detail

handlesMappingFor

public boolean handlesMappingFor(String hostname,
                                 String remotePath)

Indicates whether this mapper handles remapping of the specified resource

Parameters:

hostname - the remote host

remotePath - the remote path as seen by the local file subsystem

Returns:

whether this mapper handles remapping of the specified remote resource

getWorkspaceMappingFor

public String getWorkspaceMappingFor(String hostname,
                                     String remotePath)

Returns the qualified workspace path for a replica of this mounted file. Since the local system path is not unique for mounted files, this allows a vender to make sure it is unique. The workspace mapping should always be the remote path on the originating host.

Parameters:

hostname - the remote host

remotePath - the remote path as seen by the local file subsystem

Returns:

the corresponding workspace replica mapping

getActualHostFor

public String getActualHostFor(String hostname,
                               String remotePath)

Returns the corresponding hostname for the specified path on the specified host. If a file is mounted via local, then the actual host containing the file will not be local. If there is no mapping, then the hostname will be the same as the argument.

Parameters:

hostname - the system host

remotePath - the path on the system host

Returns:

the actual host that contains the specified remote path

getMountedMappingFor

public String getMountedMappingFor(String hostname,
                                   String remotePath)

Returns the local system path that can be used for copying the replica back to remote. When null is returned RSE the file is treated as no longer available and thus remote uploads do not occur. Venders who would like to disable uploads for some period can implement this to return null during that period.

Parameters:

hostname - the remote host

remotePath - the remote path as seen by the local file subsystem

Returns:

the local system path that represents the mounted file