org.jasig.portal.channels.jsp
Class Channel

java.lang.Object
  org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.jsp.Channel

All Implemented Interfaces:

ICacheable, IChannel, ICharacterChannel, IDirectResponse, IPrivileged, IPrivilegedChannel

Direct Known Subclasses:

ServantChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class Channel
extends BaseChannel
implements ICacheable, ICharacterChannel, IPrivilegedChannel, IDirectResponse

Author:

Mark Boyd

Field Summary

static Object	CAR_DEPLOYMENT Deprecated.
protected IController	mController Deprecated.
protected String	mControllerClassname Deprecated.
static Object	TRADITIONAL_DEPLOYMENT Deprecated.

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

Channel()
Deprecated. Default constructor used by Channel Manager to instiate this channel.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Return a cache key for indicating if cached output is stale.
boolean	isCacheValid(Object validity) Deprecated. Indicate whether cached output is still valid for the passed in validity object.
void	receiveEvent(PortalEvent ev) Deprecated. Passes an outside event to a channel.
void	renderCharacters(PrintWriter pw) Deprecated. Asks the channel to render its content as characters.
void	setPortalControlStructures(PortalControlStructures pcs) Deprecated. Extracts the HttpServletRequest, HttpServletResponse, and HttpSession for use in delegated JSPs.
void	setResponse(HttpServletResponse response) Deprecated. Serves up any type of file to the browser as dictated by the controller if the controller supports IDirectResponse.
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, renderXML, toString

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, renderXML

Field Detail

mControllerClassname

protected String mControllerClassname

Deprecated.

mController

protected IController mController

Deprecated.

CAR_DEPLOYMENT

public static final Object CAR_DEPLOYMENT

Deprecated.

TRADITIONAL_DEPLOYMENT

public static final Object TRADITIONAL_DEPLOYMENT

Deprecated.

Constructor Detail

Channel

public Channel()

Deprecated.

Default constructor used by Channel Manager to instiate this channel. This approach delegates to ChannelStaticData to find a property key of "controllerClass" with a value of a class name the implements the IContoller interface.

Method Detail

generateKey

public ChannelCacheKey generateKey()

Deprecated.

Return a cache key for indicating if cached output is stale. This call is delegated to the contained IController which extends ICacheable.

Specified by:

generateKey in interface ICacheable

See Also:

ICacheable.generateKey()

isCacheValid

public boolean isCacheValid(Object validity)

Deprecated.

Indicate whether cached output is still valid for the passed in validity object. The call is delegated to the contained IController which extends ICacheable.

Specified by:

isCacheValid in interface ICacheable

See Also:

ICacheable.isCacheValid(java.lang.Object)

renderCharacters

public void renderCharacters(PrintWriter pw)
                      throws PortalException

Deprecated.

Description copied from interface: ICharacterChannel

Asks the channel to render its content as characters. The method has the same call precedence as the IChannel.renderXML() method. (i.e. if the channel also supports ICacheable, portal will try to find a cache entry prior calling this method)

Specified by:

renderCharacters in interface ICharacterChannel

Parameters:

pw - a PrintWriter value into which the character output should be directed

Throws:

PortalException - if an error occurs

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

Overrides:

receiveEvent in class BaseChannel

Parameters:

ev - PortalEvent object

See Also:

PortalEvent

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

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

setPortalControlStructures

public void setPortalControlStructures(PortalControlStructures pcs)
                                throws PortalException

Deprecated.

Extracts the HttpServletRequest, HttpServletResponse, and HttpSession for use in delegated JSPs.

Specified by:

setPortalControlStructures in interface IPrivileged

Throws:

PortalException

See Also:

IPrivileged.setPortalControlStructures(org.jasig.portal.PortalControlStructures)

setResponse

public void setResponse(HttpServletResponse response)

Deprecated.

Serves up any type of file to the browser as dictated by the controller if the controller supports IDirectResponse.

Specified by:

setResponse in interface IDirectResponse

Parameters:

response - The HttpServletResponse for the channel to use.

See Also:

IDirectResponse.setResponse(javax.servlet.http.HttpServletResponse)