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

Class WebpageController

java.lang.Object

de.digitalcollections.cudami.server.controller.identifiable.AbstractIdentifiableController<de.digitalcollections.model.identifiable.web.Webpage>

de.digitalcollections.cudami.server.controller.identifiable.web.WebpageController

@RestController
public class WebpageController
extends AbstractIdentifiableController<de.digitalcollections.model.identifiable.web.Webpage>

Constructor Summary

Constructors

Constructor	Description
WebpageController(LocaleService localeService, WebpageService webpageService)

Method Summary

Modifier and Type	Method	Description
void	addRelatedFileResource(UUID uuid, UUID fileResourceUuid)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage>	find(int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, String labelTerm, Locale labelLanguage, de.digitalcollections.model.list.filtering.FilterCriterion<LocalDate> publicationStart, de.digitalcollections.model.list.filtering.FilterCriterion<LocalDate> publicationEnd)
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage>	findSubpages(UUID uuid, int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, String active, String searchTerm)
org.springframework.http.ResponseEntity<de.digitalcollections.model.view.BreadcrumbNavigation>	getBreadcrumbNavigation(UUID uuid, Locale pLocale)
org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.web.Webpage>	getByUuid(UUID uuid, Locale pLocale, String active)
List<de.digitalcollections.model.identifiable.web.Webpage>	getChildrenTree(UUID uuid, String active)
de.digitalcollections.model.identifiable.web.Webpage	getParent(UUID uuid)
List<de.digitalcollections.model.identifiable.resource.FileResource>	getRelatedFileResources(UUID uuid)
protected IdentifiableService<de.digitalcollections.model.identifiable.web.Webpage>	getService()
de.digitalcollections.model.identifiable.entity.Website	getWebsite(UUID uuid)
de.digitalcollections.model.identifiable.web.Webpage	saveWithParentWebpage(UUID parentWebpageUuid, de.digitalcollections.model.identifiable.web.Webpage webpage, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.identifiable.web.Webpage	saveWithParentWebsite(UUID parentWebsiteUuid, de.digitalcollections.model.identifiable.web.Webpage webpage, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.identifiable.web.Webpage	update(UUID uuid, de.digitalcollections.model.identifiable.web.Webpage webpage, org.springframework.validation.BindingResult errors)
org.springframework.http.ResponseEntity	updateChildrenOrder(UUID uuid, List<de.digitalcollections.model.identifiable.web.Webpage> rootPages)

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

addLabelFilter, extractNamespaceAndId, find, getByIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

WebpageController

public WebpageController(LocaleService localeService,
                         WebpageService webpageService)

Method Detail

getService

protected IdentifiableService<de.digitalcollections.model.identifiable.web.Webpage> getService()

Specified by:

getService in class AbstractIdentifiableController<de.digitalcollections.model.identifiable.web.Webpage>

addRelatedFileResource

@PostMapping({"/v6/webpages/{uuid}/related/fileresources/{fileResourceUuid}","/v5/webpages/{uuid}/related/fileresources/{fileResourceUuid}","/v2/webpages/{uuid}/related/fileresources/{fileResourceUuid}","/latest/webpages/{uuid}/related/fileresources/{fileResourceUuid}"})
@ResponseStatus(OK)
public void addRelatedFileResource(@PathVariable
                                   UUID uuid,
                                   @PathVariable
                                   UUID fileResourceUuid)

find

@GetMapping(value="/v6/webpages",
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage> find(@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="label",required=false)
                                                                                                                       String labelTerm,
                                                                                                                       @RequestParam(name="labelLanguage",required=false)
                                                                                                                       Locale labelLanguage,
                                                                                                                       @RequestParam(name="publicationStart",required=false)
                                                                                                                       de.digitalcollections.model.list.filtering.FilterCriterion<LocalDate> publicationStart,
                                                                                                                       @RequestParam(name="publicationEnd",required=false)
                                                                                                                       de.digitalcollections.model.list.filtering.FilterCriterion<LocalDate> publicationEnd)

findSubpages

@GetMapping(value="/v6/webpages/{uuid}/children",
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage> findSubpages(@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="active",required=false)
                                                                                                                               String active,
                                                                                                                               @RequestParam(name="searchTerm",required=false)
                                                                                                                               String searchTerm)
                                                                                                                        throws IdentifiableServiceException

Throws:

IdentifiableServiceException

getBreadcrumbNavigation

@GetMapping(value={"/v6/webpages/{uuid}/breadcrumb","/v5/webpages/{uuid}/breadcrumb","/v3/webpages/{uuid}/breadcrumb","/latest/webpages/{uuid}/breadcrumb"},
            produces="application/json")
public org.springframework.http.ResponseEntity<de.digitalcollections.model.view.BreadcrumbNavigation> getBreadcrumbNavigation(@PathVariable("uuid")
                                                                                                                              UUID uuid,
                                                                                                                              @RequestParam(name="pLocale",required=false)
                                                                                                                              Locale pLocale)

getByUuid

@GetMapping(value={"/v6/webpages/{uuid}","/v5/webpages/{uuid}","/latest/webpages/{uuid}"},
            produces="application/json")
public org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.web.Webpage> getByUuid(@PathVariable("uuid")
                                                                                                               UUID uuid,
                                                                                                               @RequestParam(name="pLocale",required=false)
                                                                                                               Locale pLocale,
                                                                                                               @RequestParam(name="active",required=false)
                                                                                                               String active)
                                                                                                        throws IdentifiableServiceException

Throws:

IdentifiableServiceException

getChildrenTree

@GetMapping(value={"/v6/webpages/{uuid}/childrentree","/v5/webpages/{uuid}/childrentree","/latest/webpages/{uuid}/childrentree"},
            produces="application/json")
public List<de.digitalcollections.model.identifiable.web.Webpage> getChildrenTree(@PathVariable("uuid")
                                                                                  UUID uuid,
                                                                                  @RequestParam(name="active",required=false)
                                                                                  String active)

getParent

@GetMapping(value={"/v6/webpages/{uuid}/parent","/v5/webpages/{uuid}/parent","/v3/webpages/{uuid}/parent","/latest/webpages/{uuid}/parent"},
            produces="application/json")
public de.digitalcollections.model.identifiable.web.Webpage getParent(@PathVariable("uuid")
                                                                      UUID uuid)
                                                               throws IdentifiableServiceException

Throws:

IdentifiableServiceException

getRelatedFileResources

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

getWebsite

@GetMapping(value={"/v6/webpages/{uuid}/website","/v5/webpages/{uuid}/website","/v3/webpages/{uuid}/website","/latest/webpages/{uuid}/website"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.Website getWebsite(@PathVariable("uuid")
                                                                          UUID uuid)
                                                                   throws IdentifiableServiceException

Throws:

IdentifiableServiceException

saveWithParentWebpage

@PostMapping(value={"/v6/webpages/{parentWebpageUuid}/webpage","/v5/webpages/{parentWebpageUuid}/webpage","/v2/webpages/{parentWebpageUuid}/webpage","/latest/webpages/{parentWebpageUuid}/webpage"},
             produces="application/json")
public de.digitalcollections.model.identifiable.web.Webpage saveWithParentWebpage(@PathVariable
                                                                                  UUID parentWebpageUuid,
                                                                                  @RequestBody
                                                                                  de.digitalcollections.model.identifiable.web.Webpage webpage,
                                                                                  org.springframework.validation.BindingResult errors)
                                                                           throws IdentifiableServiceException,
                                                                                  ValidationException

Throws:

IdentifiableServiceException

ValidationException

saveWithParentWebsite

@PostMapping(value={"/v6/websites/{parentWebsiteUuid}/webpage","/v5/websites/{parentWebsiteUuid}/webpage","/v2/websites/{parentWebsiteUuid}/webpage","/latest/websites/{parentWebsiteUuid}/webpage"},
             produces="application/json")
public de.digitalcollections.model.identifiable.web.Webpage saveWithParentWebsite(@PathVariable
                                                                                  UUID parentWebsiteUuid,
                                                                                  @RequestBody
                                                                                  de.digitalcollections.model.identifiable.web.Webpage webpage,
                                                                                  org.springframework.validation.BindingResult errors)
                                                                           throws IdentifiableServiceException

Throws:

IdentifiableServiceException

update

@PutMapping(value={"/v6/webpages/{uuid}","/v5/webpages/{uuid}","/v2/webpages/{uuid}","/latest/webpages/{uuid}"},
            produces="application/json")
public de.digitalcollections.model.identifiable.web.Webpage update(@PathVariable
                                                                   UUID uuid,
                                                                   @RequestBody
                                                                   de.digitalcollections.model.identifiable.web.Webpage webpage,
                                                                   org.springframework.validation.BindingResult errors)
                                                            throws IdentifiableServiceException,
                                                                   ValidationException

Throws:

IdentifiableServiceException

ValidationException

updateChildrenOrder

@PutMapping(value={"/v6/webpages/{uuid}/children","/v5/webpages/{uuid}/children","/v3/webpages/{uuid}/children","/latest/webpages/{uuid}/children"},
            produces="application/json")
public org.springframework.http.ResponseEntity updateChildrenOrder(@PathVariable("uuid")
                                                                   UUID uuid,
                                                                   @RequestBody
                                                                   List<de.digitalcollections.model.identifiable.web.Webpage> rootPages)