de.hybris.platform.cms2.misc

Class AbstractPreviewServlet

java.lang.Object

HttpServlet

de.hybris.platform.cms2.misc.AbstractPreviewServlet

All Implemented Interfaces:

PreviewServlet

Deprecated.

since ages

@Deprecated
public abstract class AbstractPreviewServlet
extends HttpServlet
implements PreviewServlet

This interface is going to be remove in next version, so we shouldn't used it any more for previewing goals.

All preview logic was moved to central filter CMSFilter which is responsible for generating preview and live edit.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	AMPERSAND_MARK Deprecated.
protected static java.lang.String	EQUALS_MARK Deprecated.
protected static java.lang.String	QUESTION_MARK Deprecated.
protected static java.lang.String	SLASH_MARK Deprecated.

Fields inherited from interface de.hybris.platform.cms2.misc.PreviewServlet

PREVIEW_SERVLET_NAME, PREVIEW_TICKET_ID_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractPreviewServlet() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	doGet(HttpServletRequest req, HttpServletResponse resp) Deprecated.
protected void	doPost(HttpServletRequest req, HttpServletResponse resp) Deprecated.
protected CatalogService	getCatalogService(HttpServletRequest req) Deprecated.
protected CMSSiteModel	getCurrentSite(HttpServletRequest req) Deprecated. Returns the current site.
protected abstract java.lang.String	getDefaultResourcePath(HttpServletRequest req) Deprecated. Returns the default resource path i.e.
protected I18NService	getI18NService(HttpServletRequest req) Deprecated. Returns the I18n service.
protected LocalizationService	getLocalizationService(HttpServletRequest req) Deprecated. Returns localization service
protected ModelService	getModelService(HttpServletRequest req) Deprecated. Returns the model service.
protected PreviewDataModel	getPreviewData(CMSPreviewService previewService, java.lang.String ticketId) Deprecated.
protected CMSPreviewService	getPreviewService(HttpServletRequest req) Deprecated. Returns the CMS preview service.
protected CatalogModel	getPreviewValueForCatalogPage(HttpServletRequest req, java.lang.Class<CatalogPageModel> clazz, PreviewDataModel previewCtx) Deprecated. Returns the default preview catalog.
protected CategoryModel	getPreviewValueForCategoryPage(HttpServletRequest req, java.lang.Class<CategoryPageModel> clazz, PreviewDataModel previewCtx) Deprecated. Returns the default preview category.
protected java.lang.String	getPreviewValueForContentPage(HttpServletRequest req, ContentPageModel page) Deprecated. Returns the default preview value for the specified content page.
protected ProductModel	getPreviewValueForProductPage(HttpServletRequest req, java.lang.Class<ProductPageModel> clazz, PreviewDataModel previewCtx) Deprecated. Returns the default preview product.
protected CMSSiteService	getSiteService(HttpServletRequest req) Deprecated. Returns the CMS site service.
protected <T> T	getSpringBean(HttpServletRequest req, java.lang.Class<T> beanClass) Deprecated. Returns the spring bean of type beanClass.
protected <T> T	getSpringBean(HttpServletRequest req, java.lang.String beanName, java.lang.Class<T> beanClass) Deprecated. Returns the Spring bean with name beanName and of type beanClass.
protected UserService	getUserService(HttpServletRequest req) Deprecated. Returns the I18n service.
protected abstract java.lang.String	handleRequest(HttpServletRequest req, PreviewDataModel previewData) Deprecated. Processes the request and returns a resource path based on the supplied preview data.
protected void	processRequest(HttpServletRequest req, HttpServletResponse resp) Deprecated.
protected void	setActiveCatalogVersion(HttpServletRequest req, PreviewDataModel previewData) Deprecated.
protected void	setContext(HttpServletRequest req, PreviewDataModel data) Deprecated.
protected void	storePreviewData(HttpServletRequest req, PreviewDataModel previewData) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

EQUALS_MARK

protected static final java.lang.String EQUALS_MARK

Deprecated.

See Also:

Constant Field Values

QUESTION_MARK

protected static final java.lang.String QUESTION_MARK

Deprecated.

See Also:

Constant Field Values

SLASH_MARK

protected static final java.lang.String SLASH_MARK

Deprecated.

See Also:

Constant Field Values

AMPERSAND_MARK

protected static final java.lang.String AMPERSAND_MARK

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AbstractPreviewServlet

public AbstractPreviewServlet()

Deprecated.

Method Detail

getDefaultResourcePath

protected abstract java.lang.String getDefaultResourcePath(HttpServletRequest req)

Deprecated.

Returns the default resource path i.e. the URL to the "default" page.

Parameters:

req - the HTTP request

Returns:

relative URL to the default page

handleRequest

protected abstract java.lang.String handleRequest(HttpServletRequest req,
                                                  PreviewDataModel previewData)
                                           throws java.lang.IllegalArgumentException

Deprecated.

Processes the request and returns a resource path based on the supplied preview data.

Note: The preview data model will be automatically saved after this method has been called, thus allowing any changes made by an implementing class to be persisted.

Parameters:

req - the HTTP request

previewData - preview data

Returns:

resource path based on the supplied preview data

Throws:

java.lang.IllegalArgumentException - if preview data is null

doGet

protected void doGet(HttpServletRequest req,
                     HttpServletResponse resp)
              throws ServletException,
                     java.io.IOException

Deprecated.

Throws:

ServletException

java.io.IOException

doPost

protected void doPost(HttpServletRequest req,
                      HttpServletResponse resp)
               throws ServletException,
                      java.io.IOException

Deprecated.

Throws:

ServletException

java.io.IOException

processRequest

protected void processRequest(HttpServletRequest req,
                              HttpServletResponse resp)
                       throws ServletException,
                              java.io.IOException

Deprecated.

Throws:

ServletException

java.io.IOException

setActiveCatalogVersion

protected void setActiveCatalogVersion(HttpServletRequest req,
                                       PreviewDataModel previewData)

Deprecated.

getPreviewValueForContentPage

protected java.lang.String getPreviewValueForContentPage(HttpServletRequest req,
                                                         ContentPageModel page)

Deprecated.

Returns the default preview value for the specified content page.

The default implementation returns the label or id for the specified content page.

Parameters:

req - HTTP request

page - the page

Returns:

default value for the supplied page.

getPreviewValueForCatalogPage

protected CatalogModel getPreviewValueForCatalogPage(HttpServletRequest req,
                                                     java.lang.Class<CatalogPageModel> clazz,
                                                     PreviewDataModel previewCtx)

Deprecated.

Returns the default preview catalog.

Parameters:

req - HTTP request

clazz - page type

Returns:

the default preview catalog or null if no preview catalog could be found

getPreviewValueForCategoryPage

protected CategoryModel getPreviewValueForCategoryPage(HttpServletRequest req,
                                                       java.lang.Class<CategoryPageModel> clazz,
                                                       PreviewDataModel previewCtx)

Deprecated.

Returns the default preview category.

Parameters:

req - HTTP request

clazz - page type

Returns:

the default preview category or null if no preview catalog could be found

getPreviewValueForProductPage

protected ProductModel getPreviewValueForProductPage(HttpServletRequest req,
                                                     java.lang.Class<ProductPageModel> clazz,
                                                     PreviewDataModel previewCtx)

Deprecated.

Returns the default preview product.

Parameters:

req - HTTP request

clazz - page type

Returns:

the default preview product or null if no preview product could be found

getPreviewService

protected CMSPreviewService getPreviewService(HttpServletRequest req)

Deprecated.

Returns the CMS preview service.

Parameters:

req - HTTP request

Returns:

the preview service

getCatalogService

protected CatalogService getCatalogService(HttpServletRequest req)

Deprecated.

getSiteService

protected CMSSiteService getSiteService(HttpServletRequest req)

Deprecated.

Returns the CMS site service.

Parameters:

req - HTTP request

Returns:

the site service

getModelService

protected ModelService getModelService(HttpServletRequest req)

Deprecated.

Returns the model service.

Parameters:

req - HTTP request

Returns:

the model service

getI18NService

protected I18NService getI18NService(HttpServletRequest req)

Deprecated.

Returns the I18n service.

Parameters:

req - HTTP request

Returns:

the I18N service

getLocalizationService

protected LocalizationService getLocalizationService(HttpServletRequest req)

Deprecated.

Returns localization service

Parameters:

req - HTTP request

Returns:

the localization service

getUserService

protected UserService getUserService(HttpServletRequest req)

Deprecated.

Returns the I18n service.

Parameters:

req - HTTP request

Returns:

the I18N service

getCurrentSite

protected CMSSiteModel getCurrentSite(HttpServletRequest req)

Deprecated.

Returns the current site.

Parameters:

req - the HTTP request

Returns:

the current site or null if not available

getSpringBean

protected <T> T getSpringBean(HttpServletRequest req,
                              java.lang.Class<T> beanClass)

Deprecated.

Returns the spring bean of type beanClass.

Same as calling getSpringBean(req, null, beanClass.

Type Parameters:

T - type of the bean

Parameters:

req - the http request

beanClass - expected type of the bean

Returns:

the bean matching the given type or null if no bean could be resolved

See Also:

getSpringBean(HttpServletRequest, String, Class)

getSpringBean

protected <T> T getSpringBean(HttpServletRequest req,
                              java.lang.String beanName,
                              java.lang.Class<T> beanClass)

Deprecated.

Returns the Spring bean with name beanName and of type beanClass. If no bean could be resolved for the specified name, the bean is looked up using type.

Type Parameters:

T - type of the bean

Parameters:

req - the http request

beanName - name of the bean or null if it should be automatically resolved using type

beanClass - expected type of the bean

Returns:

the bean matching the given arguments or null if no bean could be resolved

See Also:

getSpringBean(HttpServletRequest, Class)

storePreviewData

protected void storePreviewData(HttpServletRequest req,
                                PreviewDataModel previewData)

Deprecated.

getPreviewData

protected PreviewDataModel getPreviewData(CMSPreviewService previewService,
                                          java.lang.String ticketId)

Deprecated.

setContext

protected void setContext(HttpServletRequest req,
                          PreviewDataModel data)
                   throws ServletException

Deprecated.

Throws:

ServletException