com.liferay.portal.struts

Class PortletAction

java.lang.Object

org.apache.struts.action.Action

com.liferay.portal.struts.PortletAction

Direct Known Subclasses:

PortletActionAdapter, RSSAction

public class PortletAction
extends org.apache.struts.action.Action

Author:

Brian Wing Shun Chan

See Also:

BaseMVCActionCommand

Field Summary

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
PortletAction()

Method Summary

Modifier and Type	Method and Description
protected void	addSuccessMessage(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping actionMapping, org.apache.struts.action.ActionForm actionForm, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected java.lang.String	getForward(javax.portlet.PortletRequest portletRequest)
protected java.lang.String	getForward(javax.portlet.PortletRequest portletRequest, java.lang.String defaultValue)
static java.lang.String	getForwardKey(javax.servlet.http.HttpServletRequest request)
static java.lang.String	getForwardKey(javax.portlet.PortletRequest portletRequest)
protected org.apache.struts.config.ModuleConfig	getModuleConfig(javax.portlet.PortletRequest portletRequest)
protected org.apache.struts.util.MessageResources	getResources()
protected org.apache.struts.util.MessageResources	getResources(javax.servlet.http.HttpServletRequest request)
protected org.apache.struts.util.MessageResources	getResources(javax.portlet.PortletRequest portletRequest)
protected javax.portlet.PortletPreferences	getStrictPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId)
protected javax.portlet.PortletPreferences	getStrictPortletSetup(javax.portlet.PortletRequest portletRequest)
protected void	hideDefaultErrorMessage(javax.portlet.PortletRequest portletRequest)
protected void	hideDefaultSuccessMessage(javax.portlet.PortletRequest portletRequest)
protected boolean	isCheckMethodOnProcessAction()
protected boolean	isDisplaySuccessMessage(javax.portlet.PortletRequest portletRequest)
void	processAction(org.apache.struts.action.ActionMapping actionMapping, org.apache.struts.action.ActionForm actionForm, javax.portlet.PortletConfig portletConfig, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
void	processEvent(org.apache.struts.action.ActionMapping actionMapping, org.apache.struts.action.ActionForm actionForm, javax.portlet.PortletConfig portletConfig, javax.portlet.EventRequest eventRequest, javax.portlet.EventResponse eventResponse)
protected boolean	redirectToLogin(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
org.apache.struts.action.ActionForward	render(org.apache.struts.action.ActionMapping actionMapping, org.apache.struts.action.ActionForm actionForm, javax.portlet.PortletConfig portletConfig, javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	sendRedirect(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected void	sendRedirect(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse, java.lang.String redirect)
protected void	sendRedirect(javax.portlet.PortletConfig portletConfig, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse, java.lang.String redirect, java.lang.String closeRedirect)
void	serveResource(org.apache.struts.action.ActionMapping actionMapping, org.apache.struts.action.ActionForm actionForm, javax.portlet.PortletConfig portletConfig, javax.portlet.ResourceRequest resourceRequest, javax.portlet.ResourceResponse resourceResponse)
protected void	setForward(javax.portlet.PortletRequest portletRequest, java.lang.String forward)
org.apache.struts.action.ActionForward	strutsExecute(org.apache.struts.action.ActionMapping actionMapping, org.apache.struts.action.ActionForm actionForm, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	writeJSON(javax.portlet.PortletRequest portletRequest, javax.portlet.ActionResponse actionResponse, java.lang.Object jsonObj)
protected void	writeJSON(javax.portlet.PortletRequest portletRequest, javax.portlet.MimeResponse mimeResponse, java.lang.Object jsonObj)

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletAction

public PortletAction()

Method Detail

getForwardKey

public static java.lang.String getForwardKey(javax.servlet.http.HttpServletRequest request)

getForwardKey

public static java.lang.String getForwardKey(javax.portlet.PortletRequest portletRequest)

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping actionMapping,
                                                      org.apache.struts.action.ActionForm actionForm,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws java.lang.Exception

Overrides:

execute in class org.apache.struts.action.Action

Throws:

java.lang.Exception

processAction

public void processAction(org.apache.struts.action.ActionMapping actionMapping,
                          org.apache.struts.action.ActionForm actionForm,
                          javax.portlet.PortletConfig portletConfig,
                          javax.portlet.ActionRequest actionRequest,
                          javax.portlet.ActionResponse actionResponse)
                   throws java.lang.Exception

Throws:

java.lang.Exception

processEvent

public void processEvent(org.apache.struts.action.ActionMapping actionMapping,
                         org.apache.struts.action.ActionForm actionForm,
                         javax.portlet.PortletConfig portletConfig,
                         javax.portlet.EventRequest eventRequest,
                         javax.portlet.EventResponse eventResponse)
                  throws java.lang.Exception

Throws:

java.lang.Exception

render

public org.apache.struts.action.ActionForward render(org.apache.struts.action.ActionMapping actionMapping,
                                                     org.apache.struts.action.ActionForm actionForm,
                                                     javax.portlet.PortletConfig portletConfig,
                                                     javax.portlet.RenderRequest renderRequest,
                                                     javax.portlet.RenderResponse renderResponse)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

serveResource

public void serveResource(org.apache.struts.action.ActionMapping actionMapping,
                          org.apache.struts.action.ActionForm actionForm,
                          javax.portlet.PortletConfig portletConfig,
                          javax.portlet.ResourceRequest resourceRequest,
                          javax.portlet.ResourceResponse resourceResponse)
                   throws java.lang.Exception

Throws:

java.lang.Exception

strutsExecute

public org.apache.struts.action.ActionForward strutsExecute(org.apache.struts.action.ActionMapping actionMapping,
                                                            org.apache.struts.action.ActionForm actionForm,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

addSuccessMessage

protected void addSuccessMessage(javax.portlet.ActionRequest actionRequest,
                                 javax.portlet.ActionResponse actionResponse)

getForward

protected java.lang.String getForward(javax.portlet.PortletRequest portletRequest)

getForward

protected java.lang.String getForward(javax.portlet.PortletRequest portletRequest,
                                      java.lang.String defaultValue)

getModuleConfig

protected org.apache.struts.config.ModuleConfig getModuleConfig(javax.portlet.PortletRequest portletRequest)

getResources

protected org.apache.struts.util.MessageResources getResources()

getResources

protected org.apache.struts.util.MessageResources getResources(javax.servlet.http.HttpServletRequest request)

Overrides:

getResources in class org.apache.struts.action.Action

getResources

protected org.apache.struts.util.MessageResources getResources(javax.portlet.PortletRequest portletRequest)

getStrictPortletSetup

protected javax.portlet.PortletPreferences getStrictPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                                 java.lang.String portletId)
                                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getStrictPortletSetup

protected javax.portlet.PortletPreferences getStrictPortletSetup(javax.portlet.PortletRequest portletRequest)
                                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

hideDefaultErrorMessage

protected void hideDefaultErrorMessage(javax.portlet.PortletRequest portletRequest)

hideDefaultSuccessMessage

protected void hideDefaultSuccessMessage(javax.portlet.PortletRequest portletRequest)

isCheckMethodOnProcessAction

protected boolean isCheckMethodOnProcessAction()

isDisplaySuccessMessage

protected boolean isDisplaySuccessMessage(javax.portlet.PortletRequest portletRequest)

redirectToLogin

protected boolean redirectToLogin(javax.portlet.ActionRequest actionRequest,
                                  javax.portlet.ActionResponse actionResponse)
                           throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

protected void sendRedirect(javax.portlet.ActionRequest actionRequest,
                            javax.portlet.ActionResponse actionResponse)
                     throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

protected void sendRedirect(javax.portlet.ActionRequest actionRequest,
                            javax.portlet.ActionResponse actionResponse,
                            java.lang.String redirect)
                     throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

protected void sendRedirect(javax.portlet.PortletConfig portletConfig,
                            javax.portlet.ActionRequest actionRequest,
                            javax.portlet.ActionResponse actionResponse,
                            java.lang.String redirect,
                            java.lang.String closeRedirect)
                     throws java.io.IOException

Throws:

java.io.IOException

setForward

protected void setForward(javax.portlet.PortletRequest portletRequest,
                          java.lang.String forward)

writeJSON

protected void writeJSON(javax.portlet.PortletRequest portletRequest,
                         javax.portlet.ActionResponse actionResponse,
                         java.lang.Object jsonObj)
                  throws java.io.IOException

Throws:

java.io.IOException

writeJSON

protected void writeJSON(javax.portlet.PortletRequest portletRequest,
                         javax.portlet.MimeResponse mimeResponse,
                         java.lang.Object jsonObj)
                  throws java.io.IOException

Throws:

java.io.IOException