org.jasig.portal.channels.portlet
Interface ISpringPortletChannel

All Known Implementing Classes:

SpringPortletChannelImpl

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface ISpringPortletChannel

Defines a static version of a IChannel that also implements IPortletAdaptor, ICharacterChannel and IPrivilegedChannel, ICacheable.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

void	action(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Handles an action request to the channel.
ChannelCacheKey	generateKey(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Called before isCacheValid(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, Object) and render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter) during the render cycle.
String	getTitle(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Called after render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter), provides the title to display for the channel for this rendering.
void	initSession(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures) Deprecated. Called when a session is created for a user of the channel described by the ChannelStaticData argument.
boolean	isCacheValid(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData, Object validity) Deprecated. Called after generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and before render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter) during the render cycle.
void	portalEvent(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, PortalEvent portalEvent) Deprecated. Notification of a portal event.
void	prepareForRefresh(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Notification that the channel will be refreshed due to an error.
void	prepareForReset(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Notification that the channel will be reset due to an error.
void	render(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData, PrintWriter printWriter) Deprecated. Called after generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter).

Method Detail

initSession

void initSession(ChannelStaticData channelStaticData,
                 PortalControlStructures portalControlStructures)

Deprecated.

Called when a session is created for a user of the channel described by the ChannelStaticData argument.

Parameters:

channelStaticData - The data describing the channel the user session was created for.

portalControlStructures - Information about the current request/response.

generateKey

ChannelCacheKey generateKey(ChannelStaticData channelStaticData,
                            PortalControlStructures portalControlStructures,
                            ChannelRuntimeData channelRuntimeData)

Deprecated.

Called before isCacheValid(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, Object) and render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter) during the render cycle. Responsible for generating a unique key that represents the state of the rendered channel for caching.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

Returns:

A unique key that represents the state of the portlet for the method parameters.

isCacheValid

boolean isCacheValid(ChannelStaticData channelStaticData,
                     PortalControlStructures portalControlStructures,
                     ChannelRuntimeData channelRuntimeData,
                     Object validity)

Deprecated.

Called after generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and before render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter) during the render cycle. The validity object ChannelCacheKey.getKeyValidity() from the previous rendering is passed in to provide a method for this channel to check if it is still valid.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

validity - The validity object from the previous rendering, used to check if the cached state is still valid.

Returns:

true if the cache is still valid, false if not.

render

void render(ChannelStaticData channelStaticData,
            PortalControlStructures portalControlStructures,
            ChannelRuntimeData channelRuntimeData,
            PrintWriter printWriter)

Deprecated.

Called after generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter). The channel should render it's output to the provided PrintWriter and NOT to the response provided by PortalControlStructures.getHttpServletResponse().

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

printWriter - The PrintWriter to write the output of the channel to.

getTitle

String getTitle(ChannelStaticData channelStaticData,
                PortalControlStructures portalControlStructures,
                ChannelRuntimeData channelRuntimeData)

Deprecated.

Called after render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter), provides the title to display for the channel for this rendering.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

Returns:

The title to display for the channel for this rendering, if null is returned the configured title is used.

action

void action(ChannelStaticData channelStaticData,
            PortalControlStructures portalControlStructures,
            ChannelRuntimeData channelRuntimeData)

Deprecated.

Handles an action request to the channel. No content is rendered and no other channel will process an action during this request.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

portalEvent

void portalEvent(ChannelStaticData channelStaticData,
                 PortalControlStructures portalControlStructures,
                 PortalEvent portalEvent)

Deprecated.

Notification of a portal event.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response, not all events are request driven so the control structures may only be partially populated

portalEvent - The portal event.

prepareForRefresh

void prepareForRefresh(ChannelStaticData channelStaticData,
                       PortalControlStructures portalControlStructures,
                       ChannelRuntimeData channelRuntimeData)

Deprecated.

Notification that the channel will be refreshed due to an error. Clean up information about the last request and ensure the channel is in a renderable state

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

prepareForReset

void prepareForReset(ChannelStaticData channelStaticData,
                     PortalControlStructures portalControlStructures,
                     ChannelRuntimeData channelRuntimeData)

Deprecated.

Notification that the channel will be reset due to an error. Clean up information about the last request and all state information.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.