org.jasig.portal.channels.portlet
Class SpringPortletChannelImpl

java.lang.Object
  org.jasig.portal.channels.portlet.SpringPortletChannelImpl

All Implemented Interfaces:

ISpringPortletChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class SpringPortletChannelImpl
extends Object
implements ISpringPortletChannel

Implementation of ISpringPortletChannel that delegates rendering a portlet to the injected PortletContainer. The portlet to render is determined in initSession(ChannelStaticData, PortalControlStructures) using the channel publish and subscribe ids.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

protected org.apache.commons.logging.Log	logger Deprecated.
protected static String	PORTLET_WINDOW_ID_PARAM Deprecated.

Constructor Summary

SpringPortletChannelImpl()
Deprecated.

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 ISpringPortletChannel.isCacheValid(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, Object) and ISpringPortletChannel.render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter) during the render cycle.
protected String	getChannelLogInfo(ChannelStaticData channelStaticData, IPortletWindow portletWindow) Deprecated. Build a 'nice' summary string of relavent ChannelStaticData information
protected org.apache.pluto.descriptors.portlet.PortletDD	getPortletDD(HttpServletRequest httpServletRequest, IPortletWindowId portletWindowId) Deprecated.
IPortletDefinitionRegistry	getPortletDefinitionRegistry() Deprecated.
IPortletEntityRegistry	getPortletEntityRegistry() Deprecated.
IPortletRenderer	getPortletRenderer() Deprecated.
IPortletRequestParameterManager	getPortletRequestParameterManager() Deprecated.
protected IPortletWindowId	getPortletWindowId(ChannelStaticData channelStaticData) Deprecated. Gets the portlet window ID to use for the specified channel static data.
protected IPortletWindowId	getPortletWindowId(ChannelStaticData channelStaticData, ChannelRuntimeData channelRuntimeData, PortalControlStructures pcs) Deprecated.
IPortletWindowRegistry	getPortletWindowRegistry() Deprecated.
String	getTitle(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Called after ISpringPortletChannel.render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter), provides the title to display for the channel for this rendering.
protected String	getWindowInstanceId(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures) Deprecated. Get the id for the window instance described by the channel static data and portal control structures.
protected String	getWindowInstanceId(ChannelStaticData channelStaticData, PortalControlStructures portalControlStructures, ChannelRuntimeData channelRuntimeData) Deprecated. Get the id for the window instance described by the channel static data, portal control structures, and channel runtime data.
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 ISpringPortletChannel.generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and before ISpringPortletChannel.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 ISpringPortletChannel.generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and ISpringPortletChannel.render(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, PrintWriter).
void	setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry) Deprecated.
void	setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry) Deprecated.
void	setPortletRenderer(IPortletRenderer portletRenderer) Deprecated.
void	setPortletRequestParameterManager(IPortletRequestParameterManager portletRequestParameterManager) Deprecated.
protected void	setPortletWidnowId(ChannelStaticData channelStaticData, IPortletWindowId portletWindowId) Deprecated. Sets the portlet window ID to use for the specified channel static data.
void	setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

PORTLET_WINDOW_ID_PARAM

protected static final String PORTLET_WINDOW_ID_PARAM

Deprecated.

logger

protected final org.apache.commons.logging.Log logger

Deprecated.

Constructor Detail

SpringPortletChannelImpl

public SpringPortletChannelImpl()

Deprecated.

Method Detail

getPortletRenderer

public IPortletRenderer getPortletRenderer()

Deprecated.

setPortletRenderer

public void setPortletRenderer(IPortletRenderer portletRenderer)

Deprecated.

getPortletDefinitionRegistry

public IPortletDefinitionRegistry getPortletDefinitionRegistry()

Deprecated.

Returns:

the portletDefinitionRegistry

setPortletDefinitionRegistry

public void setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)

Deprecated.

Parameters:

portletDefinitionRegistry - the portletDefinitionRegistry to set

getPortletEntityRegistry

public IPortletEntityRegistry getPortletEntityRegistry()

Deprecated.

Returns:

the portletEntityRegistry

setPortletEntityRegistry

public void setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)

Deprecated.

Parameters:

portletEntityRegistry - the portletEntityRegistry to set

getPortletWindowRegistry

public IPortletWindowRegistry getPortletWindowRegistry()

Deprecated.

Returns:

the portletWindowRegistry

setPortletWindowRegistry

public void setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)

Deprecated.

Parameters:

portletWindowRegistry - the portletWindowRegistry to set

getPortletRequestParameterManager

public IPortletRequestParameterManager getPortletRequestParameterManager()

Deprecated.

Returns:

the portletRequestParameterManager

setPortletRequestParameterManager

public void setPortletRequestParameterManager(IPortletRequestParameterManager portletRequestParameterManager)

Deprecated.

Parameters:

portletRequestParameterManager - the portletRequestParameterManager to set

getWindowInstanceId

protected String getWindowInstanceId(ChannelStaticData channelStaticData,
                                     PortalControlStructures portalControlStructures)

Deprecated.

Get the id for the window instance described by the channel static data and portal control structures.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/reponse.

Returns:

The window instance id.

getWindowInstanceId

protected String getWindowInstanceId(ChannelStaticData channelStaticData,
                                     PortalControlStructures portalControlStructures,
                                     ChannelRuntimeData channelRuntimeData)

Deprecated.

Get the id for the window instance described by the channel static data, portal control structures, and channel runtime data.

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/reponse.

channelRuntimeData - Portal provided information for the current request.

Returns:

The window instance id.

setPortletWidnowId

protected void setPortletWidnowId(ChannelStaticData channelStaticData,
                                  IPortletWindowId portletWindowId)

Deprecated.

Sets the portlet window ID to use for the specified channel static data.

Parameters:

channelStaticData - The static description data for the channel.

portletWindowId - The ID to associate with the static data.

getPortletWindowId

protected IPortletWindowId getPortletWindowId(ChannelStaticData channelStaticData)

Deprecated.

Gets the portlet window ID to use for the specified channel static data.

Parameters:

channelStaticData - The static description data for the channel.

Returns:

The ID associated with the static data, will not be null.

getPortletWindowId

protected IPortletWindowId getPortletWindowId(ChannelStaticData channelStaticData,
                                              ChannelRuntimeData channelRuntimeData,
                                              PortalControlStructures pcs)

Deprecated.

initSession

public void initSession(ChannelStaticData channelStaticData,
                        PortalControlStructures portalControlStructures)

Deprecated.

Description copied from interface: ISpringPortletChannel

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

Specified by:

initSession in interface ISpringPortletChannel

Parameters:

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

portalControlStructures - Information about the current request/response.

action

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

Deprecated.

Description copied from interface: ISpringPortletChannel

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

Specified by:

action in interface ISpringPortletChannel

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

generateKey

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

Deprecated.

Description copied from interface: ISpringPortletChannel

Called before ISpringPortletChannel.isCacheValid(ChannelStaticData, PortalControlStructures, ChannelRuntimeData, Object) and ISpringPortletChannel.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.

Specified by:

generateKey in interface ISpringPortletChannel

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

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

Deprecated.

Description copied from interface: ISpringPortletChannel

Called after ISpringPortletChannel.generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and before ISpringPortletChannel.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.

Specified by:

isCacheValid in interface ISpringPortletChannel

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.

getPortletDD

protected org.apache.pluto.descriptors.portlet.PortletDD getPortletDD(HttpServletRequest httpServletRequest,
                                                                      IPortletWindowId portletWindowId)
                                                               throws org.apache.pluto.PortletContainerException

Deprecated.

Throws:

org.apache.pluto.PortletContainerException

render

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

Deprecated.

Description copied from interface: ISpringPortletChannel

Called after ISpringPortletChannel.generateKey(ChannelStaticData, PortalControlStructures, ChannelRuntimeData) and ISpringPortletChannel.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().

Specified by:

render in interface ISpringPortletChannel

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

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

Deprecated.

Description copied from interface: ISpringPortletChannel

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

Specified by:

getTitle in interface ISpringPortletChannel

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.

portalEvent

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

Deprecated.

Description copied from interface: ISpringPortletChannel

Notification of a portal event.

Specified by:

portalEvent in interface ISpringPortletChannel

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

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

Deprecated.

Description copied from interface: ISpringPortletChannel

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

Specified by:

prepareForRefresh in interface ISpringPortletChannel

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

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

Deprecated.

Description copied from interface: ISpringPortletChannel

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

Specified by:

prepareForReset in interface ISpringPortletChannel

Parameters:

channelStaticData - The static description data for the channel.

portalControlStructures - Information about the current request/response.

channelRuntimeData - Portal provided information for the current request.

getChannelLogInfo

protected String getChannelLogInfo(ChannelStaticData channelStaticData,
                                   IPortletWindow portletWindow)

Deprecated.

Build a 'nice' summary string of relavent ChannelStaticData information