org.gcube.dataanalysis.copernicus.motu.client

Class MotuClient

java.lang.Object

org.gcube.dataanalysis.copernicus.motu.client.PlainMotuClient

org.gcube.dataanalysis.copernicus.motu.client.MotuClient

public class MotuClient
extends PlainMotuClient

Constructor Summary

Constructors

Constructor and Description
MotuClient(String serviceURL)

Method Summary

Modifier and Type	Method and Description
Collection<StatusModeResponse>	checkAllStatus(Collection<StatusModeResponse> requests) Retrieves the status of all given requests.
void	describeCoverage(String service, String product)
ProductMetadataInfo	describeProduct(ServiceMetadata service, String product)
ProductMetadataInfo	describeProduct(String service, String product)
File	downloadProduct(DownloadRequest request) Download the dataset corresponding to the given request, by splitting requests if needed.
File	downloadProduct(DownloadRequest request, File destFile)
File	downloadProduct(DownloadRequest request, File destFile, String... splitParameters) Download the dataset corresponding to the given request, by splitting requests if needed.
File	downloadProduct(DownloadRequest request, String... splitParameters)
MotuCatalogue	getCatalogue() Query the server to get a catalog of available services and associated products.
Long	getPreferredDownloadSize() Return the preferred download size set for this client.
RequestSize	getSize(DownloadRequest request) A more robust implementation of the super.getSize, as it makes sure that all parameters are set.
RequestSize	getSize(String service, String product) Return the full size of the given product, within the given service.
Collection<String>	listProductsNames(String service) Return the list of products (i.e.
Collection<ServiceMetadata>	listServices() Return the list of services exposed by this Motu server
void	setPreferredDownloadSize(Long preferredDownloadSize) Set the preferred size of chunks.

Methods inherited from class org.gcube.dataanalysis.copernicus.motu.client.PlainMotuClient

checkStatus, describeCoverage, describeProduct, getCasProxy, getServiceURL, queueProductDownload, setPassword, setUsername, waitForComplete

Methods inherited from class java.lang.Object

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

Constructor Detail

MotuClient

public MotuClient(String serviceURL)

Parameters:

serviceURL - the URL of the Motu server.

Method Detail

getPreferredDownloadSize

public Long getPreferredDownloadSize()

Return the preferred download size set for this client. If no size has been set, max_value is returned; the maximum enforced by the server will be used.

Returns:

The preferred size, as set by the client.

setPreferredDownloadSize

public void setPreferredDownloadSize(Long preferredDownloadSize)

Set the preferred size of chunks. The client will break the request to get chunks as close as possible to this size.

Parameters:

preferredDownloadSize - the preferred size of downloaded chunks.

downloadProduct

public File downloadProduct(DownloadRequest request)
                     throws Exception

Download the dataset corresponding to the given request, by splitting requests if needed.

Parameters:

request - the request for dataset.

Throws:

Exception

downloadProduct

public File downloadProduct(DownloadRequest request,
                            File destFile)
                     throws Exception

Throws:

Exception

getSize

public RequestSize getSize(DownloadRequest request)
                    throws Exception

A more robust implementation of the super.getSize, as it makes sure that all parameters are set.

Overrides:

getSize in class PlainMotuClient

Parameters:

request - all parameters also accepted by "downloadProdyct"

Returns:

the estimated size of the output, including the maximum size allowed by the server

Throws:

Exception

getSize

public RequestSize getSize(String service,
                           String product)
                    throws Exception

Return the full size of the given product, within the given service.

Parameters:

service -

product -

Returns:

Throws:

Exception

describeProduct

public ProductMetadataInfo describeProduct(String service,
                                           String product)
                                    throws Exception

Throws:

Exception

describeCoverage

public void describeCoverage(String service,
                             String product)
                      throws Exception

Throws:

Exception

describeProduct

public ProductMetadataInfo describeProduct(ServiceMetadata service,
                                           String product)
                                    throws Exception

Throws:

Exception

downloadProduct

public File downloadProduct(DownloadRequest request,
                            File destFile,
                            String... splitParameters)
                     throws Exception

Download the dataset corresponding to the given request, by splitting requests if needed.

Parameters:

request - the request for dataset.

splitParameters - the parameters along which the request has to be split.

Throws:

Exception

downloadProduct

public File downloadProduct(DownloadRequest request,
                            String... splitParameters)
                     throws Exception

Throws:

Exception

listServices

public Collection<ServiceMetadata> listServices()
                                         throws Exception

Return the list of services exposed by this Motu server

Returns:

Throws:

Exception

listProductsNames

public Collection<String> listProductsNames(String service)
                                     throws Exception

Return the list of products (i.e. datasets) available for the given service.

Parameters:

service -

Returns:

Throws:

Exception

checkAllStatus

public Collection<StatusModeResponse> checkAllStatus(Collection<StatusModeResponse> requests)
                                              throws Exception

Retrieves the status of all given requests.

Parameters:

requests - the requests whose status has to be checked.

Returns:

a collection with the status of all requests.

Throws:

Exception

getCatalogue

public MotuCatalogue getCatalogue()
                           throws Exception

Query the server to get a catalog of available services and associated products.

Returns:

a catalog

Throws:

Exception