org.dd4t.mvc.controllers

Class AbstractComponentPresentationController

java.lang.Object

org.dd4t.mvc.controllers.AbstractComponentPresentationController

@Controller
public class AbstractComponentPresentationController
extends Object

dd4t-2

Extend this class in your own web project for default functionality.

Do not add stuff here, as this will be loaded as library only.

Important Note: concrete implementing classes will need to add the @RequestMapping annotations!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractComponentPresentationController.ResourceNotFoundException

Constructor Summary

Constructors

Constructor and Description
AbstractComponentPresentationController()

Method Summary

Modifier and Type	Method and Description
String	getComponentViewPath()
void	setComponentViewPath(String componentViewPath)
String	showComponentPresentation(String componentViewName, int componentId, javax.servlet.http.HttpServletRequest request) Renders the component/model, which must be put on the request using ComponentUtils.setComponentPresentation(javax.servlet.http.HttpServletRequest, org.dd4t.contentmodel.ComponentPresentation).
String	showComponentPresentation(String componentViewPrefix, String componentViewName, int componentId, javax.servlet.http.HttpServletRequest request) Renders the component template response when a page render occurs, the exact mapping needs to be determined.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComponentPresentationController

public AbstractComponentPresentationController()

Method Detail

showComponentPresentation

public String showComponentPresentation(@PathVariable
                                        String componentViewName,
                                        @PathVariable
                                        int componentId,
                                        javax.servlet.http.HttpServletRequest request)

Renders the component/model, which must be put on the request using ComponentUtils.setComponentPresentation(javax.servlet.http.HttpServletRequest, org.dd4t.contentmodel.ComponentPresentation).

Parameters:

componentViewName - the viewName to be used to render this component

componentId - the id as an int, not a tcm uri!

request - the request on which the component must be present

Returns:

the view name to render

showComponentPresentation

public String showComponentPresentation(@PathVariable
                                        String componentViewPrefix,
                                        @PathVariable
                                        String componentViewName,
                                        @PathVariable
                                        int componentId,
                                        javax.servlet.http.HttpServletRequest request)

Renders the component template response when a page render occurs, the exact mapping needs to be determined. For now, if you use this controller to load DCPs, make sure that the componentViewPrefix variable is actually the publication path, or simply extend this controller and be creative with the ComponentPresentationFactory and resolving Publication Ids

Parameters:

componentViewPrefix - the prefix to use for the view

componentViewName - the viewName to be used to render this component

componentId - the id as an int, not a tcm uri!

request - the request on which the component must be present

Returns:

the view name to render

getComponentViewPath

public String getComponentViewPath()

Returns:

String the component view path

setComponentViewPath

public void setComponentViewPath(String componentViewPath)

Parameters:

componentViewPath - , sets the component view path relative to the view resolver path