org.gcube.dataanalysis.copernicus.motu.client

Class PlainMotuClient

java.lang.Object

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

Direct Known Subclasses:

MotuClient

public class PlainMotuClient
extends Object

This is a plain implementation of a Motu client, exposing exactly the operations provided by the server.

Author:

Paolo Fabriani

Constructor Summary

Constructors

Constructor and Description
PlainMotuClient(String serviceURL)

Method Summary

Modifier and Type	Method and Description
StatusModeResponse	checkStatus(String requestId) Check the status of a submitted request
void	describeCoverage(DownloadRequest request)
ProductMetadataInfo	describeProduct(DownloadRequest request) Retrieve metadata about a product
CASClient	getCasProxy() Return the proxy to the CAS sever.
String	getServiceURL() Return the endpoint of the Motu server.
RequestSize	getSize(DownloadRequest request) Retrieves an estimation of the size of the response
StatusModeResponse	queueProductDownload(DownloadRequest request) Asynchronously submit a request for a dataset
void	setPassword(String password) Set the passowrd to use when connecting to the Motu server.
void	setUsername(String username) Set the username to use when connecting to the Motu server.
StatusModeResponse	waitForComplete(String requestId) Polls the server until the request has been fulfilled.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainMotuClient

public PlainMotuClient(String serviceURL)

Method Detail

setUsername

public void setUsername(String username)

Set the username to use when connecting to the Motu server.

Parameters:

username - the username.

setPassword

public void setPassword(String password)

Set the passowrd to use when connecting to the Motu server.

Parameters:

password - the password.

getServiceURL

public String getServiceURL()

Return the endpoint of the Motu server.

Returns:

the endpoint of the Motu sever.

queueProductDownload

public StatusModeResponse queueProductDownload(DownloadRequest request)
                                        throws Exception

Asynchronously submit a request for a dataset

Parameters:

request -

Returns:

the status of the submitted request

Throws:

Exception

getSize

public RequestSize getSize(DownloadRequest request)
                    throws Exception

Retrieves an estimation of the size of the response

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

describeProduct

public ProductMetadataInfo describeProduct(DownloadRequest request)
                                    throws Exception

Retrieve metadata about a product

Parameters:

request - mandatory parameters are "service" and "product"

Returns:

request metadata

Throws:

Exception

describeCoverage

public void describeCoverage(DownloadRequest request)
                      throws Exception

Parameters:

request - mandatory parameters are "service" and "product"

Throws:

Exception

checkStatus

public StatusModeResponse checkStatus(String requestId)
                               throws Exception

Check the status of a submitted request

Parameters:

requestId - the id of the request to check status for.

Returns:

the status of the ongoing request

Throws:

Exception

waitForComplete

public StatusModeResponse waitForComplete(String requestId)
                                   throws Exception

Polls the server until the request has been fulfilled. Blocks the caller.

Parameters:

requestId - the id of the request

Returns:

the status response of the last (ready or failed) check

Throws:

Exception

getCasProxy

public CASClient getCasProxy()

Return the proxy to the CAS sever.

Returns:

the CAS server proxy.