uPortal 2.4.1
API Documentation

org.jasig.portal.channels
Class CSecureInfo

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

public class CSecureInfo
extends BaseChannel
implements IPrivilegedChannel, ICacheable

CSecureInfo is designed to replace channel instances that are required to be rendered securely, yet the request does not warrant it.

CSecureInfo provides information in place of the actual channel content as it relates to rendering channels that are tagged as secure.

The channel is modeled after CError and borrows code from it liberally.

Version:
$Revision: 1.6.2.1 $
Author:
Keith Stacks, kstacks@sct.com

Constructor Summary
CSecureInfo()
           
CSecureInfo(java.lang.String channelSubscribeId, IChannel channelInstance)
           
 
Method Summary
 ChannelCacheKey generateKey()
          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)
          Requests the channel to verify validity of the retreived cache based on the validator object.
 void renderXML(org.xml.sax.ContentHandler out)
          Ask channel to render its content.
 void setPortalControlStructures(PortalControlStructures pcs)
          Passes portal control structure to the channel.
 
Methods inherited from class org.jasig.portal.channels.BaseChannel
getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jasig.portal.IChannel
getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData
 

Constructor Detail

CSecureInfo

public CSecureInfo()

CSecureInfo

public CSecureInfo(java.lang.String channelSubscribeId,
                   IChannel channelInstance)
Method Detail

setPortalControlStructures

public void setPortalControlStructures(PortalControlStructures pcs)
Description copied from interface: IPrivileged
Passes portal control structure to the channel.

Specified by:
setPortalControlStructures in interface IPrivileged
See Also:
PortalControlStructures

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
Description copied from interface: IChannel
Ask channel to render its content.

Specified by:
renderXML in interface IChannel
Overrides:
renderXML in class BaseChannel

generateKey

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

Specified by:
generateKey in interface ICacheable

isCacheValid

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

Specified by:
isCacheValid in interface ICacheable

uPortal 2.4.1
API Documentation