Schnittstelle IngestController

Alle bekannten Implementierungsklassen:
IngestControllerDecorator, IngestControllerImpl

public interface IngestController
Methods to manage product files in the processing facility and in the database (Generated with springmvc-raml-parser v.2.0.5)
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    org.springframework.http.ResponseEntity<?>
    deleteProductFile(Long productId, String processingFacility, Boolean eraseFiles, org.springframework.http.HttpHeaders httpHeaders)
    Delete a product file for a product from a given processing facility (metadata and actual data file(s))
    org.springframework.http.ResponseEntity<RestProductFile>
    getProductFile(Long productId, String processingFacility, org.springframework.http.HttpHeaders httpHeaders)
    Get the product file metadata for a product at a given processing facility
    org.springframework.http.ResponseEntity<RestProductFile>
    ingestProductFile(Long productId, String processingFacility, @Valid RestProductFile restProductFile, org.springframework.http.HttpHeaders httpHeaders)
    Create the metadata of a new product file for a product at a given processing facility (it is assumed that the files themselves are already pushed to the Storage Manager) The Production Planner will be notified of the ingested product.
    org.springframework.http.ResponseEntity<List<RestProduct>>
    ingestProducts(String processingFacility, Boolean copyFiles, @Valid List<IngestorProduct> ingestorProduct, org.springframework.http.HttpHeaders httpHeaders)
    Ingest all given products into the storage manager of the given processing facility.
    org.springframework.http.ResponseEntity<RestProductFile>
    modifyProductFile(Long productId, String processingFacility, RestProductFile restProductFile, org.springframework.http.HttpHeaders httpHeaders)
    Update the product file metadata for a product at a given processing facility (it is assumed that any new or changed files themselves are already pushed to the Storage Manager)
  • Methodendetails

    • ingestProducts

      org.springframework.http.ResponseEntity<List<RestProduct>> ingestProducts(String processingFacility, Boolean copyFiles, @Valid @Valid List<IngestorProduct> ingestorProduct, org.springframework.http.HttpHeaders httpHeaders)
      Ingest all given products into the storage manager of the given processing facility. If the ID of a product to ingest is null or 0 (zero), then the product will be created, otherwise a matching product will be looked up and updated. The Production Planner will be notified of all ingested products. However, notification is optional, and if it fails, the Ingestor still returns with HTTP status CREATED. We rely on a cyclical check by the Production Planner to pick up all newly ingested products, should it not have been notified.
    • getProductFile

      org.springframework.http.ResponseEntity<RestProductFile> getProductFile(Long productId, String processingFacility, org.springframework.http.HttpHeaders httpHeaders)
      Get the product file metadata for a product at a given processing facility
    • ingestProductFile

      org.springframework.http.ResponseEntity<RestProductFile> ingestProductFile(Long productId, String processingFacility, @Valid @Valid RestProductFile restProductFile, org.springframework.http.HttpHeaders httpHeaders)
      Create the metadata of a new product file for a product at a given processing facility (it is assumed that the files themselves are already pushed to the Storage Manager) The Production Planner will be notified of the ingested product. However, notification is optional, and if it fails, the Ingestor still returns with HTTP status CREATED. We rely on a cyclical check by the Production Planner to pick up all newly ingested products, should it not have been notified.
    • deleteProductFile

      org.springframework.http.ResponseEntity<?> deleteProductFile(Long productId, String processingFacility, Boolean eraseFiles, org.springframework.http.HttpHeaders httpHeaders)
      Delete a product file for a product from a given processing facility (metadata and actual data file(s))
    • modifyProductFile

      org.springframework.http.ResponseEntity<RestProductFile> modifyProductFile(Long productId, String processingFacility, RestProductFile restProductFile, org.springframework.http.HttpHeaders httpHeaders)
      Update the product file metadata for a product at a given processing facility (it is assumed that any new or changed files themselves are already pushed to the Storage Manager)