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

Class DigitalObjectController

  • @RestController
@Api(description="The digital object controller",
     name="Digital object controller")
public class DigitalObjectController
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long count()  
      de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.DigitalObject> findAll​(int pageNumber, int pageSize, java.lang.String sortField, de.digitalcollections.model.api.paging.enums.Direction sortDirection, de.digitalcollections.model.api.paging.enums.NullHandling nullHandling)  
      de.digitalcollections.model.api.identifiable.entity.DigitalObject findById​(java.util.UUID uuid)  
      de.digitalcollections.model.api.identifiable.entity.DigitalObject findByIdIdentifier​(java.lang.String namespace, java.lang.String id)  
      java.util.LinkedHashSet<de.digitalcollections.model.api.identifiable.resource.ImageFileResource> getImageFileResources​(java.util.UUID uuid)  
      de.digitalcollections.model.api.identifiable.entity.DigitalObject save​(de.digitalcollections.model.api.identifiable.entity.DigitalObject digitalObject, org.springframework.validation.BindingResult errors)  
      de.digitalcollections.model.api.identifiable.entity.DigitalObject update​(java.util.UUID uuid, de.digitalcollections.model.api.identifiable.entity.DigitalObject digitalObject, org.springframework.validation.BindingResult errors)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DigitalObjectController

        public DigitalObjectController()

    • Method Detail

      • findAll

        @ApiMethod(description="Get all digital objects")
@RequestMapping(value={"/latest/digitalobjects","/v2/digitalobjects"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.DigitalObject> findAll​(@RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                      int pageNumber,
                                                                                                                                      @RequestParam(name="pageSize",required=false,defaultValue="5")
                                                                                                                                      int pageSize,
                                                                                                                                      @RequestParam(name="sortField",required=false,defaultValue="uuid")
                                                                                                                                      java.lang.String sortField,
                                                                                                                                      @RequestParam(name="sortDirection",required=false,defaultValue="ASC")
                                                                                                                                      de.digitalcollections.model.api.paging.enums.Direction sortDirection,
                                                                                                                                      @RequestParam(name="nullHandling",required=false,defaultValue="NATIVE")
                                                                                                                                      de.digitalcollections.model.api.paging.enums.NullHandling nullHandling)

      • findById

        @ApiMethod(description="Get digital object by uuid")
@RequestMapping(value={"/latest/digitalobjects/{uuid}","/v2/digitalobjects/{uuid}"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.DigitalObject findById​(@PathVariable
                                                                                  java.util.UUID uuid)

      • findByIdIdentifier

        @ApiMethod(description="Get digital object by namespace and id")
@RequestMapping(value={"/latest/digitalobjects/identifier/{namespace}:{id}","/v2/digitalobjects/identifier/{namespace}:{id}"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.DigitalObject findByIdIdentifier​(@PathVariable
                                                                                            java.lang.String namespace,
                                                                                            @PathVariable
                                                                                            java.lang.String id)
                                                                                     throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • save

        @ApiMethod(description="Save a newly created digital object")
@RequestMapping(value={"/latest/digitalobjects","/v2/digitalobjects"},
                produces="application/json",
                method=POST)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.DigitalObject save​(@RequestBody
                                                                              de.digitalcollections.model.api.identifiable.entity.DigitalObject digitalObject,
                                                                              org.springframework.validation.BindingResult errors)
                                                                       throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • update

        @ApiMethod(description="Update a digital object")
@RequestMapping(value={"/latest/digitalobjects/{uuid}","/v2/digitalobjects/{uuid}"},
                produces="application/json",
                method=PUT)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.DigitalObject update​(@PathVariable
                                                                                java.util.UUID uuid,
                                                                                @RequestBody
                                                                                de.digitalcollections.model.api.identifiable.entity.DigitalObject digitalObject,
                                                                                org.springframework.validation.BindingResult errors)
                                                                         throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • getImageFileResources

        @ApiMethod(description="Get image file resources of a digital object")
@RequestMapping(value={"/latest/digitalobjects/{uuid}/fileresources/images","/v2/digitalobjects/{uuid}/fileresources/images"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public java.util.LinkedHashSet<de.digitalcollections.model.api.identifiable.resource.ImageFileResource> getImageFileResources​(@PathVariable
                                                                                                                              java.util.UUID uuid)

      • count

        @ApiMethod(description="Get count of digital objects")
@RequestMapping(value={"/latest/digitalobjects/count","/v2/digitalobjects/count"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public long count()