Package de.hybris.platform.cmswebservices.cmsitems.controller

Class CMSItemController

java.lang.Object

de.hybris.platform.cmswebservices.cmsitems.controller.CMSItemController

@Controller
@RequestMapping("/v1/sites/{siteId}/cmsitems")
public class CMSItemController
extends Object

Generic controller to deal with CMS items (Components, Pages, Restrictions, etc...). Any item that extends CMSItem is supported using this interface.

Constructor Summary

Constructors

Constructor	Description
CMSItemController()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	createCMSItem(Map<String,Object> inputMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Map<String,Object>	findCmsItems(CMSItemSearchWsDTO cmsItemSearchInfo, PageableWsDTO pageableInfo)
Map<String,Object>	findCmsItemsByUuidsInBody(CMSItemUuidListWsDTO dto)
Map<String,Object>	getCMSItemByUUid(String uuid, String fields)
Map<String,Object>	getCMSItemByUUidAndVersion(String versionId, String uuid)
protected CMSItemFacade	getCmsItemFacade()
protected org.springframework.beans.factory.ObjectFactory<CMSVersionData>	getCmsVersionDataDataFactory()
protected CMSVersionFacade	getCmsVersionFacade()
protected DataMapper	getDataMapper()
protected LocationHeaderResource	getLocationHeaderResource()
protected WebPaginationUtils	getWebPaginationUtils()
void	removeCMSItembyUUid(String uuid)
void	setCmsItemFacade(CMSItemFacade cmsItemFacade)
void	setCmsVersionDataDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionData> cmsVersionDataDataFactory)
void	setCmsVersionFacade(CMSVersionFacade cmsVersionFacade)
void	setDataMapper(DataMapper dataMapper)
void	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
void	setWebPaginationUtils(WebPaginationUtils webPaginationUtils)
Map<String,Object>	updateCMSItem(String uuid, Map<String,Object> inputMap)
Map<String,Object>	validateCMSItemForCreation(Boolean dryRun, Map<String,Object> inputMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Map<String,Object>	validateCMSItemForUpdate(Boolean dryRun, String uuid, Map<String,Object> inputMap)

Methods inherited from class java.lang.Object

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

Constructor Details

CMSItemController

public CMSItemController()

Method Details

getCMSItemByUUid

@RequestMapping(value="/{uuid}",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public Map<String,Object> getCMSItemByUUid(@PathVariable
 String uuid,
 @RequestParam(required=false)
 String fields)
                                    throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getCMSItemByUUidAndVersion

@RequestMapping(value="/{uuid}",
                method=GET,
                params="versionId")
@ResponseStatus(OK)
@ResponseBody
public Map<String,Object> getCMSItemByUUidAndVersion(@RequestParam("versionId")
 String versionId,
 @PathVariable
 String uuid)

removeCMSItembyUUid

@RequestMapping(value="/{uuid}",
                method=DELETE)
@ResponseStatus(NO_CONTENT)
public void removeCMSItembyUUid(@PathVariable
 String uuid)
                         throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

createCMSItem

@RequestMapping(method=POST)
@ResponseStatus(CREATED)
@ResponseBody
public Map<String,Object> createCMSItem(@RequestBody
 Map<String,Object> inputMap,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                                 throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

validateCMSItemForCreation

@RequestMapping(method=POST,
                params="dryRun=true")
@ResponseStatus(OK)
@ResponseBody
public Map<String,Object> validateCMSItemForCreation(@RequestParam("dryRun")
 Boolean dryRun,
 @RequestBody
 Map<String,Object> inputMap,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                                              throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

updateCMSItem

@RequestMapping(value="/{uuid}",
                method=PUT)
@ResponseStatus(OK)
@ResponseBody
public Map<String,Object> updateCMSItem(@PathVariable
 String uuid,
 @RequestBody
 Map<String,Object> inputMap)
                                 throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

validateCMSItemForUpdate

@RequestMapping(value="/{uuid}",
                method=PUT,
                params="dryRun=true")
@ResponseStatus(OK)
@ResponseBody
public Map<String,Object> validateCMSItemForUpdate(@RequestParam("dryRun")
 Boolean dryRun,
 @PathVariable
 String uuid,
 @RequestBody
 Map<String,Object> inputMap)
                                            throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

findCmsItemsByUuidsInBody

@RequestMapping(value="/uuids",
                method=POST)
@ResponseBody
public Map<String,Object> findCmsItemsByUuidsInBody(@RequestBody
 CMSItemUuidListWsDTO dto)
                                             throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

findCmsItems

@RequestMapping(method=GET,
                params={"pageSize","currentPage"})
@ResponseBody
public Map<String,Object> findCmsItems(@ModelAttribute
 CMSItemSearchWsDTO cmsItemSearchInfo,
 @ModelAttribute
 PageableWsDTO pageableInfo)

getCmsItemFacade

protected CMSItemFacade getCmsItemFacade()

setCmsItemFacade

public void setCmsItemFacade(CMSItemFacade cmsItemFacade)

getDataMapper

protected DataMapper getDataMapper()

setDataMapper

public void setDataMapper(DataMapper dataMapper)

getWebPaginationUtils

protected WebPaginationUtils getWebPaginationUtils()

setWebPaginationUtils

public void setWebPaginationUtils(WebPaginationUtils webPaginationUtils)

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)

getCmsVersionFacade

protected CMSVersionFacade getCmsVersionFacade()

setCmsVersionFacade

public void setCmsVersionFacade(CMSVersionFacade cmsVersionFacade)

getCmsVersionDataDataFactory

protected org.springframework.beans.factory.ObjectFactory<CMSVersionData> getCmsVersionDataDataFactory()

setCmsVersionDataDataFactory

public void setCmsVersionDataDataFactory(org.springframework.beans.factory.ObjectFactory<CMSVersionData> cmsVersionDataDataFactory)