org.ow2.proactive.scheduler.rest.ds

Class DataSpaceClient

java.lang.Object

org.ow2.proactive.scheduler.rest.ds.DataSpaceClient

All Implemented Interfaces:

IDataSpaceClient

public class DataSpaceClient
extends Object
implements IDataSpaceClient

Nested Class Summary

Nested classes/interfaces inherited from interface org.ow2.proactive.scheduler.rest.ds.IDataSpaceClient

IDataSpaceClient.Dataspace, IDataSpaceClient.ILocalDestination, IDataSpaceClient.ILocalSource, IDataSpaceClient.IRemoteDestination, IDataSpaceClient.IRemoteSource

Constructor Summary

Constructors

Constructor and Description
DataSpaceClient()
DataSpaceClient(String restServerUrl, org.jboss.resteasy.client.jaxrs.ClientHttpEngine httpEngine)

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
void	init(ConnectionInfo connectionInfo)
void	init(String restServerUrl, ISchedulerClient client)
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSpaceClient

public DataSpaceClient()

DataSpaceClient

public DataSpaceClient(String restServerUrl,
                       org.jboss.resteasy.client.jaxrs.ClientHttpEngine httpEngine)

Method Detail

init

public void init(String restServerUrl,
                 ISchedulerClient client)

init

public void init(ConnectionInfo connectionInfo)
          throws Exception

Throws:

Exception

upload

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

Specified by:

upload in interface IDataSpaceClient

Throws:

NotConnectedException

PermissionException

create

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

Description copied from interface: IDataSpaceClient

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

Specified by:

create in interface IDataSpaceClient

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

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

Specified by:

download in interface IDataSpaceClient

Throws:

NotConnectedException

PermissionException

getGlobalSpace

public RemoteSpace getGlobalSpace()

Description copied from interface: IDataSpaceClient

Returns a RemoteSpace implementation instance which represents the globalspace.

Specified by:

getGlobalSpace in interface IDataSpaceClient

Returns:

an instance of RemoteSpace

getUserSpace

public RemoteSpace getUserSpace()

Description copied from interface: IDataSpaceClient

Returns a RemoteSpace implementation instance which represents the userspace

Specified by:

getUserSpace in interface IDataSpaceClient

Returns:

an instance of RemoteSpace

list

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

Description copied from interface: IDataSpaceClient

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

Specified by:

list in interface IDataSpaceClient

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

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

Description copied from interface: IDataSpaceClient

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

Specified by:

listMetadata in interface IDataSpaceClient

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

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

Description copied from interface: IDataSpaceClient

Deletes the specified directory or the file from the dataspace.

Specified by:

delete in interface IDataSpaceClient

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

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

Description copied from interface: IDataSpaceClient

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

Specified by:

metadata in interface IDataSpaceClient

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