com.liferay.portal.kernel.portlet

Class LiferayPortlet

java.lang.Object

javax.portlet.GenericPortlet

com.liferay.portal.kernel.portlet.LiferayPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.HeaderPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

Direct Known Subclasses:

MVCPortlet, SettingsConfigurationAction

public class LiferayPortlet
extends javax.portlet.GenericPortlet

Author:

Brian Wing Shun Chan

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addProcessActionSuccessMessage
protected boolean	alwaysSendRedirect
protected java.util.Set<java.lang.String>	validPaths

Constructor Summary

Constructors

Constructor and Description
LiferayPortlet()

Method Summary

Modifier and Type	Method and Description
protected void	addSuccessMessage(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected boolean	callActionMethod(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected boolean	callResourceMethod(javax.portlet.ResourceRequest resourceRequest, javax.portlet.ResourceResponse resourceResponse)
protected void	checkPath(java.lang.String path)
protected void	doAbout(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	doConfig(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	doDispatch(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	doEditDefaults(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	doEditGuest(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	doPreview(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected void	doPrint(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected java.lang.reflect.Method	getActionMethod(java.lang.String actionName)
protected java.lang.String	getJSONContentType(javax.portlet.PortletRequest portletRequest)
protected java.util.Set<java.lang.String>	getPaths(java.lang.String path, java.lang.String extension)
protected java.lang.String	getRedirect(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected java.lang.reflect.Method	getResourceMethod(java.lang.String actionName)
protected javax.servlet.ServletContext	getServletContext()
protected java.lang.String	getTitle(javax.portlet.RenderRequest renderRequest)
void	init()
protected void	initValidPaths(java.lang.String rootPath, java.lang.String extension)
protected boolean	isAddSuccessMessage(javax.portlet.ActionRequest actionRequest)
protected boolean	isAlwaysSendRedirect()
protected boolean	isEmptySessionMessages(javax.portlet.ActionRequest actionRequest)
protected boolean	isProcessActionRequest(javax.portlet.ActionRequest actionRequest)
protected boolean	isProcessPortletRequest(javax.portlet.PortletRequest portletRequest)
protected boolean	isProcessRenderRequest(javax.portlet.RenderRequest renderRequest)
protected boolean	isProcessResourceRequest(javax.portlet.ResourceRequest resourceRequest)
protected boolean	isSessionErrorException(java.lang.Throwable cause)
protected boolean	isValidPath(java.lang.String path)
void	processAction(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
protected void	sendRedirect(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
void	serveResource(javax.portlet.ResourceRequest resourceRequest, javax.portlet.ResourceResponse resourceResponse)
protected java.lang.String	translate(javax.portlet.PortletRequest portletRequest, java.lang.String key)
protected java.lang.String	translate(javax.portlet.PortletRequest portletRequest, java.lang.String key, java.lang.Object... arguments)
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 javax.portlet.GenericPortlet

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

Methods inherited from class java.lang.Object

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

Field Detail

addProcessActionSuccessMessage

protected boolean addProcessActionSuccessMessage

alwaysSendRedirect

protected boolean alwaysSendRedirect

validPaths

protected java.util.Set<java.lang.String> validPaths

Constructor Detail

LiferayPortlet

public LiferayPortlet()

Method Detail

init

public void init()
          throws javax.portlet.PortletException

Overrides:

init in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

processAction

public void processAction(javax.portlet.ActionRequest actionRequest,
                          javax.portlet.ActionResponse actionResponse)
                   throws java.io.IOException,
                          javax.portlet.PortletException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class javax.portlet.GenericPortlet

Throws:

java.io.IOException

javax.portlet.PortletException

serveResource

public void serveResource(javax.portlet.ResourceRequest resourceRequest,
                          javax.portlet.ResourceResponse resourceResponse)
                   throws java.io.IOException,
                          javax.portlet.PortletException

Specified by:

serveResource in interface javax.portlet.ResourceServingPortlet

Overrides:

serveResource in class javax.portlet.GenericPortlet

Throws:

java.io.IOException

javax.portlet.PortletException

addSuccessMessage

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

callActionMethod

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

Throws:

javax.portlet.PortletException

callResourceMethod

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

Throws:

javax.portlet.PortletException

checkPath

protected void checkPath(java.lang.String path)
                  throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

doAbout

protected void doAbout(javax.portlet.RenderRequest renderRequest,
                       javax.portlet.RenderResponse renderResponse)
                throws java.io.IOException,
                       javax.portlet.PortletException

Throws:

java.io.IOException

javax.portlet.PortletException

doConfig

protected void doConfig(javax.portlet.RenderRequest renderRequest,
                        javax.portlet.RenderResponse renderResponse)
                 throws java.io.IOException,
                        javax.portlet.PortletException

Throws:

java.io.IOException

javax.portlet.PortletException

doDispatch

protected void doDispatch(javax.portlet.RenderRequest renderRequest,
                          javax.portlet.RenderResponse renderResponse)
                   throws java.io.IOException,
                          javax.portlet.PortletException

Overrides:

doDispatch in class javax.portlet.GenericPortlet

Throws:

java.io.IOException

javax.portlet.PortletException

doEditDefaults

protected void doEditDefaults(javax.portlet.RenderRequest renderRequest,
                              javax.portlet.RenderResponse renderResponse)
                       throws java.io.IOException,
                              javax.portlet.PortletException

Throws:

java.io.IOException

javax.portlet.PortletException

doEditGuest

protected void doEditGuest(javax.portlet.RenderRequest renderRequest,
                           javax.portlet.RenderResponse renderResponse)
                    throws java.io.IOException,
                           javax.portlet.PortletException

Throws:

java.io.IOException

javax.portlet.PortletException

doPreview

protected void doPreview(javax.portlet.RenderRequest renderRequest,
                         javax.portlet.RenderResponse renderResponse)
                  throws java.io.IOException,
                         javax.portlet.PortletException

Throws:

java.io.IOException

javax.portlet.PortletException

doPrint

protected void doPrint(javax.portlet.RenderRequest renderRequest,
                       javax.portlet.RenderResponse renderResponse)
                throws java.io.IOException,
                       javax.portlet.PortletException

Throws:

java.io.IOException

javax.portlet.PortletException

getActionMethod

protected java.lang.reflect.Method getActionMethod(java.lang.String actionName)
                                            throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getJSONContentType

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

getPaths

protected java.util.Set<java.lang.String> getPaths(java.lang.String path,
                                                   java.lang.String extension)

getRedirect

protected java.lang.String getRedirect(javax.portlet.ActionRequest actionRequest,
                                       javax.portlet.ActionResponse actionResponse)

getResourceMethod

protected java.lang.reflect.Method getResourceMethod(java.lang.String actionName)
                                              throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getServletContext

protected javax.servlet.ServletContext getServletContext()

getTitle

protected java.lang.String getTitle(javax.portlet.RenderRequest renderRequest)

Overrides:

getTitle in class javax.portlet.GenericPortlet

initValidPaths

protected void initValidPaths(java.lang.String rootPath,
                              java.lang.String extension)

isAddSuccessMessage

protected boolean isAddSuccessMessage(javax.portlet.ActionRequest actionRequest)

isAlwaysSendRedirect

protected boolean isAlwaysSendRedirect()

isEmptySessionMessages

protected boolean isEmptySessionMessages(javax.portlet.ActionRequest actionRequest)

isProcessActionRequest

protected boolean isProcessActionRequest(javax.portlet.ActionRequest actionRequest)

isProcessPortletRequest

protected boolean isProcessPortletRequest(javax.portlet.PortletRequest portletRequest)

isProcessRenderRequest

protected boolean isProcessRenderRequest(javax.portlet.RenderRequest renderRequest)

isProcessResourceRequest

protected boolean isProcessResourceRequest(javax.portlet.ResourceRequest resourceRequest)

isSessionErrorException

protected boolean isSessionErrorException(java.lang.Throwable cause)

isValidPath

protected boolean isValidPath(java.lang.String path)

sendRedirect

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

Throws:

java.io.IOException

translate

protected java.lang.String translate(javax.portlet.PortletRequest portletRequest,
                                     java.lang.String key)

translate

protected java.lang.String translate(javax.portlet.PortletRequest portletRequest,
                                     java.lang.String key,
                                     java.lang.Object... arguments)

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