fr.cnes.sitools.resources.order
Class OrderResource

java.lang.Object
  ExtendedWadlServerResource
      fr.cnes.sitools.common.resource.AbstractSitoolsResource
          fr.cnes.sitools.common.SitoolsResource
              fr.cnes.sitools.common.resource.SitoolsParameterizedResource
                  fr.cnes.sitools.resources.order.AbstractOrderResource
                      fr.cnes.sitools.resources.order.AbstractDatasetOrderResource
                          fr.cnes.sitools.resources.order.OrderResource

All Implemented Interfaces:

IResource, IOrderResource

Direct Known Subclasses:

DirectOrderResource

public class OrderResource
extends AbstractDatasetOrderResource

Default OrderResource implementation.

The parameter colUrl is used to specify a column containing the list of URLs of the files to order. Each file is then either copied or Zipped to the userstorage of the user.

Author:

m.gond

Field Summary

Fields inherited from class fr.cnes.sitools.common.SitoolsResource

DEFAULT_MEDIATYPE

Constructor Summary

OrderResource()

Method Summary

ListReferencesAPI	listFilesToOrder(DatabaseRequest dbRequest) Abstract method to list all the files to order.
org.restlet.representation.Representation	processOrder(ListReferencesAPI listReferences) Process the list of files to order

Methods inherited from class fr.cnes.sitools.resources.order.AbstractDatasetOrderResource

executeRequest, getCountOnDataset, getOrderName, initialiseOrder, listFilesToOrder, prepareRequest

Methods inherited from class fr.cnes.sitools.resources.order.AbstractOrderResource

checkUser, doInit, doInitialiseOrder, doTerminateOrder, executeOrder, getFileName, notifyAdminEnd, orderGet, orderPost, terminateOrder

Methods inherited from class fr.cnes.sitools.common.resource.SitoolsParameterizedResource

addStandardResponseInfo, getId, getModel, getOverrideParameterValue, getOverrideParameterValueObject, getOverrideParams, getParameterValue, getParent, setId, setModel, setParent, sitoolsDescribe

Methods inherited from class fr.cnes.sitools.common.SitoolsResource

addStandardGetRequestInfo, addStandardInternalServerErrorInfo, addStandardNotificationInfo, addStandardObjectResponseInfo, addStandardPostOrPutRequestInfo, addStandardResourceCollectionFilterInfo, addStandardSimpleResponseInfo, configure, getNotificationObject, getRepresentation, getRepresentation, getSettings, getSitoolsApplication, getSitoolsSetting

Methods inherited from class fr.cnes.sitools.common.resource.AbstractSitoolsResource

getMediaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sitools.common.model.IResource

getDescription, getName

Constructor Detail

OrderResource

public OrderResource()

Method Detail

listFilesToOrder

public ListReferencesAPI listFilesToOrder(DatabaseRequest dbRequest)
                                   throws SitoolsException

Description copied from class: AbstractDatasetOrderResource

Abstract method to list all the files to order.

Specified by:

listFilesToOrder in class AbstractDatasetOrderResource

Parameters:

dbRequest - the DatabaseRequest containing the request to the database

Returns:

a ListReferencesAPI containing the list of Reference to order

Throws:

SitoolsException - if there is any error

processOrder

public org.restlet.representation.Representation processOrder(ListReferencesAPI listReferences)
                                                       throws SitoolsException

Description copied from class: AbstractOrderResource

Process the list of files to order

Specified by:

processOrder in class AbstractOrderResource

Parameters:

listReferences - the ListReferencesAPI containing the list of Reference to order

Returns:

a Representation or null if the response is stored on the server

Throws:

SitoolsException - if there is any error