de.mhus.lib.liferay.portlet

Class LiferayMVCPortlet

java.lang.Object

javax.portlet.GenericPortlet

com.liferay.portal.kernel.portlet.LiferayPortlet

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

de.mhus.lib.liferay.portlet.LiferayMVCPortlet

All Implemented Interfaces:

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

public abstract class LiferayMVCPortlet
extends com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

Field Summary

Fields

Modifier and Type	Field and Description
protected de.mhus.lib.portlet.actions.ActionRequestHandler	actionsHandler
static String	INIT_PARAMETER_PUBLIC_VIEW
protected de.mhus.lib.core.logging.Log	log
static String	PUBLIC_PREFIX
static String	REASON_ATTRIBUTE_NAME
protected de.mhus.lib.portlet.resource.ResourceRequestHandler	resourcesHandler
protected boolean	viewNeedParameters Set this to true if the view jsp needs parameters from the request.

Fields inherited from class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

aboutTemplate, clearRequestParameters, configTemplate, copyRequestParameters, editDefaultsTemplate, editGuestTemplate, editTemplate, helpTemplate, previewTemplate, printTemplate, templatePath, viewTemplate

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

addProcessActionSuccessMessage, alwaysSendRedirect, validPaths

Constructor Summary

Constructors

Constructor and Description
LiferayMVCPortlet()

Method Summary

Modifier and Type	Method and Description
void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected boolean	doFillViewAttributes(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Overwrite this method if you need to give attributes to the jsp page.
protected abstract void	doInit()
void	doPublicView(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
void	doView(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
protected String	hasRights(javax.portlet.PortletRequest request) Return a reason why the user is not accepted.
void	init()
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
void	serveResource(javax.portlet.ResourceRequest resourceRequest, javax.portlet.ResourceResponse resourceResponse)

Methods inherited from class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

callActionMethod, callResourceMethod, checkPermissions, destroy, doAbout, doConfig, doDispatch, doEditDefaults, doEditGuest, doHelp, doPreview, doPrint, getMVCPathAttributeName, getPath, hideDefaultErrorMessage, hideDefaultSuccessMessage, include, include, include, include, include, invokeHideDefaultSuccessMessage, invokeTaglibDiscussion, invokeTaglibDiscussionPagination, render

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

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

Methods inherited from class javax.portlet.GenericPortlet

doHeaders, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, init, processEvent

Methods inherited from class java.lang.Object

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

Field Detail

PUBLIC_PREFIX

public static final String PUBLIC_PREFIX

See Also:

Constant Field Values

REASON_ATTRIBUTE_NAME

public static final String REASON_ATTRIBUTE_NAME

See Also:

Constant Field Values

INIT_PARAMETER_PUBLIC_VIEW

public static final String INIT_PARAMETER_PUBLIC_VIEW

See Also:

Constant Field Values

resourcesHandler

protected de.mhus.lib.portlet.resource.ResourceRequestHandler resourcesHandler

actionsHandler

protected de.mhus.lib.portlet.actions.ActionRequestHandler actionsHandler

log

protected de.mhus.lib.core.logging.Log log

viewNeedParameters

protected boolean viewNeedParameters

Set this to true if the view jsp needs parameters from the request.

Constructor Detail

LiferayMVCPortlet

public LiferayMVCPortlet()

Method Detail

init

public void init()
          throws javax.portlet.PortletException

Overrides:

init in class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

Throws:

javax.portlet.PortletException

doInit

protected abstract void doInit()
                        throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

hasRights

protected String hasRights(javax.portlet.PortletRequest request)

Return a reason why the user is not accepted. Return null if the user has rights. Overwrite the method to control access. The access will be controlled for edit mode and view mode. help mode is not affected. Resources and actions, starting with 'public_' will be allowed. Set the init parameter 'public-view-jsp' in the portlet configuration to configure a alternative jsp if access is restricted. The reason from hasRight() will be set in the request as attribute 'reason'. You can access it via JSP EL '${requestScope.reason}'.

Parameters:

request -

Returns:

null by default.

doView

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

Overrides:

doView in class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

Throws:

IOException

javax.portlet.PortletException

doPublicView

public void doPublicView(javax.portlet.RenderRequest renderRequest,
                         javax.portlet.RenderResponse renderResponse)
                  throws IOException,
                         javax.portlet.PortletException

Throws:

IOException

javax.portlet.PortletException

doFillViewAttributes

protected boolean doFillViewAttributes(javax.portlet.RenderRequest request,
                                       javax.portlet.RenderResponse response)
                                throws IOException,
                                       javax.portlet.PortletException

Overwrite this method if you need to give attributes to the jsp page. Alternatively you can cancel or forward the request by manipulating the response. If you want to deny execution of the jsp page, return false. Otherwise return true.

Parameters:

request -

response -

Returns:

true for normal operation, false if no jsp page should be executed

Throws:

IOException

javax.portlet.PortletException

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          IOException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

Throws:

javax.portlet.PortletException

IOException

serveResource

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

Specified by:

serveResource in interface javax.portlet.ResourceServingPortlet

Overrides:

serveResource in class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

Throws:

IOException

javax.portlet.PortletException

doEdit

public void doEdit(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException

Overrides:

doEdit in class com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet

Throws:

javax.portlet.PortletException

IOException