com.liferay.portal.kernel.portlet.bridges.mvc

Class MVCPortlet

Object

javax.portlet.GenericPortlet

com.liferay.portal.kernel.portlet.LiferayPortlet

com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

All Implemented Interfaces:

EventPortlet, HeaderPortlet, Portlet, PortletConfig, ResourceServingPortlet

public class MVCPortlet
extends LiferayPortlet

Author:

Brian Wing Shun Chan, Raymond Augé

Field Summary

Fields

Modifier and Type	Field and Description
protected String	aboutTemplate
protected boolean	clearRequestParameters
protected String	configTemplate
protected boolean	copyRequestParameters
protected String	editDefaultsTemplate
protected String	editGuestTemplate
protected String	editTemplate
protected String	helpTemplate
protected String	previewTemplate
protected String	printTemplate
protected String	templatePath
protected String	viewTemplate

Fields inherited from class com.liferay.portal.kernel.portlet.LiferayPortlet

addProcessActionSuccessMessage, alwaysSendRedirect, validPaths

Fields inherited from class javax.portlet.GenericPortlet

AUTOMATIC_RESOURCE_DISPATCH

Constructor Summary

Constructors

Constructor and Description
MVCPortlet()

Method Summary

Modifier and Type	Method and Description
protected boolean	callActionMethod(ActionRequest actionRequest, ActionResponse actionResponse)
protected boolean	callResourceMethod(ResourceRequest resourceRequest, ResourceResponse resourceResponse)
protected void	checkPermissions(PortletRequest portletRequest)
void	destroy()
void	doAbout(RenderRequest renderRequest, RenderResponse renderResponse)
void	doConfig(RenderRequest renderRequest, RenderResponse renderResponse)
protected void	doDispatch(RenderRequest renderRequest, RenderResponse renderResponse)
void	doEdit(RenderRequest renderRequest, RenderResponse renderResponse)
void	doEditDefaults(RenderRequest renderRequest, RenderResponse renderResponse)
void	doEditGuest(RenderRequest renderRequest, RenderResponse renderResponse)
void	doHelp(RenderRequest renderRequest, RenderResponse renderResponse)
void	doPreview(RenderRequest renderRequest, RenderResponse renderResponse)
void	doPrint(RenderRequest renderRequest, RenderResponse renderResponse)
void	doView(RenderRequest renderRequest, RenderResponse renderResponse)
protected MVCCommandCache<MVCActionCommand>	getActionMVCCommandCache()
protected String	getMVCPathAttributeName(String namespace)
protected String	getPath(PortletRequest portletRequest, PortletResponse portletResponse)
protected MVCCommandCache<MVCRenderCommand>	getRenderMVCCommandCache()
protected MVCCommandCache<MVCResourceCommand>	getResourceMVCCommandCache()
protected void	hideDefaultErrorMessage(PortletRequest portletRequest)
protected void	hideDefaultSuccessMessage(PortletRequest portletRequest)
protected void	include(String path, ActionRequest actionRequest, ActionResponse actionResponse)
protected void	include(String path, EventRequest eventRequest, EventResponse eventResponse)
protected void	include(String path, PortletRequest portletRequest, PortletResponse portletResponse, String lifecycle)
protected void	include(String path, RenderRequest renderRequest, RenderResponse renderResponse)
protected void	include(String path, ResourceRequest resourceRequest, ResourceResponse resourceResponse)
void	init()
protected void	invokeHideDefaultSuccessMessage(PortletRequest portletRequest)
void	invokeTaglibDiscussion(ActionRequest actionRequest, ActionResponse actionResponse) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
void	invokeTaglibDiscussionPagination(ResourceRequest resourceRequest, ResourceResponse resourceResponse) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
void	processAction(ActionRequest actionRequest, ActionResponse actionResponse)
void	render(RenderRequest renderRequest, RenderResponse renderResponse)
void	serveResource(ResourceRequest resourceRequest, ResourceResponse resourceResponse)

Methods inherited from class com.liferay.portal.kernel.portlet.LiferayPortlet

addSuccessMessage, checkPath, getActionMethod, getJSONContentType, getPaths, getRedirect, getResourceMethod, getServletContext, getTitle, initValidPaths, isAddSuccessMessage, isAlwaysSendRedirect, isEmptySessionMessages, isProcessActionRequest, isProcessPortletRequest, isProcessRenderRequest, isProcessResourceRequest, isSessionErrorException, isValidPath, sendRedirect, translate, translate, writeJSON, writeJSON

Methods inherited from class javax.portlet.GenericPortlet

dispatchAnnotatedActionMethod, dispatchAnnotatedEventMethod, dispatchAnnotatedRenderMethod, doHeaders, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletModes, getPortletName, getProcessingEventQNames, getPublicRenderParameterDefinitions, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getWindowStates, init, processEvent, renderHeaders

Methods inherited from class Object

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

Field Detail

aboutTemplate

protected String aboutTemplate

clearRequestParameters

protected boolean clearRequestParameters

configTemplate

protected String configTemplate

copyRequestParameters

protected boolean copyRequestParameters

editDefaultsTemplate

protected String editDefaultsTemplate

editGuestTemplate

protected String editGuestTemplate

editTemplate

protected String editTemplate

helpTemplate

protected String helpTemplate

previewTemplate

protected String previewTemplate

printTemplate

protected String printTemplate

templatePath

protected String templatePath

viewTemplate

protected String viewTemplate

Constructor Detail

MVCPortlet

public MVCPortlet()

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface Portlet

Overrides:

destroy in class GenericPortlet

doAbout

public void doAbout(RenderRequest renderRequest,
                    RenderResponse renderResponse)
             throws IOException,
                    PortletException

Overrides:

doAbout in class LiferayPortlet

Throws:

IOException

PortletException

doConfig

public void doConfig(RenderRequest renderRequest,
                     RenderResponse renderResponse)
              throws IOException,
                     PortletException

Overrides:

doConfig in class LiferayPortlet

Throws:

IOException

PortletException

doEdit

public void doEdit(RenderRequest renderRequest,
                   RenderResponse renderResponse)
            throws IOException,
                   PortletException

Overrides:

doEdit in class GenericPortlet

Throws:

IOException

PortletException

doEditDefaults

public void doEditDefaults(RenderRequest renderRequest,
                           RenderResponse renderResponse)
                    throws IOException,
                           PortletException

Overrides:

doEditDefaults in class LiferayPortlet

Throws:

IOException

PortletException

doEditGuest

public void doEditGuest(RenderRequest renderRequest,
                        RenderResponse renderResponse)
                 throws IOException,
                        PortletException

Overrides:

doEditGuest in class LiferayPortlet

Throws:

IOException

PortletException

doHelp

public void doHelp(RenderRequest renderRequest,
                   RenderResponse renderResponse)
            throws IOException,
                   PortletException

Overrides:

doHelp in class GenericPortlet

Throws:

IOException

PortletException

doPreview

public void doPreview(RenderRequest renderRequest,
                      RenderResponse renderResponse)
               throws IOException,
                      PortletException

Overrides:

doPreview in class LiferayPortlet

Throws:

IOException

PortletException

doPrint

public void doPrint(RenderRequest renderRequest,
                    RenderResponse renderResponse)
             throws IOException,
                    PortletException

Overrides:

doPrint in class LiferayPortlet

Throws:

IOException

PortletException

doView

public void doView(RenderRequest renderRequest,
                   RenderResponse renderResponse)
            throws IOException,
                   PortletException

Overrides:

doView in class GenericPortlet

Throws:

IOException

PortletException

init

public void init()
          throws PortletException

Overrides:

init in class LiferayPortlet

Throws:

PortletException

invokeTaglibDiscussion

@Deprecated
public void invokeTaglibDiscussion(ActionRequest actionRequest,
                                               ActionResponse actionResponse)
                                        throws Exception

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

Exception

invokeTaglibDiscussionPagination

@Deprecated
public void invokeTaglibDiscussionPagination(ResourceRequest resourceRequest,
                                                         ResourceResponse resourceResponse)
                                                  throws IOException,
                                                         PortletException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

IOException

PortletException

processAction

public void processAction(ActionRequest actionRequest,
                          ActionResponse actionResponse)
                   throws IOException,
                          PortletException

Specified by:

processAction in interface Portlet

Overrides:

processAction in class LiferayPortlet

Throws:

IOException

PortletException

render

public void render(RenderRequest renderRequest,
                   RenderResponse renderResponse)
            throws IOException,
                   PortletException

Specified by:

render in interface Portlet

Overrides:

render in class GenericPortlet

Throws:

IOException

PortletException

serveResource

public void serveResource(ResourceRequest resourceRequest,
                          ResourceResponse resourceResponse)
                   throws IOException,
                          PortletException

Specified by:

serveResource in interface ResourceServingPortlet

Overrides:

serveResource in class LiferayPortlet

Throws:

IOException

PortletException

callActionMethod

protected boolean callActionMethod(ActionRequest actionRequest,
                                   ActionResponse actionResponse)
                            throws PortletException

Overrides:

callActionMethod in class LiferayPortlet

Throws:

PortletException

callResourceMethod

protected boolean callResourceMethod(ResourceRequest resourceRequest,
                                     ResourceResponse resourceResponse)
                              throws PortletException

Overrides:

callResourceMethod in class LiferayPortlet

Throws:

PortletException

checkPermissions

protected void checkPermissions(PortletRequest portletRequest)
                         throws Exception

Throws:

Exception

doDispatch

protected void doDispatch(RenderRequest renderRequest,
                          RenderResponse renderResponse)
                   throws IOException,
                          PortletException

Overrides:

doDispatch in class LiferayPortlet

Throws:

IOException

PortletException

getActionMVCCommandCache

protected MVCCommandCache<MVCActionCommand> getActionMVCCommandCache()

getMVCPathAttributeName

protected String getMVCPathAttributeName(String namespace)

getPath

protected String getPath(PortletRequest portletRequest,
                         PortletResponse portletResponse)

getRenderMVCCommandCache

protected MVCCommandCache<MVCRenderCommand> getRenderMVCCommandCache()

getResourceMVCCommandCache

protected MVCCommandCache<MVCResourceCommand> getResourceMVCCommandCache()

hideDefaultErrorMessage

protected void hideDefaultErrorMessage(PortletRequest portletRequest)

hideDefaultSuccessMessage

protected void hideDefaultSuccessMessage(PortletRequest portletRequest)

include

protected void include(String path,
                       ActionRequest actionRequest,
                       ActionResponse actionResponse)
                throws IOException,
                       PortletException

Throws:

IOException

PortletException

include

protected void include(String path,
                       EventRequest eventRequest,
                       EventResponse eventResponse)
                throws IOException,
                       PortletException

Throws:

IOException

PortletException

include

protected void include(String path,
                       PortletRequest portletRequest,
                       PortletResponse portletResponse,
                       String lifecycle)
                throws IOException,
                       PortletException

Throws:

IOException

PortletException

include

protected void include(String path,
                       RenderRequest renderRequest,
                       RenderResponse renderResponse)
                throws IOException,
                       PortletException

Throws:

IOException

PortletException

include

protected void include(String path,
                       ResourceRequest resourceRequest,
                       ResourceResponse resourceResponse)
                throws IOException,
                       PortletException

Throws:

IOException

PortletException

invokeHideDefaultSuccessMessage

protected void invokeHideDefaultSuccessMessage(PortletRequest portletRequest)