org.eclipse.hyades.execution.core.file
Interface IFileManagerExtended

All Superinterfaces:

IFileManager

All Known Implementing Classes:

FileManagerLocal

public interface IFileManagerExtended
extends IFileManager

New and improved file manager interface that supports easier feature extension in the future. The get, put and delete operations have been improved with plurality support, progress monitor support and increased type-safety for method signatures. File manager options are now available to further fine-tune the semantics of a given method such as get or put. Options are described in more detail under the option type-safe enumeration in this interface.

Nested Class Summary

static class	IFileManagerExtended.Cookie Cookie class used for the sake of uniqueness when identifing a set of state on the file server.
static class	IFileManagerExtended.FileIdentifierList A lightweight list class to use when passing one or many file identifier names into the file manager extended interface.
static class	IFileManagerExtended.Option Type-safe enumeration class used for file manager operations, not final since enumeration values can be added in the future by classes in the local package-only.

Method Summary

void	deleteDirectory(IFileManagerExtended.FileIdentifierList remoteIdentifiers) Delete directories identified by the remote names specified.
void	deleteDirectory(IFileManagerExtended.FileIdentifierList remoteIdentifiers, org.eclipse.core.runtime.IProgressMonitor monitor) Delete directories identified by the remote names specified using the given progress monitor for progres tracking and cancelability.
void	deleteFile(IFileManagerExtended.Cookie cookie) Delete files identified by the state on the remote file server specified by the given state identifier (cookie)
void	deleteFile(IFileManagerExtended.Cookie cookie, org.eclipse.core.runtime.IProgressMonitor monitor) Delete files identified by the state on the remote file server specified by the given state identifier (cookie)
void	deleteFile(IFileManagerExtended.FileIdentifierList remoteIdentifiers) Delete files identified by the remote names specified.
void	deleteFile(IFileManagerExtended.FileIdentifierList remoteIdentifiers, org.eclipse.core.runtime.IProgressMonitor monitor) Delete files identified by the remote names specified using the given progress monitor for progres tracking and cancelability.
boolean	determineServerReach(java.lang.String host, int port) Determine the server's reach, the server's reach is its ability to connect to other hosts (if a firewall blocks the server attempting connection then the reach cannot be extended for this particular host and port number) -- the primary use for this function is to determine if the agent controller machine can connect successfully to the workbench machine on a given host and port combination
void	getFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers) Transfer files identified by remote names into files identified by local names, basically download files from remote to local.
void	getFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, IFileManagerExtended.Option[] options) Transfer files identified by remote names into files identified by local names, basically download files from remote to local.
void	getFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, IFileManagerExtended.Option[] options, org.eclipse.core.runtime.IProgressMonitor monitor) Transfer files identified by remote names into files identified by local names, basically download files from remote to local.
void	getFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, org.eclipse.core.runtime.IProgressMonitor monitor) Transfer files identified by remote names into files identified by local names, basically download files from remote to local.
boolean[]	isDirectoryExistent(IFileManagerExtended.FileIdentifierList remoteIdentifier) Determines if the directory path specified resolves to an existing directory, used to validate if the given path represents a valid existing directory on the server
boolean[]	isDirectoryExistent(IFileManagerExtended.FileIdentifierList remoteIdentifier, org.eclipse.core.runtime.IProgressMonitor monitor) Determines if the directory path specified resolves to an existing directory, used to validate if the given path represents a valid existing directory on the server
boolean	isServerAvailable() Indicates whether the file server is up and running and available for commands to be sent
IFileManagerExtended.FileIdentifierList	listContent(IFileManagerExtended.FileIdentifierList remoteIdentifiers) List the contents of the file (which is a directory) identified by the remote names given.
IFileManagerExtended.FileIdentifierList	listContent(IFileManagerExtended.FileIdentifierList remoteIdentifiers, org.eclipse.core.runtime.IProgressMonitor monitor) List the contents of the file (which is a directory) identified by the remote names given.
void	modifyPermission(IFileManagerExtended.FileIdentifierList remoteIdentifiers, java.lang.String permissionDirective) Modify the permissions of a file or file directory given the names that identify the remote files and/or file directories and a permission directive in the form of a platform-specific string.
void	modifyPermission(IFileManagerExtended.FileIdentifierList remoteIdentifiers, java.lang.String permissionDirective, org.eclipse.core.runtime.IProgressMonitor monitor) Modify the permissions of a file or file directory given the names that identify the remote files and/or file directories and a permission directive in the form of a platform-specific string.
void	putFile(IFileManagerExtended.Cookie cookie, IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote, the remote file identifiers can be relative or absolute paths on the remote file system.
void	putFile(IFileManagerExtended.Cookie cookie, IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, IFileManagerExtended.Option[] options) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	putFile(IFileManagerExtended.Cookie cookie, IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, IFileManagerExtended.Option[] options, org.eclipse.core.runtime.IProgressMonitor monitor) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	putFile(IFileManagerExtended.Cookie cookie, IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, org.eclipse.core.runtime.IProgressMonitor monitor) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	putFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	putFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, IFileManagerExtended.Option[] options) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	putFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, IFileManagerExtended.Option[] options, org.eclipse.core.runtime.IProgressMonitor monitor) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	putFile(IFileManagerExtended.FileIdentifierList localIdentifiers, IFileManagerExtended.FileIdentifierList remoteIdentifiers, org.eclipse.core.runtime.IProgressMonitor monitor) Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.
void	reset() Resets the file manager, clearing any cached state, should have almost the same consequences as constructing a new file manager, as if for the first time for this client.

Methods inherited from interface org.eclipse.hyades.execution.core.file.IFileManager

deleteFile, getFile, putFile

Method Detail

deleteDirectory

void deleteDirectory(IFileManagerExtended.FileIdentifierList remoteIdentifiers)
                     throws java.io.IOException,
                            org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Delete directories identified by the remote names specified. The directories are deleted recursively if they are not empty.

Parameters:

remoteIdentifiers - the remote directories to delete

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

deleteDirectory

void deleteDirectory(IFileManagerExtended.FileIdentifierList remoteIdentifiers,
                     org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws java.io.IOException,
                            org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Delete directories identified by the remote names specified using the given progress monitor for progres tracking and cancelability. The directories are deleted recursively if they are not empty.

Parameters:

remoteIdentifiers - the names identifying the remote directories to be deleted

monitor - the progress monitor to use for progress query and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

deleteFile

void deleteFile(IFileManagerExtended.Cookie cookie,
                org.eclipse.core.runtime.IProgressMonitor monitor)
                throws java.io.IOException,
                       org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Delete files identified by the state on the remote file server specified by the given state identifier (cookie)

Parameters:

cookie - identifies the state on the server for this command, for example, when a put file command is executed, optionally a state identifier (cookie) may be given, when this is the case, the file server stores state concerning the particular put file command -- it will know for example which files have been created and then it will know how to use that state to delete them again

monitor - the progress monitor to use for progress query and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

deleteFile

void deleteFile(IFileManagerExtended.FileIdentifierList remoteIdentifiers)
                throws java.io.IOException,
                       org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Delete files identified by the remote names specified.

Parameters:

remoteIdentifiers - the remote files to delete

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

deleteFile

void deleteFile(IFileManagerExtended.FileIdentifierList remoteIdentifiers,
                org.eclipse.core.runtime.IProgressMonitor monitor)
                throws java.io.IOException,
                       org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Delete files identified by the remote names specified using the given progress monitor for progres tracking and cancelability.

Parameters:

remoteIdentifiers - the names identifying the remote files to be deleted

monitor - the progress monitor to use for progress query and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

deleteFile

void deleteFile(IFileManagerExtended.Cookie cookie)
                throws java.io.IOException,
                       org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Delete files identified by the state on the remote file server specified by the given state identifier (cookie)

Parameters:

cookie - identifies the state on the server for this command, for example, when a put file command is executed, optionally a state identifier (cookie) may be given, when this is the case, the file server stores state concerning the particular put file command -- it will know for example which files have been created and then it will know how to use that state to delete them again

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

determineServerReach

boolean determineServerReach(java.lang.String host,
                             int port)

Determine the server's reach, the server's reach is its ability to connect to other hosts (if a firewall blocks the server attempting connection then the reach cannot be extended for this particular host and port number) -- the primary use for this function is to determine if the agent controller machine can connect successfully to the workbench machine on a given host and port combination

Parameters:

host - the host to attempt to connect back on (from the server to this client initiating the command)

port - the port the server will attempt to connect back on

Returns:

true if the server can reach given the combination host and port combination

getFile

void getFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by remote names into files identified by local names, basically download files from remote to local.

Parameters:

localIdentifiers - the names identifying the local files to be copied to

remoteNames - the names identifying the remote files to be copied from

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

getFile

void getFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             IFileManagerExtended.Option[] options)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by remote names into files identified by local names, basically download files from remote to local. Use the given options to determine the exact semantics of the operation.

Parameters:

localIdentifiers - the names identifying the local files to be copied to

remoteIdentifiers - the names identifying the remote files to be copied from

options - the options to use for the file manager operation

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

getFile

void getFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             IFileManagerExtended.Option[] options,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by remote names into files identified by local names, basically download files from remote to local. Use the given options to determine the exact semantics of the operation. Use the progress monitor to query status and support cancelability.

Parameters:

localIdentifiers - the names identifying the local files to be copied to

remoteIdentifiers - the names identifying the remote files to be copied from

options - the options to use for the file manager operation

monitor - the progress monitor to use for progress and execution control

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

getFile

void getFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by remote names into files identified by local names, basically download files from remote to local. Use the progress monitor to query status and support cancelability.

Parameters:

localIdentifiers - the names identifying the local files to be copied to

remoteIdentifiers - the names identifying the remote files to be copied from

monitor - the progress monitor to use for progress and execution control

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

isDirectoryExistent

boolean[] isDirectoryExistent(IFileManagerExtended.FileIdentifierList remoteIdentifier)
                              throws java.io.IOException,
                                     org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Determines if the directory path specified resolves to an existing directory, used to validate if the given path represents a valid existing directory on the server

Parameters:

remoteIdentifier - the directory to validate on the server

Returns:

true if the directory exists on the server

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

isDirectoryExistent

boolean[] isDirectoryExistent(IFileManagerExtended.FileIdentifierList remoteIdentifier,
                              org.eclipse.core.runtime.IProgressMonitor monitor)
                              throws java.io.IOException,
                                     org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Determines if the directory path specified resolves to an existing directory, used to validate if the given path represents a valid existing directory on the server

Parameters:

remoteIdentifier - the directory to validate on the server

monitor - the progres monitor for querying progress and canceling

Returns:

true if the directory exists on the server

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

isServerAvailable

boolean isServerAvailable()
                          throws java.io.IOException

Indicates whether the file server is up and running and available for commands to be sent

Returns:

true if the file server is ready for commands to be sent to it, it should always be available unless some exception condition brought it down, it is initialized and brought online as the agent controller starts up

Throws:

java.io.IOException

listContent

IFileManagerExtended.FileIdentifierList listContent(IFileManagerExtended.FileIdentifierList remoteIdentifiers)
                                                    throws java.io.IOException,
                                                           org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

List the contents of the file (which is a directory) identified by the remote names given. The contents of the directories are returned in a file location list that can be iterated through to retrieve the individual strings stored in the list. Each string represents the textual identity of the file or file directory that is contained in the directories identified by the given remote names.

Parameters:

remoteIdentifiers - the names identifying the remote file directories to list contents of

Returns:

the contents of the specified file directories are returned to the caller

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

listContent

IFileManagerExtended.FileIdentifierList listContent(IFileManagerExtended.FileIdentifierList remoteIdentifiers,
                                                    org.eclipse.core.runtime.IProgressMonitor monitor)
                                                    throws java.io.IOException,
                                                           org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

List the contents of the file (which is a directory) identified by the remote names given. The contents of the directories are returned in a file location list that can be iterated through to retrieve the individual strings stored in the list. Each string represents the textual identity of the file or file directory that is contained in the directories identified by the given remote names.

Parameters:

remoteIdentifiers - the names identifying the remote file directories to list contents of

monitor - the progres monitor for querying progress and canceling

Returns:

the contents of the specified file directories are returned to the caller

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

modifyPermission

void modifyPermission(IFileManagerExtended.FileIdentifierList remoteIdentifiers,
                      java.lang.String permissionDirective)
                      throws java.io.IOException,
                             org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Modify the permissions of a file or file directory given the names that identify the remote files and/or file directories and a permission directive in the form of a platform-specific string. The platform-specific string will be interpreted by the server-side and examples of usage will be included here when available.

Parameters:

remoteIdentifiers - the names identifying the remote files and file directories to apply the given permission directive to

permissionDirective - the permission directive to pass, unchanged, to the server-side file manager implementation

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

modifyPermission

void modifyPermission(IFileManagerExtended.FileIdentifierList remoteIdentifiers,
                      java.lang.String permissionDirective,
                      org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws java.io.IOException,
                             org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Modify the permissions of a file or file directory given the names that identify the remote files and/or file directories and a permission directive in the form of a platform-specific string. The platform-specific string will be interpreted by the server-side and examples of usage will be included here when available.

Parameters:

remoteIdentifiers - the names identifying the remote files and file directories to apply the given permission directive to

permissionDirective - the permission directive to pass, unchanged, to the server-side file manager implementation

monitor - the progress monitor for querying progress and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.Cookie cookie,
             IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote, the remote file identifiers can be relative or absolute paths on the remote file system. Relative paths will be made absolute to the temporary location deemed appropriate on the target, remote operating system. Relative paths can be

Parameters:

cookie - the state identifier (cookie) to use for this one particular command invocation, can be saved and then passed in to other methods to access this stored server state (such as the delete file method)

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system) -- use forward slashes '/' to separate path segments to be as platform-agnostic as possible (this will work on the majority of file systems).

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.Cookie cookie,
             IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             IFileManagerExtended.Option[] options)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote. Use the given options to determine the exact semantics of the operation.

Parameters:

cookie - the state identifier (cookie) to use for this one particular command invocation, can be saved and then passed in to other methods to access this stored server state (such as the delete file method)

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

options - the options to use for the file manager operation

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.Cookie cookie,
             IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             IFileManagerExtended.Option[] options,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote. Use the given options to determine the exact semantics of the operation. The progress monitor is used for progress reporting and cancelability.

Parameters:

cookie - the state identifier (cookie) to use for this one particular command invocation, can be saved and then passed in to other methods to access this stored server state (such as the delete file method)

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

options - the options to use for the file manager operation

monitor - the progress monitor to use for reporting and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.Cookie cookie,
             IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote. The progress monitor is used for progress reporting and cancelability.

Parameters:

cookie - the state identifier (cookie) to use for this one particular command invocation, can be saved and then passed in to other methods to access this stored server state (such as the delete file method)

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

monitor - the progress monitor to use for reporting and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote.

Parameters:

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             IFileManagerExtended.Option[] options)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote. Use the given options to determine the exact semantics of the operation.

Parameters:

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

options - the options to use for the file manager operation

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             IFileManagerExtended.Option[] options,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote. Use the given options to determine the exact semantics of the operation. The progress monitor is used for progress reporting and cancelability.

Parameters:

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

options - the options to use for the file manager operation

monitor - the progress monitor to use for reporting and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

putFile

void putFile(IFileManagerExtended.FileIdentifierList localIdentifiers,
             IFileManagerExtended.FileIdentifierList remoteIdentifiers,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.io.IOException,
                    org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

Transfer files identified by local names into files identified by remote names, basically upload files from local to remote. The progress monitor is used for progress reporting and cancelability.

Parameters:

localIdentifiers - the names identifying the local files to be copied from

remoteIdentifiers - the names identifying the remote files to be copied to, supports relative paths in addition to absolute paths, resolving the relative paths into absolute paths as required, this argument serves as an in and out argument returning the resolved relative file identifiers back (as absolute paths on the remote system)

monitor - the progress monitor to use for reporting and canceling

Throws:

IOException, - ServerNotAvailableException

java.io.IOException

org.eclipse.hyades.internal.execution.core.file.ServerNotAvailableException

reset

void reset()

Resets the file manager, clearing any cached state, should have almost the same consequences as constructing a new file manager, as if for the first time for this client. Typically used in cases where the file manager factory is using multiple file managers to determine what version and protocol the server supports.