AbstractJspBacking Class

com.bea.netuix.servlets.controls.content.backing
AbstractJspBacking Class

public class AbstractJspBacking

    extends Object
    implements JspBacking

Abstract base class for all JSP backing files. This class provides the default implementation for all the methods specified in the JspBacking interface, and provides an additional method to determe if the request was initiated from within this portlet.

A backing file is a simple Java class implementing the JspBacking interface. Backing files work in conjunction with JSPs. The JSPs allow the developer to code the presentation logic, while the backing files allows the developer to code simple business logic. Backing files are always run before the JSPs. A backing file has a lifecycle with four methods (see below). These methods are run 'in order' on all objects. The developer may effect the underlying object from the BackingContext. The BackingContext should be used from the Backing file and the PresentationContext should be used from the JSPs.

Alternately the developer can implement the JspBacking file instead of extending this class.

Related Topics

JspBacking
BackingContext
PortletBackingContext
BookBackingContext
PageBackingContext


Hierarchy
Object
  AbstractJspBacking
All Implemented Interfaces

JspBacking, Serializable

Field Summary

protected static Debug
_debug
Debug
 

Constructor Summary

AbstractJspBacking()

 

Method Summary

public void
dispose()

This method is called at the end of serving the request, after the JSP has rendered.

public boolean
handlePostbackData(HttpServletRequest request, HttpServletResponse response)

The purpose of this method is to let an implementation process request data.

public void
init(HttpServletRequest request, HttpServletResponse response)

This method is called once per request, and backing files can do request-scoped initialization by implementing this method.

protected boolean
isRequestTargeted(HttpServletRequest request)

This method returns true if the current request is due an action within the window/portlet of this backing file.

public boolean
preRender(HttpServletRequest request, HttpServletResponse response)

This method is called before rendering the JSP that this backing file is associated with.

 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface com.bea.netuix.servlets.controls.content.backing.JspBacking
dispose, handlePostbackData, init, preRender
 

Field Detail

_debug

protected static Debug _debug

 

Constructor Detail

AbstractJspBacking

public AbstractJspBacking()
 

Method Detail

dispose() Method

public void dispose()
Description copied from JspBacking.dispose()

This method is called at the end of serving the request, after the JSP has rendered.


handlePostbackData(HttpServletRequest, HttpServletResponse) Method

public boolean handlePostbackData(HttpServletRequest request, 
                                  HttpServletResponse response)
Description copied from JspBacking.handlePostbackData(HttpServletRequest, HttpServletResponse)

The purpose of this method is to let an implementation process request data.

This method should return true if it changes the window mode, window state, or the current page.

Parameters

request
HTTP request
response
HTTP response

Returns

boolean true if the window mode, state, or current page were changed

init(HttpServletRequest, HttpServletResponse) Method

public void init(HttpServletRequest request, 
                 HttpServletResponse response)
Description copied from JspBacking.init(HttpServletRequest, HttpServletResponse)

This method is called once per request, and backing files can do request-scoped initialization by implementing this method. This method is run on the window (book/page/portlet) even if the window is not currently on a selected page.

Parameters

request
HTTP request
response
HTTP response

isRequestTargeted(HttpServletRequest) Method

protected boolean isRequestTargeted(HttpServletRequest request)

This method returns true if the current request is due an action within the window/portlet of this backing file. Returns false otherwise.


preRender(HttpServletRequest, HttpServletResponse) Method

public boolean preRender(HttpServletRequest request, 
                         HttpServletResponse response)
Description copied from JspBacking.preRender(HttpServletRequest, HttpServletResponse)

This method is called before rendering the JSP that this backing file is associated with. This method will not be run if the book/page/portlet is not being rendered (displayed). This is useful if heavy business logic only needs to be run if this portlet is on a selected page.

This method should return true to let the framework render the JSP. If this method returns false, the framework will not render the content JSP.

Note: if you don't want the Window (book, page or portlet) to render at all, call setVisible(false) on the backing context.

Parameters

request
HTTP request
response
HTTP response

Returns

boolean true if the content JSP should be rendered.