uPortal 2.4.1
API Documentation

org.jasig.portal.channels
Class CApplet

java.lang.Object
  extended byorg.jasig.portal.channels.BaseMultithreadedChannel
      extended byorg.jasig.portal.channels.CApplet
All Implemented Interfaces:
IMultithreadedCacheable, IMultithreadedChannel

public class CApplet
extends BaseMultithreadedChannel
implements IMultithreadedCacheable

Displays an applet. To pass in applet parameters, construct channel parameters whose keys start with the string "APPLET."

For example, the key/value pair APPLET.data=foo as a channel parameter is translated to an applet parameter as data=foo

This code was adapted from uPortal 1.0's org.jasig.portal.channels.CApplet

Version:
$Revision: 1.31.2.1 $
Author:
Ken Weiner, kweiner@unicon.net

Constructor Summary
CApplet()
           
 
Method Summary
 ChannelCacheKey generateKey(java.lang.String uid)
          Requests the channel to generate a key uniqly describing it's current state, and a description of key usage.
 boolean isCacheValid(java.lang.Object validity, java.lang.String uid)
          Requests the channel to verify validity of the retreived cache based on the validator object.
 void renderXML(org.xml.sax.ContentHandler out, java.lang.String uid)
          Output channel content to the portal
 
Methods inherited from class org.jasig.portal.channels.BaseMultithreadedChannel
getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CApplet

public CApplet()
Method Detail

renderXML

public void renderXML(org.xml.sax.ContentHandler out,
                      java.lang.String uid)
               throws PortalException
Output channel content to the portal

Specified by:
renderXML in interface IMultithreadedChannel
Overrides:
renderXML in class BaseMultithreadedChannel
Parameters:
out - a sax document handler
uid - a unique ID used to identify the state of the channel
Throws:
PortalException

generateKey

public ChannelCacheKey generateKey(java.lang.String uid)
Description copied from interface: IMultithreadedCacheable
Requests the channel to generate a key uniqly describing it's current state, and a description of key usage.

Specified by:
generateKey in interface IMultithreadedCacheable

isCacheValid

public boolean isCacheValid(java.lang.Object validity,
                            java.lang.String uid)
Description copied from interface: IMultithreadedCacheable
Requests the channel to verify validity of the retreived cache based on the validator object.

Specified by:
isCacheValid in interface IMultithreadedCacheable

uPortal 2.4.1
API Documentation