com.liferay.portletmvc4spring.mvc

Class ParameterizableViewController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

com.liferay.portletmvc4spring.context.PortletApplicationObjectSupport

com.liferay.portletmvc4spring.handler.PortletContentGenerator

com.liferay.portletmvc4spring.mvc.AbstractController

com.liferay.portletmvc4spring.mvc.ParameterizableViewController

All Implemented Interfaces:

PortletContextAware, Controller, Aware, ApplicationContextAware

public class ParameterizableViewController
extends AbstractController

Trivial controller that always returns a named view. The view can be configured using an exposed configuration property. This controller offers an alternative to sending a request straight to a view such as a JSP. The advantage here is that the client is not exposed to the concrete view technology but rather just to the controller URL; the concrete view will be determined by the ViewResolver.

Workflow (and that defined by superclass):

1. Render request is received by the controller
2. call to handleRenderRequestInternal which just returns the view, named by the configuration property viewName.

This controller does not handle action requests.

Exposed configuration properties (and those defined by superclass):

name	default	description
viewName	null	the name of the view the viewResolver will use to forward to (if this property is not set, an exception will be thrown during initialization)

Since:

2.0

Author:

John A. Lewis

Field Summary

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
ParameterizableViewController()

Method Summary

Modifier and Type	Method and Description
String	getViewName() Return the name of the view to delegate to.
protected ModelAndView	handleRenderRequestInternal(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Return a ModelAndView object with the specified view name.
protected void	initApplicationContext()
void	setViewName(String viewName) Set the name of the view to delegate to.

Methods inherited from class com.liferay.portletmvc4spring.mvc.AbstractController

handleActionRequest, handleActionRequestInternal, handleRenderRequest, isRenderWhenMinimized, isSynchronizeOnSession, setRenderWhenMinimized, setSynchronizeOnSession

Methods inherited from class com.liferay.portletmvc4spring.handler.PortletContentGenerator

applyCacheSeconds, cacheForSeconds, check, checkAndPrepare, checkAndPrepare, getCacheSeconds, isRequireSession, preventCaching, setCacheSeconds, setRequireSession

Methods inherited from class com.liferay.portletmvc4spring.context.PortletApplicationObjectSupport

getPortletContext, getTempDir, isContextRequired, setPortletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizableViewController

public ParameterizableViewController()

Method Detail

getViewName

public String getViewName()

Return the name of the view to delegate to.

setViewName

public void setViewName(String viewName)

Set the name of the view to delegate to.

handleRenderRequestInternal

protected ModelAndView handleRenderRequestInternal(javax.portlet.RenderRequest request,
                                                   javax.portlet.RenderResponse response)
                                            throws Exception

Return a ModelAndView object with the specified view name.

Overrides:

handleRenderRequestInternal in class AbstractController

Throws:

Exception

See Also:

AbstractController.handleRenderRequest(javax.portlet.RenderRequest, javax.portlet.RenderResponse), AbstractController.handleActionRequestInternal(javax.portlet.ActionRequest, javax.portlet.ActionResponse)

initApplicationContext

protected void initApplicationContext()

Overrides:

initApplicationContext in class ApplicationObjectSupport