Package de.digitalcollections.cudami.server.controller.identifiable.entity

Class DigitalObjectController

  • @RestController
public class DigitalObjectController
extends Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long count()  
      org.springframework.http.ResponseEntity delete​(UUID uuid)  
      de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> findAll​(int pageNumber, int pageSize, List<de.digitalcollections.model.paging.Order> sortBy)  
      List<de.digitalcollections.model.identifiable.entity.DigitalObject> findAllReduced()  
      de.digitalcollections.model.identifiable.entity.DigitalObject findByIdentifier​(String namespace, String id)  
      de.digitalcollections.model.identifiable.entity.DigitalObject findByRefId​(long refId)  
      de.digitalcollections.model.identifiable.entity.DigitalObject findByUuid​(UUID uuid)  
      de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> findDigitalObjects​(int pageNumber, int pageSize, List<de.digitalcollections.model.paging.Order> sortBy, String searchTerm)  
      de.digitalcollections.model.identifiable.entity.work.Item findItemOfDigitalObject​(UUID uuid)  
      List<de.digitalcollections.model.identifiable.entity.DigitalObject> findRandomDigitalObjects​(int count)  
      de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> getCollections​(UUID uuid, int pageNumber, int pageSize, String active, String searchTerm)  
      List<de.digitalcollections.model.identifiable.resource.FileResource> getFileResources​(UUID uuid)  
      List<de.digitalcollections.model.identifiable.resource.ImageFileResource> getImageFileResources​(UUID uuid)  
      List<Locale> getLanguages()  
      List<Locale> getLanguagesOfCollections​(UUID uuid)  
      List<Locale> getLanguagesOfProjects​(UUID uuid)  
      de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Project> getProjects​(UUID uuid, int pageNumber, int pageSize, String searchTerm)  
      de.digitalcollections.model.identifiable.entity.DigitalObject save​(de.digitalcollections.model.identifiable.entity.DigitalObject digitalObject, org.springframework.validation.BindingResult errors)  
      List<de.digitalcollections.model.identifiable.resource.FileResource> saveFileResources​(UUID uuid, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)  
      de.digitalcollections.model.identifiable.entity.DigitalObject update​(UUID uuid, de.digitalcollections.model.identifiable.entity.DigitalObject digitalObject, org.springframework.validation.BindingResult errors)  

    • Constructor Detail

      • DigitalObjectController

        public DigitalObjectController​(DigitalObjectService digitalObjectService)

    • Method Detail

      • count

        @GetMapping(value={"/v5/digitalobjects/count","/v2/digitalobjects/count","/latest/digitalobjects/count"},
            produces="application/json")
public long count()

      • delete

        @DeleteMapping(value={"/v5/digitalobjects/{uuid}","/v2/digitalobjects/{uuid}","/latest/digitalobjects/{uuid}"},
               produces="application/json")
public org.springframework.http.ResponseEntity delete​(@PathVariable("uuid")
                                                      UUID uuid)

      • findAll

        @GetMapping(value="/v5/digitalobjects",
            produces="application/json")
public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> findAll​(@RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                              int pageNumber,
                                                                                                                              @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                              int pageSize,
                                                                                                                              @RequestParam(name="sortBy",required=false)
                                                                                                                              List<de.digitalcollections.model.paging.Order> sortBy)

      • findAllReduced

        @GetMapping(value={"/v5/digitalobjects/reduced","/v3/digitalobjects/reduced","/latest/digitalobjects/reduced"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.entity.DigitalObject> findAllReduced()

      • findByRefId

        @GetMapping(value="/v5/digitalobjects/{refId:[0-9]+}",
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.DigitalObject findByRefId​(@PathVariable
                                                                                 long refId)

      • findByUuid

        @GetMapping(value={"/v5/digitalobjects/{uuid:[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}}","/v2/digitalobjects/{uuid:[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}}","/latest/digitalobjects/{uuid:[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}}"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.DigitalObject findByUuid​(@PathVariable
                                                                                UUID uuid)

      • findByIdentifier

        @GetMapping(value={"/v5/digitalobjects/identifier/{namespace}:{id}","/v2/digitalobjects/identifier/{namespace}:{id}","/latest/digitalobjects/identifier/{namespace}:{id}"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.DigitalObject findByIdentifier​(@PathVariable("namespace")
                                                                                      String namespace,
                                                                                      @PathVariable("id")
                                                                                      String id)
                                                                               throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • findDigitalObjects

        @GetMapping(value={"/v5/digitalobjects/search","/v3/digitalobjects/search","/latest/digitalobjects/search"},
            produces="application/json")
public de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> findDigitalObjects​(@RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                               int pageNumber,
                                                                                                                                               @RequestParam(name="pageSize",required=false,defaultValue="5")
                                                                                                                                               int pageSize,
                                                                                                                                               @RequestParam(name="sortBy",required=false)
                                                                                                                                               List<de.digitalcollections.model.paging.Order> sortBy,
                                                                                                                                               @RequestParam(name="searchTerm",required=false)
                                                                                                                                               String searchTerm)

      • findItemOfDigitalObject

        @GetMapping(value={"/v5/digitalobjects/{uuid}/item","/v2/digitalobjects/{uuid}/item","/latest/digitalobjects/{uuid}/item"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.work.Item findItemOfDigitalObject​(@PathVariable
                                                                                         UUID uuid)

      • findRandomDigitalObjects

        @GetMapping(value={"/v5/digitalobjects/random","/v2/digitalobjects/random","/latest/digitalobjects/random"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.entity.DigitalObject> findRandomDigitalObjects​(@RequestParam(name="count",required=false,defaultValue="5")
                                                                                                    int count)

      • getCollections

        @GetMapping(value="/v5/digitalobjects/{uuid}/collections",
            produces="application/json")
public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> getCollections​(@PathVariable("uuid")
                                                                                                                                  UUID uuid,
                                                                                                                                  @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                  int pageNumber,
                                                                                                                                  @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                  int pageSize,
                                                                                                                                  @RequestParam(name="active",required=false)
                                                                                                                                  String active,
                                                                                                                                  @RequestParam(name="searchTerm",required=false)
                                                                                                                                  String searchTerm)

      • getFileResources

        @GetMapping(value={"/v5/digitalobjects/{uuid}/fileresources","/v2/digitalobjects/{uuid}/fileresources","/latest/digitalobjects/{uuid}/fileresources"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.FileResource> getFileResources​(@PathVariable
                                                                                             UUID uuid)

      • getImageFileResources

        @GetMapping(value={"/v5/digitalobjects/{uuid}/fileresources/images","/v2/digitalobjects/{uuid}/fileresources/images","/latest/digitalobjects/{uuid}/fileresources/images"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.ImageFileResource> getImageFileResources​(@PathVariable
                                                                                                       UUID uuid)

      • getLanguagesOfCollections

        @GetMapping(value="/v5/digitalobjects/{uuid}/collections/languages",
            produces="application/json")
public List<Locale> getLanguagesOfCollections​(@PathVariable
                                              UUID uuid)

      • getLanguagesOfProjects

        @GetMapping(value="/v5/digitalobjects/{uuid}/projects/languages",
            produces="application/json")
public List<Locale> getLanguagesOfProjects​(@PathVariable
                                           UUID uuid)

      • getProjects

        @GetMapping(value="/v5/digitalobjects/{uuid}/projects",
            produces="application/json")
public de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Project> getProjects​(@PathVariable("uuid")
                                                                                                                                  UUID uuid,
                                                                                                                                  @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                  int pageNumber,
                                                                                                                                  @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                  int pageSize,
                                                                                                                                  @RequestParam(name="searchTerm",required=false)
                                                                                                                                  String searchTerm)

      • save

        @PostMapping(value={"/v5/digitalobjects","/v2/digitalobjects","/latest/digitalobjects"},
             produces="application/json")
public de.digitalcollections.model.identifiable.entity.DigitalObject save​(@RequestBody
                                                                          de.digitalcollections.model.identifiable.entity.DigitalObject digitalObject,
                                                                          org.springframework.validation.BindingResult errors)
                                                                   throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • saveFileResources

        @PostMapping(value={"/v5/digitalobjects/{uuid}/fileresources","/v3/digitalobjects/{uuid}/fileresources","/latest/digitalobjects/{uuid}/fileresources"},
             produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.FileResource> saveFileResources​(@PathVariable("uuid")
                                                                                              UUID uuid,
                                                                                              @RequestBody
                                                                                              List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)

      • update

        @PutMapping(value={"/v5/digitalobjects/{uuid}","/v2/digitalobjects/{uuid}","/latest/digitalobjects/{uuid}"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.DigitalObject update​(@PathVariable("uuid")
                                                                            UUID uuid,
                                                                            @RequestBody
                                                                            de.digitalcollections.model.identifiable.entity.DigitalObject digitalObject,
                                                                            org.springframework.validation.BindingResult errors)
                                                                     throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • getLanguages

        @GetMapping(value={"/v5/digitalobjects/languages","/v3/digitalobjects/languages","/latest/digitalobjects/languages"},
            produces="application/json")
public List<Locale> getLanguages()