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

Class WebpageController

java.lang.Object

de.digitalcollections.cudami.server.controller.identifiable.entity.parts.WebpageController

@RestController
@Api(description="The webpage controller",
     name="Webpage controller")
public class WebpageController
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
WebpageController()

Method Summary

Modifier and Type	Method	Description
void	addRelatedFileResource(java.util.UUID uuid, java.util.UUID fileResourceUuid)
de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.parts.Webpage>	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)
java.util.LinkedHashSet<de.digitalcollections.model.api.identifiable.resource.FileResource>	getRelatedFileResources(java.util.UUID uuid)
org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.parts.Webpage>	getWebpage(java.util.UUID uuid, java.util.Locale pLocale)
de.digitalcollections.model.api.identifiable.entity.parts.Webpage	saveWithParentWebpage(java.util.UUID parentWebpageUuid, de.digitalcollections.model.api.identifiable.entity.parts.Webpage webpage, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.api.identifiable.entity.parts.Webpage	saveWithParentWebsite(java.util.UUID parentWebsiteUuid, de.digitalcollections.model.api.identifiable.entity.parts.Webpage webpage, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.api.identifiable.entity.parts.Webpage	update(java.util.UUID uuid, de.digitalcollections.model.api.identifiable.entity.parts.Webpage webpage, 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

WebpageController

public WebpageController()

Method Detail

findAll

@ApiMethod(description="Get all webpages")
@RequestMapping(value={"/latest/webpages","/v2/webpages"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.parts.Webpage> 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)

getWebpage

@ApiMethod(description="Get a webpage as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@RequestMapping(value={"/latest/webpages/{uuid}","/v3/webpages/{uuid}"},
                produces={"application/json","application/xml"},
                method=GET)
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.parts.Webpage> getWebpage(@ApiPathParam(description="UUID of the webpage, e.g. <tt>599a120c-2dd5-11e8-b467-0ed5f89f718b</tt>") @PathVariable("uuid")
                                                                                                                             java.util.UUID uuid,
                                                                                                                             @ApiQueryParam(name="pLocale",description="Desired locale, e.g. <tt>de_DE</tt>. If unset, contents in all languages will be returned") @RequestParam(name="pLocale",required=false)
                                                                                                                             java.util.Locale pLocale)
                                                                                                                      throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

Throws:

de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

saveWithParentWebsite

@ApiMethod(description="Save a newly created top-level webpage")
@RequestMapping(value={"/latest/websites/{parentWebsiteUuid}/webpage","/v2/websites/{parentWebsiteUuid}/webpage"},
                produces="application/json",
                method=POST)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.parts.Webpage saveWithParentWebsite(@PathVariable
                                                                                               java.util.UUID parentWebsiteUuid,
                                                                                               @RequestBody
                                                                                               de.digitalcollections.model.api.identifiable.entity.parts.Webpage webpage,
                                                                                               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

saveWithParentWebpage

@ApiMethod(description="Save a newly created webpage")
@RequestMapping(value={"/latest/webpages/{parentWebpageUuid}/webpage","/v2/webpages/{parentWebpageUuid}/webpage"},
                produces="application/json",
                method=POST)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.parts.Webpage saveWithParentWebpage(@PathVariable
                                                                                               java.util.UUID parentWebpageUuid,
                                                                                               @RequestBody
                                                                                               de.digitalcollections.model.api.identifiable.entity.parts.Webpage webpage,
                                                                                               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 webpage")
@RequestMapping(value={"/latest/webpages/{uuid}","/v2/webpages/{uuid}"},
                produces="application/json",
                method=PUT)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.parts.Webpage update(@PathVariable
                                                                                java.util.UUID uuid,
                                                                                @RequestBody
                                                                                de.digitalcollections.model.api.identifiable.entity.parts.Webpage webpage,
                                                                                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

getRelatedFileResources

@ApiMethod(description="Get file resources related to webpage")
@GetMapping(value={"/latest/webpages/{uuid}/related/fileresources","/v2/webpages/{uuid}/related/fileresources"},
            produces="application/json")
@ApiResponseObject
public java.util.LinkedHashSet<de.digitalcollections.model.api.identifiable.resource.FileResource> getRelatedFileResources(@PathVariable
                                                                                                                           java.util.UUID uuid)

addRelatedFileResource

@ApiMethod(description="Add file resource related to webpage")
@PostMapping({"/latest/webpages/{uuid}/related/fileresources/{fileResourceUuid}","/v2/webpages/{uuid}/related/fileresources/{fileResourceUuid}"})
@ResponseStatus(OK)
@ApiResponseObject
public void addRelatedFileResource(@PathVariable
                                   java.util.UUID uuid,
                                   @PathVariable
                                   java.util.UUID fileResourceUuid)