Package de.dlr.proseo.ingestor.rest

Schnittstelle ProductController

Alle bekannten Implementierungsklassen:

ProductControllerDecorator, ProductControllerImpl

public interface ProductController

Methods to manage product metadata in the database (Generated with springmvc-raml-parser v.2.0.5)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
org.springframework.http.ResponseEntity<?>	countProducts(String mission, String[] productClass, String mode, String fileClass, String quality, String startTimeFrom, String startTimeTo, String genTimeFrom, String genTimeTo, Long jobStep, org.springframework.http.HttpHeaders httpHeaders)	Number of products available, possibly filtered by mission, product class and time range
org.springframework.http.ResponseEntity<RestProduct>	createProduct(@Valid RestProduct restProduct, org.springframework.http.HttpHeaders httpHeaders)	Create a product from the given Json object (does NOT create associated product files!)
org.springframework.http.ResponseEntity<?>	deleteProductById(Long id, org.springframework.http.HttpHeaders httpHeaders)	Delete a product by ID
org.springframework.http.ResponseEntity<?>	downloadProductById(Long id, Long fromByte, Long toByte, org.springframework.http.HttpHeaders httpHeaders)	Get the primary data file (or ZIP file, if available) for the product as data stream (optionally range-restricted), returns a redirection link to the Storage Manager of a random Processing Facility
org.springframework.http.ResponseEntity<?>	getDownloadTokenById(Long id, String fileName, org.springframework.http.HttpHeaders httpHeaders)	Get a JSON Web Token for creating a download link to a Storage Manager
org.springframework.http.ResponseEntity<RestProduct>	getProductById(Long id, org.springframework.http.HttpHeaders httpHeaders)	Find the product with the given ID
org.springframework.http.ResponseEntity<RestProduct>	getProductByUuid(@Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$") String uuid, org.springframework.http.HttpHeaders httpHeaders)	Get a product by UUID
org.springframework.http.ResponseEntity<List<RestProduct>>	getProducts(String mission, String[] productClass, String mode, String fileClass, String quality, String startTimeFrom, String startTimeTo, String genTimeFrom, String genTimeTo, Integer recordFrom, Integer recordTo, Long jobStep, String[] orderBy, org.springframework.http.HttpHeaders httpHeaders)	List of all products filtered by mission, product class, start time range; the output will be ordered by the columns given in orderBy, and the resulting product list will only contain the records in the given range
org.springframework.http.ResponseEntity<RestProduct>	modifyProduct(Long id, RestProduct restProduct, org.springframework.http.HttpHeaders httpHeaders)	Update the product with the given ID with the attribute values of the given Json object.

Methodendetails

getProducts

org.springframework.http.ResponseEntity<List<RestProduct>> getProducts(String mission,
 String[] productClass,
 String mode,
 String fileClass,
 String quality,
 String startTimeFrom,
 String startTimeTo,
 String genTimeFrom,
 String genTimeTo,
 Integer recordFrom,
 Integer recordTo,
 Long jobStep,
 String[] orderBy,
 org.springframework.http.HttpHeaders httpHeaders)

List of all products filtered by mission, product class, start time range; the output will be ordered by the columns given in orderBy, and the resulting product list will only contain the records in the given range

createProduct

org.springframework.http.ResponseEntity<RestProduct> createProduct(@Valid
 @Valid RestProduct restProduct,
 org.springframework.http.HttpHeaders httpHeaders)

Create a product from the given Json object (does NOT create associated product files!)

countProducts

org.springframework.http.ResponseEntity<?> countProducts(String mission,
 String[] productClass,
 String mode,
 String fileClass,
 String quality,
 String startTimeFrom,
 String startTimeTo,
 String genTimeFrom,
 String genTimeTo,
 Long jobStep,
 org.springframework.http.HttpHeaders httpHeaders)

Number of products available, possibly filtered by mission, product class and time range

getProductById

org.springframework.http.ResponseEntity<RestProduct> getProductById(Long id,
 org.springframework.http.HttpHeaders httpHeaders)

Find the product with the given ID

deleteProductById

org.springframework.http.ResponseEntity<?> deleteProductById(Long id,
 org.springframework.http.HttpHeaders httpHeaders)

Delete a product by ID

modifyProduct

org.springframework.http.ResponseEntity<RestProduct> modifyProduct(Long id,
 RestProduct restProduct,
 org.springframework.http.HttpHeaders httpHeaders)

Update the product with the given ID with the attribute values of the given Json object. This method will NOT modify associated product files.

downloadProductById

org.springframework.http.ResponseEntity<?> downloadProductById(Long id,
 Long fromByte,
 Long toByte,
 org.springframework.http.HttpHeaders httpHeaders)

Get the primary data file (or ZIP file, if available) for the product as data stream (optionally range-restricted), returns a redirection link to the Storage Manager of a random Processing Facility

getDownloadTokenById

org.springframework.http.ResponseEntity<?> getDownloadTokenById(Long id,
 String fileName,
 org.springframework.http.HttpHeaders httpHeaders)

Get a JSON Web Token for creating a download link to a Storage Manager

getProductByUuid

org.springframework.http.ResponseEntity<RestProduct> getProductByUuid(@Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$")
 @Pattern(regexp="^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$") String uuid,
 org.springframework.http.HttpHeaders httpHeaders)

Get a product by UUID