org.ow2.proactive.scheduler.common.task.dataspaces

Interface RemoteSpace

All Known Implementing Classes:

DataSpaceNodeClient

@PublicAPI
public interface RemoteSpace

RemoteSpace is the interface used to access remote file spaces

Since:

ProActive Scheduling 4.0

Method Summary

Modifier and Type	Method and Description
void	deleteFile(String remotePath) Delete the given file or folder(including its content) inside the remote space
void	deleteFiles(String remotePath, String pattern) Delete the remote files described by the given pattern The following special characters can be used inside the pattern : ** matches zero or more directories * matches zero or more characters ? matches one character
InputStream	getInputStream(String remotePath) Returns an input stream on the specified remote file.
OutputStream	getOutputStream(String remotePath) Returns an output stream on the specified remote file.
List<String>	getSpaceURLs() Returns the URLs of the RemoteSpace
List<String>	listFiles(String remotePath, String pattern) List the content of the given remote directory, using a glob pattern
File	pullFile(String remotePath, File localPath) Pull the given file or folder(including its content) from the remote space to the local space
Set<File>	pullFiles(String remotePath, String pattern, File localPath) Pull the remote files described by the given pattern to the local space The following special characters can be used inside the pattern : ** matches zero or more directories * matches zero or more characters ? matches one character
void	pushFile(File localPath, String remotePath) Push the given file or directory(including its content) from the local space to the remote space.
void	pushFiles(File localDirectory, String pattern, String remotePath) Push the local files described by the given pattern to the remote space The following special characters can be used inside the pattern : ** matches zero or more directories * matches zero or more characters ? matches one character

Method Detail

listFiles

List<String> listFiles(String remotePath,
                       String pattern)
                throws FileSystemException

List the content of the given remote directory, using a glob pattern

The following special characters can be used inside the pattern :
** matches zero or more directories
* matches zero or more characters
? matches one character

Parameters:

remotePath - path in the RemoteSpace where files should be listed. Use "." for remote root path.

pattern - pattern to locate files

Returns:

a list of remote paths matching the pattern

Throws:

FileSystemException

See Also:

"https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)"

pushFile

void pushFile(File localPath,
              String remotePath)
       throws FileSystemException

Push the given file or directory(including its content) from the local space to the remote space. When pushing a file or directory, the remotePath must contain the target new file or directory

Parameters:

localPath - path to the local file or directory

remotePath - path in the RemoteSpace where to put the file or folder. Use "." for remote root path.

Throws:

FileSystemException

pushFiles

void pushFiles(File localDirectory,
               String pattern,
               String remotePath)
        throws FileSystemException

Push the local files described by the given pattern to the remote space The following special characters can be used inside the pattern :
** matches zero or more directories
* matches zero or more characters
? matches one character

Parameters:

localDirectory - local directory used as base

pattern - pattern to locate files inside the localDirectory

remotePath - path in the RemoteSpace where to put the files. Use "." for remote root path.

Throws:

FileSystemException

See Also:

"https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)"

pullFile

File pullFile(String remotePath,
              File localPath)
       throws FileSystemException

Pull the given file or folder(including its content) from the remote space to the local space

Parameters:

remotePath - path to the remote file (relative to the RemoteSpace root)

localPath - path in the local file system where to put the file or folder

Returns:

the path to the file or directory pulled

Throws:

FileSystemException

pullFiles

Set<File> pullFiles(String remotePath,
                    String pattern,
                    File localPath)
             throws FileSystemException

Pull the remote files described by the given pattern to the local space The following special characters can be used inside the pattern :
** matches zero or more directories
* matches zero or more characters
? matches one character

Parameters:

remotePath - path in the RemoteSpace used as base for the pattern (e.g. "/")

pattern - pattern to locate files inside the RemoteSpace

localPath - path in the local file system where to put the files

Returns:

a set of files pulled

Throws:

FileSystemException

See Also:

"https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)"

deleteFile

void deleteFile(String remotePath)
         throws FileSystemException

Delete the given file or folder(including its content) inside the remote space

Parameters:

remotePath - path to the remote file (relative to the RemoteSpace root) to delete

Throws:

FileSystemException

deleteFiles

void deleteFiles(String remotePath,
                 String pattern)
          throws FileSystemException

Delete the remote files described by the given pattern The following special characters can be used inside the pattern :
** matches zero or more directories
* matches zero or more characters
? matches one character

Parameters:

remotePath - path in the RemoteSpace used as base for the pattern (e.g. "/")

pattern - pattern to locate files inside the RemoteSpace

Throws:

FileSystemException

See Also:

"https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)"

getSpaceURLs

List<String> getSpaceURLs()
                   throws NotConnectedException,
                          PermissionException,
                          FileSystemException

Returns the URLs of the RemoteSpace

Returns:

URL to the space

Throws:

NotConnectedException

PermissionException

FileSystemException

getInputStream

InputStream getInputStream(String remotePath)
                    throws FileSystemException

Returns an input stream on the specified remote file. It will throw an exception if the file does not exist.

Parameters:

remotePath - path to the remote file

Returns:

an input stream

Throws:

FileSystemException

getOutputStream

OutputStream getOutputStream(String remotePath)
                      throws FileSystemException

Returns an output stream on the specified remote file. If the file does not exist, it will be created.

Parameters:

remotePath - path to the remote file

Returns:

an output stream

Throws:

FileSystemException