Package de.dlr.proseo.prodclmgr.rest

Class ProductClassManager

java.lang.Object
de.dlr.proseo.prodclmgr.rest.ProductClassManager
@Component @Transactional(isolation=REPEATABLE_READ) public class ProductClassManager extends Object
Service methods required to manage product classes and their selection rules
Author:
Dr. Thomas Bassler

  • Field Details

  • Constructor Details

    • ProductClassManager

      public ProductClassManager()

  • Method Details

    • getRestProductClass

      public List<RestProductClass> getRestProductClass(String mission, String[] productType, String[] processorClass, String level, String visibility, String[] orderBy, Integer recordFrom, Integer recordTo) throws jakarta.persistence.NoResultException, SecurityException, org.springframework.web.client.HttpClientErrorException.TooManyRequests
      Get product classes, optionally filtered by mission and/or product type
      Parameters:
      mission - the mission code
      productType - a list of product types as agreed in the mission specification documents (e. g. L2_CLOUD___)
      processorClass - a list of processor types capable of producing products from the retrieved product classes
      level - the required level of processing for the retrieved product classes
      visibility - the visibility of products from the retrieved product classes to external users
      orderBy - an array of strings containing a column name and an optional sort direction (ASC/DESC), separated by white space
      recordFrom - the first result to return
      recordTo - the last result to return
      Returns:
      a list of product classes conforming to the search criteria
      Throws:
      jakarta.persistence.NoResultException - if no product classes matching the given search criteria could be found
      SecurityException - if a cross-mission data access was attempted
      org.springframework.web.client.HttpClientErrorException.TooManyRequests - if the result list would exceed a configured maximum

    • countProductClasses

      public String countProductClasses(String mission, String[] productType, String[] processorClass, String level, String visibility) throws jakarta.persistence.NoResultException, SecurityException
      Count product classes, optionally filtered by mission and/or product type
      Parameters:
      mission - the mission code
      productType - a list of product types as agreed in the mission specification documents (e. g. L2_CLOUD___)
      processorClass - a list of processor types capable of producing products from the retrieved product classes
      level - the required level of processing for the retrieved product classes
      visibility - the visibility of products from the retrieved product classes to external users
      Returns:
      a list of product classes conforming to the search criteria
      Throws:
      jakarta.persistence.NoResultException - if no product classes matching the given search criteria could be found
      SecurityException - if a cross-mission data access was attempted

    • getProductClassNames

      public List<String> getProductClassNames(String mission, String productType) throws jakarta.persistence.NoResultException, SecurityException
      Get the product class names, optionally filtered by mission and/or product type
      Parameters:
      mission - the mission code
      productType - a list of product types as agreed in the mission specification documents (e. g. L2_CLOUD___)
      Returns:
      a list of product classes conforming to the search criteria
      Throws:
      jakarta.persistence.NoResultException - if no product classes matching the given search criteria could be found
      SecurityException - if a cross-mission data access was attempted

    • createRestProductClass

      public RestProductClass createRestProductClass(RestProductClass productClass) throws IllegalArgumentException, javax.ws.rs.ServerErrorException, SecurityException
      Create a new product class
      Parameters:
      productClass - a Json object describing the new product class
      Returns:
      a Json object describing the product class created (including ID and version) and HTTP status CREATED
      Throws:
      IllegalArgumentException - if any of the input data was invalid
      javax.ws.rs.ServerErrorException - if saving the product class to the database fails
      SecurityException - if a cross-mission data access was attempted

    • getRestProductClassById

      public RestProductClass getRestProductClassById(Long id) throws IllegalArgumentException, jakarta.persistence.NoResultException, SecurityException
      Get a product class by ID
      Parameters:
      id - the database ID of the product class
      Returns:
      a Json object describing the product class and HTTP status OK
      Throws:
      IllegalArgumentException - if no product class ID was given
      jakarta.persistence.NoResultException - if no product class with the given ID exists
      SecurityException - if a cross-mission data access was attempted

    • modifyRestProductClass

      public RestProductClass modifyRestProductClass(Long id, RestProductClass productClass) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, SecurityException, ConcurrentModificationException
      Update a product class by ID (does not update its selection rules)
      Parameters:
      id - the database ID of the product class to update
      productClass - a Json object describing the product class to modify
      Returns:
      a Json object describing the product class modified (including incremented version)
      Throws:
      jakarta.persistence.EntityNotFoundException - if no product class with the given ID exists
      IllegalArgumentException - if any of the input data was invalid
      SecurityException - if a cross-mission data access was attempted
      ConcurrentModificationException - if the product class has been modified since retrieval by the client

    • deleteProductclassById

      public void deleteProductclassById(Long id) throws jakarta.persistence.EntityNotFoundException, RuntimeException, IllegalArgumentException, SecurityException
      Delete a product class by ID (with all its selection rules)
      Parameters:
      id - the database ID of the product class to delete
      Throws:
      jakarta.persistence.EntityNotFoundException - if the processor to delete does not exist in the database
      RuntimeException - if the deletion was not performed as expected
      IllegalArgumentException - if the product class ID was not given, or if dependent objects exist
      SecurityException - if a cross-mission data access was attempted

    • getSelectionRuleStrings

      public List<SelectionRuleString> getSelectionRuleStrings(Long id, String sourceClass) throws jakarta.persistence.NoResultException, SecurityException
      Get the simple selection rules as formatted string, optionally selected by source class
      Parameters:
      id - the database ID of the product class to get the selection rule from
      sourceClass - the prosEO product type of the source class, from which the product class can be generated (may be null)
      Returns:
      a list of strings describing the selection rules for all configured processors
      Throws:
      jakarta.persistence.NoResultException - if no simple selection rules matching the given search criteria could be found
      SecurityException - if a cross-mission data access was attempted

    • createSelectionRuleString

      public RestProductClass createSelectionRuleString(Long id, @Valid @Valid List<SelectionRuleString> selectionRuleStrings) throws IllegalArgumentException, SecurityException
      Create a selection rule using Rule Language
      Parameters:
      id - the database ID of the product class
      selectionRuleStrings - a Json representation of a selection rule in Rule Language
      Returns:
      a Json object representing the simple selection rule created and HTTP status CREATED
      Throws:
      IllegalArgumentException - if any of the input data was invalid
      SecurityException - if a cross-mission data access was attempted

    • getSelectionRuleString

      public SelectionRuleString getSelectionRuleString(Long ruleid, Long id) throws jakarta.persistence.NoResultException, SecurityException
      Get a selection rule by ID
      Parameters:
      ruleid - the database ID of the simple selection rule to read
      id - the database ID of the product class
      Returns:
      a Json object representing the simple selection rule in Rule Language
      Throws:
      jakarta.persistence.NoResultException - if no selection rule or product class with the given ID exist
      SecurityException - if a cross-mission data access was attempted

    • modifySelectionRuleString

      public SelectionRuleString modifySelectionRuleString(Long ruleid, Long id, SelectionRuleString selectionRuleString) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, SecurityException, ConcurrentModificationException
      Update a selection rule using Rule Language
      Parameters:
      ruleid - the database ID of the simple selection rule to update
      id - the database ID of the product class
      selectionRuleString - a Json object representing the simple selection rule in Rule Language
      Returns:
      a Json object representing the modified simple selection rule in Rule Language
      Throws:
      jakarta.persistence.EntityNotFoundException - if no selection rule or product class with the given ID exist
      IllegalArgumentException - if any of the input data was invalid
      SecurityException - if a cross-mission data access was attempted
      ConcurrentModificationException - if the selection rule has been modified since retrieval by the client

    • deleteSelectionrule

      public void deleteSelectionrule(Long ruleid, Long id) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, SecurityException
      Delete a selection rule
      Parameters:
      ruleid - the database ID of the simple selection rule to delete
      id - the database ID of the product class
      Throws:
      jakarta.persistence.EntityNotFoundException - if the selection rule to delete or the product class do not exist in the database
      IllegalArgumentException - if the ID of the product class or the selection rule was not given, or the rule cannot be deleted due to existing product queries
      SecurityException - if a cross-mission data access was attempted

    • addProcessorToRule

      public SelectionRuleString addProcessorToRule(String configuredProcessor, Long ruleid, Long id) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, SecurityException
      Add the configured processor to the selection rule (if it is not already part of the selection rule)
      Parameters:
      configuredProcessor - the name of the configured processor to add to the selection rule
      ruleid - the database ID of the simple selection rule
      id - the database ID of the product class
      Returns:
      the modified selection rule in Rule Language
      Throws:
      jakarta.persistence.EntityNotFoundException - if no configured processor with the given name or no selection rule or product class with the given ID exist
      IllegalArgumentException - if the product class ID, the selection rule ID or the name of the configured processor were not given
      SecurityException - if a cross-mission data access was attempted

    • removeProcessorFromRule

      public SelectionRuleString removeProcessorFromRule(String configuredProcessor, Long ruleid, Long id) throws jakarta.persistence.EntityNotFoundException, IllegalArgumentException, SecurityException
      Remove the configured processor from the selection rule (the selection rule will be disconnected from the configured processor)
      Parameters:
      configuredProcessor - the name of the configured processor to remove from the selection rule
      ruleid - the database ID of the simple selection rule
      id - the database ID of the product class
      Returns:
      the Json representation of the modified selection rule
      Throws:
      jakarta.persistence.EntityNotFoundException - if no configured processor with the given name or no selection rule or product class with the given ID exist
      IllegalArgumentException - if the product class ID, the selection rule ID or the name of the configured processor were not given
      SecurityException - if a cross-mission data access was attempted