org.jasig.portal.channels
Class CGenericXSLT

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

All Implemented Interfaces:

ICacheable, IChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class CGenericXSLT
extends BaseChannel
implements IChannel, ICacheable

A channel which transforms XML for rendering in the portal.

Static channel parameters to be supplied:

1. "xmlUri" - a URI representing the source XML document
2. "sslUri" - a URI representing the corresponding .ssl (stylesheet list) file
3. "xslTitle" - a title representing the stylesheet (optional) If no title parameter is specified, a default stylesheet will be chosen according to the media
4. "xslUri" - a URI representing the stylesheet to use If xslUri is supplied, sslUri and xslTitle will be ignored.
5. "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.
6. "cacheScope" - the desired scope for caching channel responses. Defaults to "instance" indicating that cache is per-channel-instance-per-user. Cache will not match across users. This is typically desirable to prevent user A from seeing user B's data. Alternately, this parameter may be set to "system" indicating that caching should occur across the entire portal such that two different users' instances of like-configured CGenericXSLT channels will share cache.
7. "upc_localConnContext" - The class name of the ILocalConnectionContext implementation. Use when local data needs to be sent with the request for the URL.
8. "upc_allow_xmlUri_prefixes" - Optional parameter specifying as a whitespace delimited String the allowable xmlUri prefixes. Defaults to "http:// https://"
9. "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 ""
10. "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.
11. "cacheGlobalMode" - should content be cached globally May be false (normally don't globally cache), or true (cache everything).

The xmlUri and xslTitle static parameters above can be overridden by including parameters of the same name (xmlUri and/or xslTitle) in the HttpRequest string. Prior to uPortal 2.5.1 sslUri and xslUri could also be overridden -- these features have been removed to improve the security of CGenericXSLT instances.

Additionally, 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.

This channel can be used for all XML formats including RSS. Any other parameters passed to this channel via HttpRequest will get passed in turn to the XSLT stylesheet as stylesheet parameters. They can be read in the stylesheet as follows: <xsl:param name="yourParamName">aDefaultValue</xsl:param>

CGenericXSLT is also useful for channels that have no dynamic data. In these types of channels, all the markup comes from the XSLT stylesheets. An empty XML document can be used and is included with CGenericXSLT. Just set the xml parameter to this empty document and allow the path to the empty document.

Version:

$Revision: 19776 $

Author:

Steve Toth, stoth@interactivebusiness.com, Ken Weiner, kweiner@unicon.net, Peter Kharchenko pkharchenko@unicon.net

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

CGenericXSLT()
Deprecated.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Requests the channel to generate a key uniquely describing its current state, and a description of key usage.
Document	getCacheContent(String key) Deprecated.
long	getCacheContentLoaded() Deprecated.
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	setCacheContent(String key, Document data) Deprecated. Storing cache data is straigt-forward.
void	setRuntimeData(ChannelRuntimeData rd) Deprecated. Passes ChannelRuntimeData to the channel.
void	setStaticData(ChannelStaticData sd) Deprecated. Passes ChannelStaticData to the channel.
String	toString() Deprecated.

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

getRuntimeProperties, receiveEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jasig.portal.IChannel

getRuntimeProperties, receiveEvent

Constructor Detail

CGenericXSLT

public CGenericXSLT()

Deprecated.

Method Detail

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws ResourceMissingException

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:

ResourceMissingException

See Also:

ChannelStaticData

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)

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

See Also:

ChannelRuntimeData

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

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

toString

public String toString()

Deprecated.

Overrides:

toString in class BaseChannel

setCacheContent

public void setCacheContent(String key,
                            Document data)

Deprecated.

Storing cache data is straigt-forward. We rely on the cache implementation to remove data as it ages AND only allow a maximum amount of data into the structure.

Parameters:

key - the URL key String

data - our cache data as a String or Document Object

getCacheContent

public Document getCacheContent(String key)

Deprecated.

getCacheContentLoaded

public long getCacheContentLoaded()

Deprecated.