org.ow2.proactive.scheduler.task.client

Class DataSpaceNodeClient

java.lang.Object

org.ow2.proactive.scheduler.task.client.DataSpaceNodeClient

All Implemented Interfaces:

Serializable, RemoteSpace

@PublicAPI
public class DataSpaceNodeClient
extends Object
implements RemoteSpace, Serializable

DataSpace api available as a variable during the execution of a task. it is based on the RemoteSpace interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSpaceNodeClient(SchedulerNodeClient schedulerNodeClient, IDataSpaceClient.Dataspace space, String schedulerRestUrl)

Method Summary

Modifier and Type	Method and Description
void	connect() Connects to the dataspace at the default schedulerRestUrl, using the current user credentials
void	connect(String url) Connects to the server at the specified schedulerRestUrl, using the current user credentials
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
void	disconnect() Disconnect from the server
ConnectionInfo	getConnectionInfo() Returns the connection info, if initialized previously
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.
String	getSession() Retrieves the current session identifier, or null if the session was not initialized yet.
List<String>	getSpaceURLs() Returns the URLs of the RemoteSpace
boolean	isConnected() Check connection with the server return true if the current session is connected, false otherwise
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
void	renewSession() To renew the current server session.
void	setSession(String sid) Sets the session identifier explicitly.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSpaceNodeClient

public DataSpaceNodeClient(SchedulerNodeClient schedulerNodeClient,
                           IDataSpaceClient.Dataspace space,
                           String schedulerRestUrl)

Method Detail

connect

public void connect()
             throws Exception

Connects to the dataspace at the default schedulerRestUrl, using the current user credentials

Throws:

Exception - if any error occurs during the connection.

connect

public void connect(String url)
             throws Exception

Connects to the server at the specified schedulerRestUrl, using the current user credentials

Parameters:

url - schedulerRestUrl of the scheduler

Throws:

Exception - if any error occurs during the connection

disconnect

public void disconnect()
                throws NotConnectedException,
                       PermissionException

Disconnect from the server

Throws:

NotConnectedException - if the current session is not connected

PermissionException - in case of permission issue

isConnected

public boolean isConnected()

Check connection with the server return true if the current session is connected, false otherwise

getConnectionInfo

public ConnectionInfo getConnectionInfo()

Returns the connection info, if initialized previously

Returns:

the connection info

setSession

public void setSession(String sid)

Sets the session identifier explicitly. This might run on an uninitialized client.

Parameters:

sid - session identifier

getSession

public String getSession()

Retrieves the current session identifier, or null if the session was not initialized yet.

Returns:

the current session identifier if initialize, null otherwise

renewSession

public void renewSession()

To renew the current server session.

listFiles

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

Description copied from interface: RemoteSpace

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

Specified by:

listFiles in interface RemoteSpace

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

public void pushFile(File localPath,
                     String remotePath)
              throws FileSystemException

Description copied from interface: RemoteSpace

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

Specified by:

pushFile in interface RemoteSpace

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

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

Description copied from interface: RemoteSpace

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

Specified by:

pushFiles in interface RemoteSpace

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

public File pullFile(String remotePath,
                     File localPath)
              throws FileSystemException

Description copied from interface: RemoteSpace

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

Specified by:

pullFile in interface RemoteSpace

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

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

Description copied from interface: RemoteSpace

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

Specified by:

pullFiles in interface RemoteSpace

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

public void deleteFile(String remotePath)
                throws FileSystemException

Description copied from interface: RemoteSpace

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

Specified by:

deleteFile in interface RemoteSpace

Parameters:

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

Throws:

FileSystemException

deleteFiles

public void deleteFiles(String remotePath,
                        String pattern)
                 throws FileSystemException

Description copied from interface: RemoteSpace

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

Specified by:

deleteFiles in interface RemoteSpace

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

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

Description copied from interface: RemoteSpace

Returns the URLs of the RemoteSpace

Specified by:

getSpaceURLs in interface RemoteSpace

Returns:

URL to the space

Throws:

NotConnectedException

PermissionException

FileSystemException

getInputStream

public InputStream getInputStream(String remotePath)
                           throws FileSystemException

Description copied from interface: RemoteSpace

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

Specified by:

getInputStream in interface RemoteSpace

Parameters:

remotePath - path to the remote file

Returns:

an input stream

Throws:

FileSystemException

getOutputStream

public OutputStream getOutputStream(String remotePath)
                             throws FileSystemException

Description copied from interface: RemoteSpace

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

Specified by:

getOutputStream in interface RemoteSpace

Parameters:

remotePath - path to the remote file

Returns:

an output stream

Throws:

FileSystemException