org.jasig.portal.layout.dlm.channels.guide
Class DlmIntroChannel

java.lang.Object
  org.jasig.portal.channels.CAbstractXslt
      org.jasig.portal.layout.dlm.channels.guide.DlmIntroChannel

All Implemented Interfaces:

ICacheable, IChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class DlmIntroChannel
extends CAbstractXslt
implements ICacheable

A simple channel for introducing the capabilities of DLM in the portal. This channel gets its content from a file, "dlmIntro.html", included with the channel's source.

Author:

mboyd@sungardsct.com

Field Summary

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

log

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

DlmIntroChannel()
Deprecated.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Return our cache key which is a system cache key so all users share the same output and it never changes meaning that it never regenerates.
protected Map	getStylesheetParams() Deprecated. Get a Map from parameter names to parameter values for parameters to be passed to the XSLT.
protected Document	getXml() Deprecated. Get the Document we should feed to our XSLT.
protected String	getXsltUri() Deprecated. Get the URI whereat we can obtain the XSLT we should use to render.
boolean	isCacheValid(Object validity) Deprecated. Requests the channel to verify validity of the retrieved cache based on the validator object.
void	receiveEvent(PortalEvent ev) Deprecated. Passes an outside event to a channel.
protected void	runtimeDataSet() Deprecated. Sets up the base media URL if not done already and determines which section is desired by the user if any.

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

getRuntimeData, getRuntimeProperties, getStaticData, renderXML, setRuntimeData, setStaticData, staticDataSet

Methods inherited from class java.lang.Object

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

Constructor Detail

DlmIntroChannel

public DlmIntroChannel()

Deprecated.

Method Detail

generateKey

public ChannelCacheKey generateKey()

Deprecated.

Return our cache key which is a system cache key so all users share the same output and it never changes meaning that it never regenerates.

Specified by:

generateKey in interface ICacheable

See Also:

ICacheable.generateKey()

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

runtimeDataSet

protected void runtimeDataSet()
                       throws PortalException

Deprecated.

Sets up the base media URL if not done already and determines which section is desired by the user if any.

Overrides:

runtimeDataSet in class CAbstractXslt

Throws:

PortalException

receiveEvent

public void receiveEvent(PortalEvent ev)

Deprecated.

Description copied from interface: IChannel

Passes an outside event to a channel. Events should normally come from the LayoutBean.

Specified by:

receiveEvent in interface IChannel

Parameters:

ev - PortalEvent object

See Also:

PortalEvent

getStylesheetParams

protected Map getStylesheetParams()
                           throws Exception

Deprecated.

Description copied from class: CAbstractXslt

Get a Map from parameter names to parameter values for parameters to be passed to the XSLT. Returning null is equivalent to returning an empty map and will not be considered an error condition by the renderXML() implementation. This method is declared to throw Exception for maximum convenience of the developer extending this class. Such developers should catch or declare exceptions as appropriate to your needs. Just because you can throw Exception here doesn't mean you shouldn't, for example, fallback to default XSLT parameters when you cannot programmatically determine some or all of your XSLT parameters. Or, if you have a very channel-specific UI you want to render on failure, you might pass parameters to your XSLT characterizing the failure and let your XSLT render the response. There's likely no reason for you to wrap IOExceptions if you're not going to do anything other than what this abstract class does with them (logs them and wraps them in PortalExceptions). The method invoking this template method, renderXML(), is declared to throw PortalException by the IChannel API. Any PortalException or RuntimeException thrown by getStylesheetParams() will be thrown all the way out of the abstract class's renderXML() method. This approach ensures that developers extending this class retain control over what exceptions their implementions throw. Note that you can map particular exceptions to particular XML representations and thus particular CError displays as of uPortal 2.5. Exceptions that are neither RuntimeExceptions nor PortalExceptions thrown by this method will be logged and wrapped in PortalExceptions so that this channel will conform to the IChannel API.

Specified by:

getStylesheetParams in class CAbstractXslt

Returns:

a Map from parameter names to parameter values, or null (equivalent to empty Map).

Throws:

Exception - including PortalException or any RuntimeException on failure.

getXml

protected Document getXml()
                   throws Exception

Deprecated.

Description copied from class: CAbstractXslt

Get the Document we should feed to our XSLT. This method is declared to throw Exception for maximum convenience of the developer extending this class. Such developers should catch or declare exceptions as appropriate to your needs. Just because you can throw Exception here doesn't mean you shouldn't, for example, fallback to a default XSLT URL when your cannot programmatically determine the URL of your XSLT. On the other hand, there's no reason for you to wrap SqlExceptions if you're not going to do anything other than what this abstract class does with them (logs them and wraps them in PortalExceptions). The method invoking this template method, renderXML(), is declared to throw PortalException by the IChannel API. Any PortalException or RuntimeException thrown by getXsltUri() will be thrown all the way out of the abstract class's renderXML() method. This approach ensures that developers extending this class retain control over what exceptions their implementions throw. Note that you can map particular exceptions to particular XML representations and thus particular CError displays as of uPortal 2.5. Exceptions that are neither RuntimeExceptions nor PortalExceptions thrown by this method will be logged and wrapped in PortalExceptions so that this channel will conform to the IChannel API. Implementations of this method should not return null. When this method returns null, renderXML() throws an IllegalStateException.

Specified by:

getXml in class CAbstractXslt

Returns:

the Document we should feed to our XSLT.

Throws:

Exception - including PortalException or any RuntimeException on failure

getXsltUri

protected String getXsltUri()
                     throws Exception

Deprecated.

Description copied from class: CAbstractXslt

Get the URI whereat we can obtain the XSLT we should use to render. This method is declared to throw Exception for maximum convenience of the developer extending this class. Such developers should catch or declare exceptions as appropriate to your needs. Just because you can throw Exception here doesn't mean you shouldn't, for example, fallback to a default XSLT URL when your cannot programmatically determine the URL of your XSLT. On the other hand, there's no reason for you to wrap SqlExceptions if you're not going to do anything other than what this abstract class does with them (logs them and wraps them in PortalExceptions). The method invoking this template method, renderXML(), is declared to throw PortalException by the IChannel API. Any PortalException or RuntimeException thrown by getXsltUri() will be thrown all the way out of the abstract class's renderXML() method. This approach ensures that developers extending this class retain control over what exceptions their implementions throw. Note that you can map particular exceptions to particular XML representations and thus particular CError displays as of uPortal 2.5. Exceptions that are neither RuntimeExceptions nor PortalExceptions thrown by this method will be logged and wrapped in PortalExceptions so that this channel will conform to the IChannel API. Implementations of this method should not return null. The behavior of this class when this method returns null is currently undefined. The current implementation is to throw IllegalStateException. However, it might be an interesting improvement to make the meaning of returning null here be to perform no transformation and just dump the XML to the ContentHandler.

Specified by:

getXsltUri in class CAbstractXslt

Returns:

URI of the XSLT to use to render the channel

Throws:

Exception - including PortalException or any RuntimeException on failure