org.apache.jetspeed.modules.actions.portlets
Class JspPortletAction

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.jetspeed.modules.actions.portlets.PortletActionEvent
                  org.apache.jetspeed.modules.actions.portlets.PortletAction
                      org.apache.jetspeed.modules.actions.portlets.GenericMVCAction
                          org.apache.jetspeed.modules.actions.portlets.JspPortletAction

Direct Known Subclasses:

JspStockQuoteAction, QuestionnaireAction, SecureJspPortletAction

public abstract class JspPortletAction

extends GenericMVCAction

An abstract action class to build JspPortlet actions.

Don't call it from the URL, the Portlet and the Action are automatically associated through the registry PortletName

NOTE:This supports the pre-MVC style of template based portlet development and is supplied for backward compatibility. It is suggested you use a combination of

Version:

$Id: JspPortletAction.java,v 1.7 2004/02/23 02:56:58 jford Exp $

Author:

Mark Orciuch, Scott Weaver

See Also:

along with subclassing @see org.apache.jetspeed.portal.portlets.GenericMVCAction for future portlet development.

Field Summary

Fields inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction

logger

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

JspPortletAction()

Method Summary

protected void	buildConfigureContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData rundata) Subclasses should override this method if they wish to provide their own customization behavior.
protected void	buildConfigureContext(Portlet portlet, org.apache.turbine.util.RunData rundata) Kept for backward compatibility.
protected void	buildMaximizedContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData rundata) Subclasses should override this method if they wish to build specific content when maximized.
protected void	buildMaximizedContext(Portlet portlet, org.apache.turbine.util.RunData rundata) Kept for backward compatibility.
protected void	buildNormalContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData data) Subclasses must override this method to provide default behavior for the portlet action
protected abstract void	buildNormalContext(Portlet portlet, org.apache.turbine.util.RunData rundata) Subclasses must override this method to provide default behavior for the portlet action
void	setTemplate(org.apache.turbine.util.RunData data, Portlet portlet, java.lang.String template) Deprecated.

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction

checkAdministrativeAction, doPerform, getAttribute, getAttribute, getPortletInstance, perform, setAttribute

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletAction

doPerform, getContext, getPortlet, getTemplate, resetTemplate, setTemplate, setTemplate

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletActionEvent

executeEvents, fireEvent

Methods inherited from class org.apache.turbine.modules.ActionEvent

executeEvents, formatString

Methods inherited from class java.lang.Object

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

Constructor Detail

JspPortletAction

public JspPortletAction()

Method Detail

buildConfigureContext

protected void buildConfigureContext(Portlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData rundata)
                              throws java.lang.Exception

Description copied from class: GenericMVCAction

Subclasses should override this method if they wish to provide their own customization behavior. Default is to use Portal base customizer action

Overrides:

buildConfigureContext in class GenericMVCAction

Throws:

java.lang.Exception

See Also:

org.apache.jetspeed.portal.portlets.mvc.PortletAction#buildConfigureContext(Portlet, Context, RunData)

buildConfigureContext

protected void buildConfigureContext(Portlet portlet,
                                     org.apache.turbine.util.RunData rundata)
                              throws java.lang.Exception

Kept for backward compatibility. New classes should use the method signatures build*(Portlet, Context, RunData) If you override this method DO NOT call super.buildConfigureContext().
Subclasses should override this method if they wish to provide their own customization behavior. Default is to use Portal base customizer action

Throws:

java.lang.Exception

buildMaximizedContext

protected void buildMaximizedContext(Portlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData rundata)
                              throws java.lang.Exception

Description copied from class: GenericMVCAction

Subclasses should override this method if they wish to build specific content when maximized. Default behavior is to do the same as normal content.

Overrides:

buildMaximizedContext in class GenericMVCAction

Throws:

java.lang.Exception

See Also:

org.apache.jetspeed.portal.portlets.mvc.PortletAction#buildMaximizedContext(Portlet, Context, RunData)

buildMaximizedContext

protected void buildMaximizedContext(Portlet portlet,
                                     org.apache.turbine.util.RunData rundata)
                              throws java.lang.Exception

Kept for backward compatibility. New classes should use the method signatures build*(Portlet, Context, RunData) If you override this method DO NOT call super.buildMaximizedContext().
Subclasses should override this method if they wish to build specific content when maximized. Default behavior is to do the same as normal content.

Throws:

java.lang.Exception

buildNormalContext

protected void buildNormalContext(Portlet portlet,
                                  org.apache.velocity.context.Context context,
                                  org.apache.turbine.util.RunData data)
                           throws java.lang.Exception

Description copied from class: GenericMVCAction

Subclasses must override this method to provide default behavior for the portlet action

Overrides:

buildNormalContext in class GenericMVCAction

Throws:

java.lang.Exception

See Also:

org.apache.jetspeed.portal.portlets.mvc.PortletAction#buildNormalContext(Portlet, Context, RunData)

buildNormalContext

protected abstract void buildNormalContext(Portlet portlet,
                                           org.apache.turbine.util.RunData rundata)
                                    throws java.lang.Exception

Subclasses must override this method to provide default behavior for the portlet action

Throws:

java.lang.Exception

setTemplate

public void setTemplate(org.apache.turbine.util.RunData data,
                        Portlet portlet,
                        java.lang.String template)

Deprecated.

You should use one of PortletAction.setTemplate() methods