org.apache.portals.bridges.frameworks
Class GenericFrameworkPortlet

java.lang.Object
  extended by javax.portlet.GenericPortlet
      extended by org.apache.portals.bridges.common.GenericServletPortlet
          extended by org.apache.portals.bridges.velocity.GenericVelocityPortlet
              extended by org.apache.portals.bridges.frameworks.GenericFrameworkPortlet
All Implemented Interfaces:
javax.portlet.Portlet, javax.portlet.PortletConfig
Direct Known Subclasses:
VelocityFrameworkPortlet

public class GenericFrameworkPortlet
extends org.apache.portals.bridges.velocity.GenericVelocityPortlet

SpringVelocityPortlet

Version:
$Id: GenericFrameworkPortlet.java,v 1.1 2004/11/04 18:09:33 taylor Exp $
Author:
David Sean Taylor

Field Summary
 
Fields inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet
PORTLET_BRIDGE_CONTEXT
 
Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet
PARAM_ACTION_PAGE, PARAM_ALLOW_PREFERENCES, PARAM_CUSTOM_PAGE, PARAM_EDIT_PAGE, PARAM_HELP_PAGE, PARAM_MAX_PAGE, PARAM_VIEW_PAGE
 
Constructor Summary
GenericFrameworkPortlet()
           
 
Method Summary
protected  java.lang.String determineLogicalView(javax.portlet.PortletRequest request)
          Get the current logical view based on velocity.view request parameter If the request parameter is not found, fall back to init param
 void doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
 void doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
protected  void doRender(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
 void doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
protected  java.lang.Object formToBean(javax.portlet.ActionRequest request, java.lang.String view, ModelBean mb)
           
protected  java.lang.Object formToPrefs(javax.portlet.ActionRequest request, java.lang.String view, ModelBean mb)
           
protected  void forwardToView(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, java.lang.String forward)
           
 void init(javax.portlet.PortletConfig config)
           
protected  java.lang.String invokeVelocityPortletAction(java.lang.String methodName, javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, java.lang.Object bean)
          Invokes a specific Velocity Portlet Action All portlet actions must have the signature: String methodName(ActionRequest request, ActionResponse response)
 void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
          Invoke the velocity portlet pipeline: (1) determine the logical view (2) restore state from Form to Bean (3) validate the bean -- or -- (2) restore state from Form to Prefs (4) execute the velocity action (5) forward to another view
protected  void putRequestVariable(javax.portlet.RenderRequest request, java.lang.String name, java.lang.Object value)
          Specific for Velocity
 void setExternalSupport(java.util.Map map)
           
protected  void setLogicalView(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String view, javax.portlet.PortletMode newMode)
           
 void startNewRecord(javax.portlet.PortletRequest request, java.lang.String view)
           
protected  void storePreferences(javax.portlet.PortletRequest request, java.util.Map bean)
           
 
Methods inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet
doCustom, doPreferencesEdit, getContext, getContext, render, setupPreferencesEdit
 
Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet
getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage
 
Methods inherited from class javax.portlet.GenericPortlet
destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenericFrameworkPortlet

public GenericFrameworkPortlet()
Method Detail

setExternalSupport

public void setExternalSupport(java.util.Map map)

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException
Specified by:
init in interface javax.portlet.Portlet
Overrides:
init in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          java.io.IOException
Invoke the velocity portlet pipeline: (1) determine the logical view (2) restore state from Form to Bean (3) validate the bean -- or -- (2) restore state from Form to Prefs (4) execute the velocity action (5) forward to another view

Specified by:
processAction in interface javax.portlet.Portlet
Overrides:
processAction in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException

forwardToView

protected void forwardToView(javax.portlet.ActionRequest request,
                             javax.portlet.ActionResponse response,
                             java.lang.String forward)

storePreferences

protected void storePreferences(javax.portlet.PortletRequest request,
                                java.util.Map bean)
                         throws java.io.IOException,
                                javax.portlet.PortletException
Throws:
java.io.IOException
javax.portlet.PortletException

determineLogicalView

protected java.lang.String determineLogicalView(javax.portlet.PortletRequest request)
                                         throws javax.portlet.PortletException
Get the current logical view based on velocity.view request parameter If the request parameter is not found, fall back to init param

Parameters:
request -
Returns:
the current view
Throws:
javax.portlet.PortletException

setLogicalView

protected void setLogicalView(javax.portlet.PortletRequest request,
                              javax.portlet.PortletResponse response,
                              java.lang.String view,
                              javax.portlet.PortletMode newMode)

formToBean

protected java.lang.Object formToBean(javax.portlet.ActionRequest request,
                                      java.lang.String view,
                                      ModelBean mb)
                               throws javax.portlet.PortletException
Throws:
javax.portlet.PortletException

formToPrefs

protected java.lang.Object formToPrefs(javax.portlet.ActionRequest request,
                                       java.lang.String view,
                                       ModelBean mb)
                                throws javax.portlet.PortletException
Throws:
javax.portlet.PortletException

invokeVelocityPortletAction

protected java.lang.String invokeVelocityPortletAction(java.lang.String methodName,
                                                       javax.portlet.ActionRequest request,
                                                       javax.portlet.ActionResponse response,
                                                       java.lang.Object bean)
                                                throws javax.portlet.PortletException
Invokes a specific Velocity Portlet Action All portlet actions must have the signature: String methodName(ActionRequest request, ActionResponse response)

Parameters:
methodName -
Throws:
javax.portlet.PortletException

doView

public void doView(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException
Overrides:
doView in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException

doHelp

public void doHelp(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException
Overrides:
doHelp in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException

doEdit

public void doEdit(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException
Overrides:
doEdit in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException

doRender

protected void doRender(javax.portlet.RenderRequest request,
                        javax.portlet.RenderResponse response)
                 throws javax.portlet.PortletException,
                        java.io.IOException
Throws:
javax.portlet.PortletException
java.io.IOException

startNewRecord

public void startNewRecord(javax.portlet.PortletRequest request,
                           java.lang.String view)

putRequestVariable

protected void putRequestVariable(javax.portlet.RenderRequest request,
                                  java.lang.String name,
                                  java.lang.Object value)
Specific for Velocity

Parameters:
name -
value -


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.