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

Class DigitalObjectController

java.lang.Object

de.digitalcollections.cudami.server.controller.AbstractPagingAndSortingController

de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController<T>

de.digitalcollections.cudami.server.controller.identifiable.AbstractIdentifiableController<E>

de.digitalcollections.cudami.server.controller.AbstractEntityController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

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

@RestController
public class DigitalObjectController
extends AbstractEntityController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Field Summary

Fields inherited from class de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController

LOGGER

Constructor Summary

Constructors

Constructor	Description
DigitalObjectController(DigitalObjectService digitalObjectService)

Method Summary

Modifier and Type	Method	Description
long	count()
org.springframework.http.ResponseEntity	delete(UUID uuid)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	find(int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria, de.digitalcollections.model.list.filtering.Filtering filtering)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Project>	findProjects(UUID uuid, int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria, de.digitalcollections.model.list.filtering.Filtering filtering)
org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getByIdentifier(javax.servlet.http.HttpServletRequest request, boolean fillWemi)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getByManyUuids(List<UUID> uuids, boolean fillWemi)
org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getByRefId(long refId)
org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getByUuid(UUID uuid, boolean fillWemi)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getByUuids(List<UUID> uuids, boolean fillWemi)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	getCollections(UUID uuid, int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria, de.digitalcollections.model.list.filtering.Filtering filtering, String active)
List<de.digitalcollections.model.identifiable.resource.FileResource>	getFileResources(UUID uuid)
List<de.digitalcollections.model.identifiable.resource.ImageFileResource>	getIiifImageFileResources(UUID uuid)
List<de.digitalcollections.model.identifiable.resource.ImageFileResource>	getImageFileResources(UUID uuid)
de.digitalcollections.model.identifiable.entity.item.Item	getItem(UUID uuid)
List<Locale>	getLanguages(List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria, de.digitalcollections.model.list.filtering.Filtering filtering)
List<Locale>	getLanguagesOfCollections(UUID uuid)
List<Locale>	getLanguagesOfProjects(UUID uuid)
List<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getRandomDigitalObjects(int count)
protected EntityService<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	getService()
de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject	save(de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject digitalObject, org.springframework.validation.BindingResult errors)
List<de.digitalcollections.model.identifiable.resource.FileResource>	setFileResources(UUID uuid, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject	update(UUID uuid, de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject digitalObject, org.springframework.validation.BindingResult errors)

Methods inherited from class de.digitalcollections.cudami.server.controller.identifiable.AbstractIdentifiableController

extractNamespaceAndId, getByIdentifier, getLanguages

Methods inherited from class de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController

buildExamplesWithUuids, buildExampleWithUuid, delete, getByUuid, getByUuidAndLocale, getByUuids

Methods inherited from class de.digitalcollections.cudami.server.controller.AbstractPagingAndSortingController

createPageRequest, getFieldType, mergeFilters

Methods inherited from class java.lang.Object

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

Constructor Details

DigitalObjectController

public DigitalObjectController(DigitalObjectService digitalObjectService)

Method Details

count

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

Overrides:

count in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Throws:

ServiceException

delete

@DeleteMapping(value={"/v6/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}$}","/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 org.springframework.http.ResponseEntity delete(@PathVariable("uuid")
 UUID uuid)
                                               throws ConflictException,
ServiceException

Overrides:

delete in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Throws:

ConflictException

ServiceException

find

@GetMapping(value="/v6/digitalobjects",
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> find(@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.list.sorting.Order> sortBy,
 @RequestParam(name="filter",required=false)
 List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria,
 @RequestParam(name="filtering",required=false)
 de.digitalcollections.model.list.filtering.Filtering filtering)
                                                                                                                                       throws ServiceException

Overrides:

find in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Throws:

ServiceException

findProjects

@GetMapping(value="/v6/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}$}/projects",
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Project> findProjects(@PathVariable("uuid")
 UUID uuid,
 @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.list.sorting.Order> sortBy,
 @RequestParam(name="filter",required=false)
 List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria,
 @RequestParam(name="filtering",required=false)
 de.digitalcollections.model.list.filtering.Filtering filtering)
                                                                                                                           throws ServiceException

Throws:

ServiceException

getByIdentifier

@GetMapping(value={"/v6/digitalobjects/identifier/**","/v5/digitalobjects/identifier/**","/v2/digitalobjects/identifier/**","/latest/digitalobjects/identifier/**"},
            produces="application/json")
public org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> getByIdentifier(javax.servlet.http.HttpServletRequest request,
 @RequestParam(name="fill-wemi",required=false,defaultValue="false")
 boolean fillWemi)
                                                                                                                                     throws ServiceException,
ValidationException

Throws:

ServiceException

ValidationException

getByRefId

@GetMapping(value="/v5/digitalobjects/{refId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> getByRefId(@PathVariable
 long refId)
                                                                                                                                throws ServiceException

Overrides:

getByRefId in class AbstractEntityController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Throws:

ServiceException

getByUuid

@GetMapping(value={"/v6/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}$}","/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 org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> getByUuid(@PathVariable
 UUID uuid,
 @RequestParam(name="fill-wemi",required=false,defaultValue="false")
 boolean fillWemi)
                                                                                                                               throws ServiceException

Throws:

ServiceException

getByUuids

@GetMapping(value="/v6/digitalobjects/list/{uuids}",
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> getByUuids(@PathVariable
 List<UUID> uuids,
 @RequestParam(name="fill-wemi",required=false,defaultValue="false")
 boolean fillWemi)
                                                                                                                                             throws ServiceException

Throws:

ServiceException

getByManyUuids

@PostMapping(value="/v6/digitalobjects/list",
             produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> getByManyUuids(@RequestBody
 List<UUID> uuids,
 @RequestParam(name="fill-wemi",required=false,defaultValue="false")
 boolean fillWemi)
                                                                                                                                                 throws ServiceException

Throws:

ServiceException

getCollections

@GetMapping(value="/v6/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}$}/collections",
            produces="application/json")
public de.digitalcollections.model.list.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="sortBy",required=false)
 List<de.digitalcollections.model.list.sorting.Order> sortBy,
 @RequestParam(name="filter",required=false)
 List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria,
 @RequestParam(name="filtering",required=false)
 de.digitalcollections.model.list.filtering.Filtering filtering,
 @RequestParam(name="active",required=false)
 String active)
                                                                                                                                throws ServiceException

Throws:

ServiceException

getFileResources

@GetMapping(value={"/v6/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}$}/fileresources","/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}$}/fileresources","/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}$}/fileresources","/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}$}/fileresources"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.FileResource> getFileResources(@PathVariable
 UUID uuid)
                                                                                      throws ServiceException

Throws:

ServiceException

getIiifImageFileResources

@GetMapping(value="/v6/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}$}/fileresources/images/iiif",
            produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.ImageFileResource> getIiifImageFileResources(@PathVariable
 UUID uuid)
                                                                                                    throws ServiceException

Throws:

ServiceException

getImageFileResources

@GetMapping(value={"/v6/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}$}/fileresources/images","/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}$}/fileresources/images","/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}$}/fileresources/images","/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}$}/fileresources/images"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.ImageFileResource> getImageFileResources(@PathVariable
 UUID uuid)
                                                                                                throws ServiceException

Throws:

ServiceException

getItem

@GetMapping(value={"/v6/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}$}/item","/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}$}/item","/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}$}/item","/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}$}/item"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.item.Item getItem(@PathVariable
 UUID uuid)
                                                                  throws ServiceException

Throws:

ServiceException

getLanguages

@GetMapping(value={"/v6/digitalobjects/languages","/v5/digitalobjects/languages","/v3/digitalobjects/languages","/latest/digitalobjects/languages"},
            produces="application/json")
public List<Locale> getLanguages(@RequestParam(name="filter",required=false)
 List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria,
 @RequestParam(name="filtering",required=false)
 de.digitalcollections.model.list.filtering.Filtering filtering)
                          throws ServiceException

Throws:

ServiceException

getLanguagesOfCollections

@GetMapping(value={"/v6/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}$}/collections/languages","/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}$}/collections/languages"},
            produces="application/json")
public List<Locale> getLanguagesOfCollections(@PathVariable
 UUID uuid)
                                       throws ServiceException

Throws:

ServiceException

getLanguagesOfProjects

@GetMapping(value={"/v6/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}$}/projects/languages","/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}$}/projects/languages"},
            produces="application/json")
public List<Locale> getLanguagesOfProjects(@PathVariable
 UUID uuid)
                                    throws ServiceException

Throws:

ServiceException

getRandomDigitalObjects

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

Throws:

ServiceException

getService

protected EntityService<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> getService()

Specified by:

getService in class AbstractEntityController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

save

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

Overrides:

save in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Throws:

ServiceException

ValidationException

setFileResources

@PostMapping(value={"/v6/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}$}/fileresources","/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}$}/fileresources","/v3/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}$}/fileresources","/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}$}/fileresources"},
             produces="application/json")
public List<de.digitalcollections.model.identifiable.resource.FileResource> setFileResources(@PathVariable("uuid")
 UUID uuid,
 @RequestBody
 List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
                                                                                      throws ServiceException

Throws:

ServiceException

update

@PutMapping(value={"/v6/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}$}","/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.DigitalObject update(@PathVariable("uuid")
 UUID uuid,
 @RequestBody
 de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject digitalObject,
 org.springframework.validation.BindingResult errors)
                                                                                   throws ServiceException,
ValidationException

Overrides:

update in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>

Throws:

ServiceException

ValidationException