Class WebpageController


  • @RestController
    public class WebpageController
    extends Object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRelatedFileResource​(UUID uuid, UUID fileResourceUuid)  
      de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage> findAll​(int pageNumber, int pageSize, List<de.digitalcollections.model.paging.Order> sortBy, de.digitalcollections.model.filter.FilterCriterion<LocalDate> publicationStart, de.digitalcollections.model.filter.FilterCriterion<LocalDate> publicationEnd)  
      org.springframework.http.ResponseEntity<de.digitalcollections.model.view.BreadcrumbNavigation> getBreadcrumb​(UUID uuid, Locale pLocale)  
      List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources​(UUID uuid)  
      de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage> getSubpages​(UUID uuid, int pageNumber, int pageSize, List<de.digitalcollections.model.paging.Order> sortBy, String active, String searchTerm)  
      org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.web.Webpage> getWebpage​(UUID uuid, Locale pLocale, String active)  
      List<de.digitalcollections.model.identifiable.web.Webpage> getWebpageChildrenTree​(UUID uuid, String active)  
      de.digitalcollections.model.identifiable.web.Webpage getWebpageParent​(UUID uuid)  
      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)  
    • Method Detail

      • addRelatedFileResource

        @PostMapping({"/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)
      • findAll

        @GetMapping(value={"/v5/webpages","/v2/webpages","/latest/webpages"},
                    produces="application/json")
        public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage> 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,
                                                                                                                             @RequestParam(name="publicationStart",required=false)
                                                                                                                             de.digitalcollections.model.filter.FilterCriterion<LocalDate> publicationStart,
                                                                                                                             @RequestParam(name="publicationEnd",required=false)
                                                                                                                             de.digitalcollections.model.filter.FilterCriterion<LocalDate> publicationEnd)
      • getBreadcrumb

        @GetMapping(value={"/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> getBreadcrumb​(@PathVariable("uuid")
                                                                                                                            UUID uuid,
                                                                                                                            @RequestParam(name="pLocale",required=false)
                                                                                                                            Locale pLocale)
      • getRelatedFileResources

        @GetMapping(value={"/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)
      • getWebpage

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

        @GetMapping(value="/v5/webpages/{uuid}/children",
                    produces="application/json")
        public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.web.Webpage> getSubpages​(@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.paging.Order> sortBy,
                                                                                                                                 @RequestParam(name="active",required=false)
                                                                                                                                 String active,
                                                                                                                                 @RequestParam(name="searchTerm",required=false)
                                                                                                                                 String searchTerm)
                                                                                                                          throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException
      • getWebpageChildrenTree

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

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

        @GetMapping(value={"/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={"/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={"/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
      • updateChildrenOrder

        @PutMapping(value={"/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)