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

Class WebsiteController

  • @RestController
@Api(description="The website controller",
     name="Website controller")
public class WebsiteController
extends 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.Website> findAll​(int pageNumber, int pageSize, List<de.digitalcollections.model.api.paging.Order> sortBy)  
      de.digitalcollections.model.api.identifiable.entity.Website findById​(UUID uuid)  
      List<Locale> getLanguages()  
      de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.parts.Webpage> getRootPages​(UUID uuid, int pageNumber, int pageSize, List<de.digitalcollections.model.api.paging.Order> sortBy)  
      de.digitalcollections.model.api.identifiable.entity.Website save​(de.digitalcollections.model.api.identifiable.entity.Website website, org.springframework.validation.BindingResult errors)  
      de.digitalcollections.model.api.identifiable.entity.Website update​(UUID uuid, de.digitalcollections.model.api.identifiable.entity.Website website, org.springframework.validation.BindingResult errors)  
      org.springframework.http.ResponseEntity updateRootPagesOrder​(UUID uuid, List<de.digitalcollections.model.api.identifiable.entity.parts.Webpage> rootPages)  

    • Constructor Detail

      • WebsiteController

        public WebsiteController()

    • Method Detail

      • count

        @ApiMethod(description="Get count of content trees")
@GetMapping(value={"/latest/websites/count","/v2/websites/count"},
            produces="application/json")
@ApiResponseObject
public long count()

      • findAll

        @ApiMethod(description="Get all websites")
@GetMapping(value={"/latest/websites","/v2/websites"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.Website> 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.api.paging.Order> sortBy)

      • findById

        @ApiMethod(description="Get website by uuid")
@GetMapping(value={"/latest/websites/{uuid}","/v2/websites/{uuid}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Website findById​(@PathVariable
                                                                            UUID uuid)

      • getLanguages

        @ApiMethod(description="Get languages of all websites")
@GetMapping(value={"/latest/websites/languages","/v2/websites/languages"},
            produces="application/json")
@ApiResponseObject
public List<Locale> getLanguages()

      • getRootPages

        @ApiMethod(description="Get paged root pages of a website")
@GetMapping(value={"/latest/websites/{uuid}/rootpages","/v3/websites/{uuid}/rootpages"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.parts.Webpage> getRootPages​(@ApiPathParam(description="UUID of the parent webpage, e.g. <tt>599a120c-2dd5-11e8-b467-0ed5f89f718b</tt>") @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.api.paging.Order> sortBy)
                                                                                                                                    throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • save

        @ApiMethod(description="Save a newly created website")
@PostMapping(value={"/latest/websites","/v2/websites"},
             produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Website save​(@RequestBody
                                                                        de.digitalcollections.model.api.identifiable.entity.Website website,
                                                                        org.springframework.validation.BindingResult errors)
                                                                 throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • update

        @ApiMethod(description="Update a website")
@PutMapping(value={"/latest/websites/{uuid}","/v2/websites/{uuid}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Website update​(@PathVariable
                                                                          UUID uuid,
                                                                          @RequestBody
                                                                          de.digitalcollections.model.api.identifiable.entity.Website website,
                                                                          org.springframework.validation.BindingResult errors)
                                                                   throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • updateRootPagesOrder

        @ApiMethod(description="Update the order of a website\'s rootpages")
@PutMapping(value={"/latest/websites/{uuid}/rootpages","/v3/websites/{uuid}/rootpages"},
            produces="application/json")
@ApiResponseObject
public org.springframework.http.ResponseEntity updateRootPagesOrder​(@ApiPathParam(description="UUID of the website") @PathVariable("uuid")
                                                                    UUID uuid,
                                                                    @ApiPathParam(description="List of the rootpages") @RequestBody
                                                                    List<de.digitalcollections.model.api.identifiable.entity.parts.Webpage> rootPages)