org.jasig.portal.channels
Class CSyndFeed

java.lang.Object
  org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.CSyndFeed

All Implemented Interfaces:

ICacheable, IChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class CSyndFeed
extends BaseChannel
implements ICacheable

A channel which renders news feeds in the portal.

Static channel parameters to be supplied: 1) "xmlUri" - URI representing the news feed. RSS and Atom are supported. (See Rome's documentation for specific version information.) 2) "viewNum" - Maximum number of news articles to list. 3) "cacheTimeout" - the amount of time (in seconds) that the contents of the channel should be cached (optional). If this parameter is left out, a default timeout value will be used. 4) "upc_localConnContext" - The class name of the ILocalConnectionContext implementation. Use when local data needs to be sent with the request for the URL. 5) "upc_allow_xmlUri_prefixes" - Optional parameter specifying as a whitespace delimited String the allowable xmlUri prefixes. Defaults to "http:// https://" 6) "upc_deny_xmlUri_prefixes" - Optional parameter specifying as a whitespace delimited String URI prefixes that should block a URI as xmlUri even if it matched one of the allow prefixes. Defaults to "" 7) "restrict_xmlUri_inStaticData" - Optional parameter specifying whether the xmlUri should be restricted according to the allow and deny prefix rules above as presented in ChannelStaticData or just as presented in ChannelRuntimeData. "true" means both ChannelStaticData and ChannelRuntimeData will be restricted. Any other value or the parameter not being present means only ChannelRuntimeData will be restricted. It is important to set this value to true when using subscribe-time channel parameter configuration of the xmlUri.

As of uPortal 2.5.1, the xmlUri must match an allowed URI prefix. By default http:// and https:// URIs are allowed. If you are using the empty document or another XML file from the classpath or from the filesystem, you will need to allow a prefix to or the full path of that resource.

Field Summary

Fields inherited from class org.jasig.portal.channels.BaseChannel

log, runtimeData, staticData

Fields inherited from interface org.jasig.portal.ICacheable

CHANNEL_CACHE_KEY_INSTANCE_SCOPE, CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME, CHANNEL_CACHE_KEY_SYSTEM_SCOPE

Constructor Summary

CSyndFeed()
Deprecated.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Requests the channel to generate a key uniquely describing its current state, and a description of key usage.
boolean	isCacheValid(Object validity) Deprecated. Requests the channel to verify validity of the retrieved cache based on the validator object.
void	renderXML(ContentHandler out) Deprecated. Ask channel to render its content.
void	setRuntimeData(ChannelRuntimeData rd) Deprecated. Passes ChannelRuntimeData to the channel.
void	setStaticData(ChannelStaticData sd) Deprecated. Passes ChannelStaticData to the 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

Constructor Detail

CSyndFeed

public CSyndFeed()

Deprecated.

Method Detail

renderXML

public void renderXML(ContentHandler out)
               throws PortalException

Deprecated.

Description copied from interface: IChannel

Ask channel to render its content.

Specified by:

renderXML in interface IChannel

Overrides:

renderXML in class BaseChannel

Parameters:

out - the SAX ContentHandler to output content to

Throws:

PortalException

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException

Deprecated.

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

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException

Deprecated.

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

generateKey

public ChannelCacheKey generateKey()

Deprecated.

Description copied from interface: ICacheable

Requests the channel to generate a key uniquely describing its current state, and a description of key usage.

Specified by:

generateKey in interface ICacheable

isCacheValid

public boolean isCacheValid(Object validity)

Deprecated.

Description copied from interface: ICacheable

Requests the channel to verify validity of the retrieved cache based on the validator object.

Specified by:

isCacheValid in interface ICacheable