org.jasig.portal.channels.iccdemo
Class CHistory

java.lang.Object
  extended by org.jasig.portal.channels.BaseChannel
      extended by org.jasig.portal.channels.iccdemo.CHistory
All Implemented Interfaces:
IChannel

public class CHistory
extends BaseChannel

A channel showing a list of history URLs, as a part of the inter-channel communication demo.

Version:
$Revision: 1.11 $
Author:
Peter Kharchenko

Field Summary
private static org.apache.commons.logging.Log log
           
private  boolean passExternally
           
(package private)  HistoryRecord records
           
private static java.lang.String sslLocation
           
private static java.lang.String urlselectorFname
           
private static java.lang.String viewerFname
           
 
Fields inherited from class org.jasig.portal.channels.BaseChannel
runtimeData, staticData
 
Constructor Summary
CHistory()
           
 
Method Summary
private  java.lang.Object getBoundObject(java.lang.String channelSubscribeId)
          A utility method to determine an object bound to the "chan-obj" branch for a particular channel id.
private  java.lang.String getChannelId(java.lang.String fname)
          A utility method for obtaining a channelSubscribeId given a channel fname
private  org.w3c.dom.Document getUserXML()
           
 void renderXML(org.xml.sax.ContentHandler out)
          Render method.
 void setRuntimeData(ChannelRuntimeData rd)
          Passes ChannelRuntimeData to the channel.
 void setStaticData(ChannelStaticData sd)
          Passes ChannelStaticData to the channel.
private  void setViewerURL(java.lang.String url)
          A utility method that communicates the new url to the viewer channel
 
Methods inherited from class org.jasig.portal.channels.BaseChannel
getRuntimeProperties, receiveEvent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

private static final org.apache.commons.logging.Log log

sslLocation

private static final java.lang.String sslLocation
See Also:
Constant Field Values

viewerFname

private static final java.lang.String viewerFname
See Also:
Constant Field Values

urlselectorFname

private static final java.lang.String urlselectorFname
See Also:
Constant Field Values

passExternally

private boolean passExternally

records

HistoryRecord records
Constructor Detail

CHistory

public CHistory()
Method Detail

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException
Description copied from interface: IChannel
Passes ChannelStaticData to the channel. This is done during channel instantiation time. see org.jasig.portal.ChannelStaticData

Specified by:
setStaticData in interface IChannel
Overrides:
setStaticData in class BaseChannel
Parameters:
sd - channel static data
Throws:
PortalException
See Also:
ChannelStaticData

getUserXML

private org.w3c.dom.Document getUserXML()

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException
Description copied from interface: IChannel
Passes ChannelRuntimeData to the channel. This function is called prior to the renderXML() call.

Specified by:
setRuntimeData in interface IChannel
Overrides:
setRuntimeData in class BaseChannel
Parameters:
rd - channel runtime data
Throws:
PortalException
See Also:
ChannelRuntimeData

setViewerURL

private void setViewerURL(java.lang.String url)
A utility method that communicates the new url to the viewer channel

Parameters:
url - a String value

getChannelId

private java.lang.String getChannelId(java.lang.String fname)
A utility method for obtaining a channelSubscribeId given a channel fname

Parameters:
fname - a String value
Returns:
channel's subscribe id, or null if no channel with given fname was found

getBoundObject

private java.lang.Object getBoundObject(java.lang.String channelSubscribeId)
A utility method to determine an object bound to the "chan-obj" branch for a particular channel id.

Parameters:
channelSubscribeId - a String value of the channel who's object we're looking for
Returns:
an Object value bound to that jndi location (or null if channel didn't bind anything)

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws PortalException
Render method.

Specified by:
renderXML in interface IChannel
Overrides:
renderXML in class BaseChannel
Parameters:
out - the content handler
Throws:
PortalException