uPortal 2.4.1
API Documentation

org.jasig.portal.channels
Class CSnoop

java.lang.Object
  extended byorg.jasig.portal.channels.CSnoop
All Implemented Interfaces:
IChannel, IPrivileged, IPrivilegedChannel

public class CSnoop
extends java.lang.Object
implements IPrivilegedChannel

A channel which displays HTTP request and HTML header info. This channel implements IPrivilegedChannel rather than IChannel because it needs access to the HttpServletRequest object.

This channel was partially developed at Columbia University as an exercise.

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

Constructor Summary
CSnoop()
          No-argument constructor for CSnoop.
 
Method Summary
 ChannelRuntimeProperties getRuntimeProperties()
          Returns channel runtime properties.
 void receiveEvent(PortalEvent ev)
          Processes layout-level events coming from the portal
 void renderXML(org.xml.sax.ContentHandler out)
          Output channel content to the portal
 void setPortalControlStructures(PortalControlStructures pcs)
          Sends portal control structures to the portal, i.e.
 void setRuntimeData(ChannelRuntimeData rd)
          Receives channel runtime data from the portal and processes actions passed to it.
 void setStaticData(ChannelStaticData sd)
          Receive static channel data from the portal
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CSnoop

public CSnoop()
No-argument constructor for CSnoop.

Method Detail

setPortalControlStructures

public void setPortalControlStructures(PortalControlStructures pcs)
Sends portal control structures to the portal, i.e. HttpServletRequest, HttpServletResponse, UserPreferencesManager, etc.

Specified by:
setPortalControlStructures in interface IPrivileged
Parameters:
pcs - the portal control structures
See Also:
PortalControlStructures

getRuntimeProperties

public ChannelRuntimeProperties getRuntimeProperties()
Returns channel runtime properties.

Specified by:
getRuntimeProperties in interface IChannel
Returns:
handle to runtime properties
See Also:
ChannelRuntimeProperties

receiveEvent

public void receiveEvent(PortalEvent ev)
Processes layout-level events coming from the portal

Specified by:
receiveEvent in interface IChannel
Parameters:
ev - a portal layout event
See Also:
PortalEvent

setStaticData

public void setStaticData(ChannelStaticData sd)
Receive static channel data from the portal

Specified by:
setStaticData in interface IChannel
Parameters:
sd - static channel data
See Also:
ChannelStaticData

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)
Receives channel runtime data from the portal and processes actions passed to it. The names of these parameters are entirely up to the channel.

Specified by:
setRuntimeData in interface IChannel
Parameters:
rd - handle to channel runtime data
See Also:
ChannelRuntimeData

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws PortalException
Output channel content to the portal

Specified by:
renderXML in interface IChannel
Parameters:
out - a sax document handler
Throws:
PortalException

uPortal 2.4.1
API Documentation