com.sun.portal.wireless.providers.containers.jsp.rendering
Class JSPRenderingContainerProvider

java.lang.Object
  extended byJSPContainerProviderAdapter
      extended bycom.sun.portal.wireless.providers.containers.jsp.WirelessJSPContainerProviderAdapter
          extended bycom.sun.portal.wireless.providers.containers.jsp.rendering.JSPRenderingContainerProvider

public class JSPRenderingContainerProvider
extends WirelessJSPContainerProviderAdapter

This class extends WirelessJSPContainerProviderAdapter for the wireless desktop on rendered devices.

See Also:
Serialized Form

Constructor Summary
JSPRenderingContainerProvider()
           
 
Method Summary
 void cleanUpWrappedChannels(ContainerProviderContext cpc)
          This method gets called only in case of authenticated desktop.
 java.lang.StringBuffer getContent(HttpServletRequest req, HttpServletResponse res)
          This method overrides the JSPProvider.getContent() method.
 java.lang.StringBuffer getEdit(HttpServletRequest req, HttpServletResponse res)
          This method overrides the JSPProvider.getEdit() method.
 java.lang.String getMaximizedChannel(HttpServletRequest request)
          Gets the maximized channel specified by this request, or null if none exists, or the channel is not presentable.
 java.util.List getWrappedOrderedSelectedChannels(HttpServletRequest req)
          Gets an ordered list of existing presentable selected channels and movable channel names.
 java.util.List getWrappedOrderedSelectedChannels(HttpServletRequest req, boolean onlyMovable)
          Gets an ordered list of existing presentable selected channels, wrapping any native channels if required.
 void init(java.lang.String name, HttpServletRequest httpReq)
          Initializes this JSPRenderingContainerProvider.
 
Methods inherited from class com.sun.portal.wireless.providers.containers.jsp.WirelessJSPContainerProviderAdapter
downRow, getAvailableChannels, getAvailableChannels, getOrderedSelectedChannels, getOrderedSelectedChannels, getRow, getUserDefinedChannels, getWindowState, hasMaximizedChannel, processContentChannelSelection, upRow
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JSPRenderingContainerProvider

public JSPRenderingContainerProvider()
Method Detail

init

public void init(java.lang.String name,
                 HttpServletRequest httpReq)
          throws ProviderException
Initializes this JSPRenderingContainerProvider.

Parameters:
name - the name
httpReq - the HTTP servlet request
Throws:
ProviderException

getContent

public java.lang.StringBuffer getContent(HttpServletRequest req,
                                         HttpServletResponse res)
                                  throws ProviderException
This method overrides the JSPProvider.getContent() method. It gets the JSP content from JSPProvider, and passes it to the renderContent() method. Based on a few checks, it will either return device specfic markup or AML.

Parameters:
req - An HttpServletRequest that contains information related to this request for content.
res - An HttpServletResponse that allows the provider to influence the overall response for the desktop page (besides generating the content).
Returns:
a StringBuffer holding the channel content that is markup specific or AML.
Throws:
ProviderException - If there was an error generating content.
ProviderException - if there was a problem obtaining content
See Also:
com.sun.portal.providers.jsp.JSPProvider#getContent

getEdit

public java.lang.StringBuffer getEdit(HttpServletRequest req,
                                      HttpServletResponse res)
                               throws ProviderException
This method overrides the JSPProvider.getEdit() method. It gets the JSP edit page content from JSPProvider, and passes it to the renderContent() method. Based on a few checks, it will either return device-specfic markup or AML.

Parameters:
req - An HttpServletRequest that contains information related to this request for content.
res - An HttpServletResponse that allows the provider to influence the overall response for the desktop page
Returns:
StringBuffer that holds the channel edit page, which is markup specific or AML.
Throws:
ProviderException - If there was an error generating content.
See Also:
com.sun.portal.providers.jsp.JSPProvider#getEdit

getWrappedOrderedSelectedChannels

public java.util.List getWrappedOrderedSelectedChannels(HttpServletRequest req,
                                                        boolean onlyMovable)
                                                 throws ProviderException
Gets an ordered list of existing presentable selected channels, wrapping any native channels if required.

Parameters:
req - HttpServletRequest
onlyMovable - should list only include movable channels
Returns:
List ordered existing presentable selected channel names
Throws:
ProviderException - if there was a problem obtaining the list

getWrappedOrderedSelectedChannels

public java.util.List getWrappedOrderedSelectedChannels(HttpServletRequest req)
                                                 throws ProviderException
Gets an ordered list of existing presentable selected channels and movable channel names. Wrap any native channels if required.

Parameters:
req - HttpServletRequest
Returns:
List ordered existing presentable selected channel names
Throws:
ProviderException - if there was a problem obtaining the list

getMaximizedChannel

public java.lang.String getMaximizedChannel(HttpServletRequest request)
                                     throws ProviderException
Gets the maximized channel specified by this request, or null if none exists, or the channel is not presentable.

Overrides:
getMaximizedChannel in class WirelessJSPContainerProviderAdapter
Parameters:
request - the current request
Returns:
the maximized channel
Throws:
ProviderException - if there was a problem obtaining the channel

cleanUpWrappedChannels

public void cleanUpWrappedChannels(ContainerProviderContext cpc)
This method gets called only in case of authenticated desktop. This method removes the wrapped channels for which there are the corresponding native channels have been deleted.

Parameters:
cpc - ContainerProviderContext