uPortal 2.4.1
API Documentation

org.jasig.portal
Class StandaloneChannelRenderer

java.lang.Object
  extended byorg.jasig.portal.channels.BaseChannel
      extended byorg.jasig.portal.StandaloneChannelRenderer
All Implemented Interfaces:
IChannel
Direct Known Subclasses:
CSelectSystemProfile

public class StandaloneChannelRenderer
extends BaseChannel

StandaloneChannelRenderer is meant to be used as a base class for channels that might be rendered outside of the standard user-layout driven scheme. (for example CSelectSystemProfile).

Version:
$Revision: 1.28 $
Author:
Peter Kharchenko

Constructor Summary
StandaloneChannelRenderer()
           
 
Method Summary
 void initialize(java.util.Hashtable params, java.lang.String channelName, boolean hasHelp, boolean hasAbout, boolean hasEdit, long timeOut, IPerson person)
          Initializes the channel and calls setStaticData() on the channel.
 void prepare(javax.servlet.http.HttpServletRequest req)
          This request will cause setRuntimeData() method called on the channel.
 void render(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          This method will output channel content into the HttpServletResponse's out stream.
 
Methods inherited from class org.jasig.portal.channels.BaseChannel
getRuntimeProperties, receiveEvent, renderXML, setRuntimeData, setStaticData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandaloneChannelRenderer

public StandaloneChannelRenderer()
Method Detail

initialize

public void initialize(java.util.Hashtable params,
                       java.lang.String channelName,
                       boolean hasHelp,
                       boolean hasAbout,
                       boolean hasEdit,
                       long timeOut,
                       IPerson person)
                throws PortalException
Initializes the channel and calls setStaticData() on the channel.

Parameters:
params - a hastable of channel publish/subscribe parameters ( elements
channelName - channel name
hasHelp - determines if the channel supports "help" layout event
hasAbout - determines if the channel supports "about" layout event
hasEdit - determines if the channel supports "edit" layout event
timeOut - channel timeout value in milliseconds
person - a user IPerson object
Throws:
PortalException

prepare

public void prepare(javax.servlet.http.HttpServletRequest req)
             throws java.lang.Exception
This request will cause setRuntimeData() method called on the channel. If this method is invoked, the render() method, which usually invokes setRuntimeData() method will omit the call.

Parameters:
req - http request
Throws:
java.lang.Exception

render

public void render(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)
            throws java.lang.Throwable
This method will output channel content into the HttpServletResponse's out stream. Note that setRuntimeData() method is called only if there was no prior call to prepare() method.

Parameters:
req - http request
res - http response
Throws:
java.lang.Throwable

uPortal 2.4.1
API Documentation