org.ow2.proactive.scheduler.rest.ds

Interface IDataSpaceClient

All Known Implementing Classes:

DataSpaceClient

public interface IDataSpaceClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDataSpaceClient.Dataspace
static interface	IDataSpaceClient.ILocalDestination
static interface	IDataSpaceClient.ILocalSource
static interface	IDataSpaceClient.IRemoteDestination
static interface	IDataSpaceClient.IRemoteSource

Method Summary

Modifier and Type	Method and Description
boolean	create(IDataSpaceClient.IRemoteSource source) Creates a new file or folder in the specified dataspace dataspace.
boolean	delete(IDataSpaceClient.IRemoteSource source) Deletes the specified directory or the file from the dataspace.
boolean	download(IDataSpaceClient.IRemoteSource source, IDataSpaceClient.ILocalDestination destination)
RemoteSpace	getGlobalSpace() Returns a RemoteSpace implementation instance which represents the globalspace.
RemoteSpace	getUserSpace() Returns a RemoteSpace implementation instance which represents the userspace
ListFile	list(IDataSpaceClient.IRemoteSource source) Returns a ListFile type object which contains the names of files and directories in the specified location of the dataspace.
ListFileMetadata	listMetadata(IDataSpaceClient.IRemoteSource source) Returns a ListFileMetadata type object which contains the names and metadata of files and directories in the specified location of the dataspace.
Map<String,String>	metadata(IDataSpaceClient.IRemoteSource source) Returns the metadata map of the specified file in the dataspace.
boolean	upload(IDataSpaceClient.ILocalSource source, IDataSpaceClient.IRemoteDestination destination)

Method Detail

create

boolean create(IDataSpaceClient.IRemoteSource source)
        throws NotConnectedException,
               PermissionException

Creates a new file or folder in the specified dataspace dataspace.

Parameters:

source - the remote source used to identify the type of file to create and its location.

Returns:

true if the creation has succeeded, false otherwise.

Throws:

NotConnectedException - if the client is not logged in or the session has expired

PermissionException - if the user does not have permission to upload the file to the specified location in the server

download

boolean download(IDataSpaceClient.IRemoteSource source,
                 IDataSpaceClient.ILocalDestination destination)
          throws NotConnectedException,
                 PermissionException

Throws:

NotConnectedException

PermissionException

upload

boolean upload(IDataSpaceClient.ILocalSource source,
               IDataSpaceClient.IRemoteDestination destination)
        throws NotConnectedException,
               PermissionException

Throws:

NotConnectedException

PermissionException

list

ListFile list(IDataSpaceClient.IRemoteSource source)
       throws NotConnectedException,
              PermissionException

Returns a ListFile type object which contains the names of files and directories in the specified location of the dataspace.

Throws:

NotConnectedException - if the client is not logged in or the session has expired

PermissionException - if the user does not have permission to upload the file to the specified location in the server

listMetadata

ListFileMetadata listMetadata(IDataSpaceClient.IRemoteSource source)
                       throws NotConnectedException,
                              PermissionException

Returns a ListFileMetadata type object which contains the names and metadata of files and directories in the specified location of the dataspace.

Throws:

NotConnectedException - if the client is not logged in or the session has expired

PermissionException - if the user does not have permission to upload the file to the specified location in the server

delete

boolean delete(IDataSpaceClient.IRemoteSource source)
        throws NotConnectedException,
               PermissionException

Deletes the specified directory or the file from the dataspace.

Throws:

NotConnectedException - if the client is not logged in or the session has expired

PermissionException - if the user does not have permission to upload the file to the specified location in the server

metadata

Map<String,String> metadata(IDataSpaceClient.IRemoteSource source)
                     throws NotConnectedException,
                            PermissionException

Returns the metadata map of the specified file in the dataspace.

Returns:

an instace of Map

Throws:

NotConnectedException - if the client is not logged in or the session has expired

PermissionException - if the user does not have permission to upload the file to the specified location in the server

getGlobalSpace

RemoteSpace getGlobalSpace()

Returns a RemoteSpace implementation instance which represents the globalspace.

Returns:

an instance of RemoteSpace

getUserSpace

RemoteSpace getUserSpace()

Returns a RemoteSpace implementation instance which represents the userspace

Returns:

an instance of RemoteSpace