org.eclipse.ptp.remote.core
Class RemoteServicesDelegate

java.lang.Object
  org.eclipse.ptp.remote.core.RemoteServicesDelegate

public class RemoteServicesDelegate
extends java.lang.Object

A wrapper for holding initialized remote services information.
Also contains convenience utilities associated with remote file operations.

Since:

5.0

See Also:

IRemoteFileManager, IFileStore

Constructor Summary

RemoteServicesDelegate(java.lang.String remoteServicesId, java.lang.String remoteConnectionName)

Method Summary

static void	copy(IRemoteFileManager from, java.lang.String source, IRemoteFileManager to, java.lang.String target, int mkParent, org.eclipse.core.runtime.IProgressMonitor progress)
IRemoteConnection	getLocalConnection()
IRemoteConnectionManager	getLocalConnectionManager()
IRemoteFileManager	getLocalFileManager()
java.net.URI	getLocalHome()
IRemoteServices	getLocalServices()
IRemoteConnection	getRemoteConnection()
IRemoteConnectionManager	getRemoteConnectionManager()
IRemoteFileManager	getRemoteFileManager()
java.net.URI	getRemoteHome()
IRemoteServices	getRemoteServices()
void	initialize(org.eclipse.core.runtime.IProgressMonitor monitor) On the basis of the passed in identifiers, constructs the local and remote services, connection manager, connection, file manager and home URIs.
static boolean	isStable(IRemoteFileManager manager, java.lang.String path, int intervalInSecs, org.eclipse.core.runtime.IProgressMonitor progress) Checks for existence of file.
static java.lang.String	read(IRemoteFileManager manager, java.lang.String path, org.eclipse.core.runtime.IProgressMonitor progress)
static void	write(IRemoteFileManager manager, java.lang.String path, java.lang.String contents, org.eclipse.core.runtime.IProgressMonitor progress)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteServicesDelegate

public RemoteServicesDelegate(java.lang.String remoteServicesId,
                              java.lang.String remoteConnectionName)

Parameters:

remoteServicesId - e.g., "local", "remotetools", "rse"

remoteConnectionName - e.g., "ember.ncsa.illinois.edu"

Method Detail

getLocalConnection

public IRemoteConnection getLocalConnection()

getLocalConnectionManager

public IRemoteConnectionManager getLocalConnectionManager()

getLocalFileManager

public IRemoteFileManager getLocalFileManager()

getLocalHome

public java.net.URI getLocalHome()

getLocalServices

public IRemoteServices getLocalServices()

getRemoteConnection

public IRemoteConnection getRemoteConnection()

getRemoteConnectionManager

public IRemoteConnectionManager getRemoteConnectionManager()

getRemoteFileManager

public IRemoteFileManager getRemoteFileManager()

getRemoteHome

public java.net.URI getRemoteHome()

getRemoteServices

public IRemoteServices getRemoteServices()

initialize

public void initialize(org.eclipse.core.runtime.IProgressMonitor monitor)
                throws org.eclipse.core.runtime.CoreException

On the basis of the passed in identifiers, constructs the local and remote services, connection manager, connection, file manager and home URIs.

Parameters:

monitor -

Throws:

org.eclipse.core.runtime.CoreException

copy

public static void copy(IRemoteFileManager from,
                        java.lang.String source,
                        IRemoteFileManager to,
                        java.lang.String target,
                        int mkParent,
                        org.eclipse.core.runtime.IProgressMonitor progress)
                 throws org.eclipse.core.runtime.CoreException

Parameters:

from - manager for source resource

source - file to copy

to - manager for target resource

target - destination file

mkParent - EFS.NONE = mkdir -p on the parent directory; EFS.SHALLOW = mkdir parent; UNDEFINED = no mkdir

progress -

Throws:

org.eclipse.core.runtime.CoreException

isStable

public static boolean isStable(IRemoteFileManager manager,
                               java.lang.String path,
                               int intervalInSecs,
                               org.eclipse.core.runtime.IProgressMonitor progress)
                        throws org.eclipse.core.runtime.CoreException

Checks for existence of file. If it does exist, tests to see if it is stable by checking size after the given timeout.

Parameters:

manager - for resource where file is located

path - of file

intervalInSecs - time after which to check size of file again

progress -

Returns:

true if file exists and is not being written to over the given interval.

Throws:

org.eclipse.core.runtime.CoreException

read

public static java.lang.String read(IRemoteFileManager manager,
                                    java.lang.String path,
                                    org.eclipse.core.runtime.IProgressMonitor progress)
                             throws org.eclipse.core.runtime.CoreException

Parameters:

manager - for resource where file is located

path - of file

progress -

Returns:

contents of file

Throws:

org.eclipse.core.runtime.CoreException

write

public static void write(IRemoteFileManager manager,
                         java.lang.String path,
                         java.lang.String contents,
                         org.eclipse.core.runtime.IProgressMonitor progress)
                  throws org.eclipse.core.runtime.CoreException

Parameters:

manager - for resource where file is to be written

path - of file to write

contents - to write to file

progress -

Throws:

org.eclipse.core.runtime.CoreException