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 java.lang.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
java.util.Map<java.lang.String,java.lang.Object>	createCMSItem(java.util.Map<java.lang.String,java.lang.Object> inputMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
java.util.Map<java.lang.String,java.lang.Object>	findCmsItems(CMSItemSearchWsDTO cmsItemSearchWsDTO, PageableWsDTO pageableDto)
java.util.Map<java.lang.String,java.lang.Object>	findCmsItemsByUuidsInBody(CMSItemUuidListWsDTO dto)
java.util.Map<java.lang.String,java.lang.Object>	getCMSItemByUUid(java.lang.String uuid)
java.util.Map<java.lang.String,java.lang.Object>	getCMSItemByUUidAndVersion(java.lang.String versionId, java.lang.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(java.lang.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)
java.util.Map<java.lang.String,java.lang.Object>	updateCMSItem(java.lang.String uuid, java.util.Map<java.lang.String,java.lang.Object> inputMap)
java.util.Map<java.lang.String,java.lang.Object>	validateCMSItemForCreation(java.lang.Boolean dryRun, java.util.Map<java.lang.String,java.lang.Object> inputMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
java.util.Map<java.lang.String,java.lang.Object>	validateCMSItemForUpdate(java.lang.Boolean dryRun, java.lang.String uuid, java.util.Map<java.lang.String,java.lang.Object> inputMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

CMSItemController

public CMSItemController()

Method Detail

getCMSItemByUUid

@RequestMapping(value="/{uuid}",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public java.util.Map<java.lang.String,java.lang.Object> getCMSItemByUUid(@PathVariable
                                                                               java.lang.String uuid)
                                                                        throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getCMSItemByUUidAndVersion

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

removeCMSItembyUUid

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

Throws:

CMSItemNotFoundException

createCMSItem

@RequestMapping(method=POST)
@ResponseStatus(CREATED)
@ResponseBody
public java.util.Map<java.lang.String,java.lang.Object> createCMSItem(@RequestBody
                                                                            java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.Object> validateCMSItemForCreation(@RequestParam("dryRun")
                                                                                         java.lang.Boolean dryRun,
                                                                                         @RequestBody
                                                                                         java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.Object> updateCMSItem(@PathVariable
                                                                            java.lang.String uuid,
                                                                            @RequestBody
                                                                            java.util.Map<java.lang.String,java.lang.Object> inputMap)
                                                                     throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

validateCMSItemForUpdate

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

Throws:

CMSItemNotFoundException

findCmsItemsByUuidsInBody

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

Throws:

CMSItemNotFoundException

findCmsItems

@RequestMapping(method=GET,
                params={"pageSize","currentPage"})
@ResponseBody
public java.util.Map<java.lang.String,java.lang.Object> findCmsItems(@ModelAttribute
                                                                           CMSItemSearchWsDTO cmsItemSearchWsDTO,
                                                                           @ModelAttribute
                                                                           PageableWsDTO pageableDto)

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)