org.jasig.portal.channels.portlet
Class CSpringPortletAdaptor

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

All Implemented Interfaces:

IPortletAdaptor, ICacheable, IChannel, ICharacterChannel, IDirectResponse, IPrivileged, IPrivilegedChannel, IResetableChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class CSpringPortletAdaptor
extends Object
implements IPortletAdaptor

An attempt at a channel that can wrap a singleton spring-configured ISpringPortletChannel instance and delegate execution to. This class simply must maintain the instance data and pass it on to the ISpringPortletChannel for each method. The channel gets the name of the ISpringPortletChannel bean to use from the parameter named 'springBeanName' using the SPRING_BEAN_NAME_PARAM constant. This class also attempts to eagerly clean up session & request scoped resources at the end of each 'lifecycle' set of calls.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

static String	DEFAULT_SPRING_BEAN_NAME Deprecated.
protected org.apache.commons.logging.Log	logger Deprecated.
static String	SPRING_BEAN_NAME_PARAM Deprecated.

Fields inherited from interface org.jasig.portal.channels.portlet.IPortletAdaptor

ABOUT, ATTRIBUTE__PORTLET_TITLE, ATTRIBUTE__RUNTIME_DATA, CHANNEL_PARAM__IS_FRAMEWORK_PORTLET, CHANNEL_PARAM__PORTLET_APPLICATION_ID, CHANNEL_PARAM__PORTLET_NAME, CONFIG, DETACHED, EXCLUSIVE, MULTIVALUED_USERINFO_MAP_ATTRIBUTE

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

CSpringPortletAdaptor()
Deprecated.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Requests the channel to generate a key uniquely describing its current state, and a description of key usage.
ChannelRuntimeProperties	getRuntimeProperties() Deprecated. Acquires ChannelRuntimeProperites from the channel.
boolean	isCacheValid(Object validity) Deprecated. Requests the channel to verify validity of the retrieved cache based on the validator object.
void	prepareForRefresh() Deprecated. Prepare to be refereshed after an error.
void	prepareForReset() Deprecated. Prepare to be reset after an error.
void	processAction() Deprecated. IChannel.setStaticData(org.jasig.portal.ChannelStaticData), IPrivileged.setPortalControlStructures(org.jasig.portal.PortalControlStructures), and IChannel.setRuntimeData(org.jasig.portal.ChannelRuntimeData) will be called before this method.
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	renderXML(ContentHandler out) Deprecated. Ask channel to render its content.
void	setPortalControlStructures(PortalControlStructures pcs) Deprecated. Passes portal control structure to the channel.
void	setResponse(HttpServletResponse response) Deprecated. Sets the HttpServletResponse for the channel to use.
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 java.lang.Object

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

Field Detail

SPRING_BEAN_NAME_PARAM

public static final String SPRING_BEAN_NAME_PARAM

Deprecated.

See Also:

Constant Field Values

DEFAULT_SPRING_BEAN_NAME

public static final String DEFAULT_SPRING_BEAN_NAME

Deprecated.

See Also:

Constant Field Values

logger

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

Deprecated.

Constructor Detail

CSpringPortletAdaptor

public CSpringPortletAdaptor()

Deprecated.

Method Detail

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

Parameters:

sd - channel static data

Throws:

PortalException

See Also:

ChannelStaticData

setPortalControlStructures

public void setPortalControlStructures(PortalControlStructures pcs)
                                throws PortalException

Deprecated.

Description copied from interface: IPrivileged

Passes portal control structure to the channel.

Specified by:

setPortalControlStructures in interface IPrivileged

Throws:

PortalException

See Also:

PortalControlStructures

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

Parameters:

rd - channel runtime data

Throws:

PortalException

See Also:

ChannelRuntimeData

processAction

public void processAction()
                   throws PortalException

Deprecated.

Description copied from interface: IPortletAdaptor

IChannel.setStaticData(org.jasig.portal.ChannelStaticData), IPrivileged.setPortalControlStructures(org.jasig.portal.PortalControlStructures), and IChannel.setRuntimeData(org.jasig.portal.ChannelRuntimeData) will be called before this method. Actions are executed before the layout rendering pipeline is initiated and redirects can be sent though content can not be written out to the response. Only one channel will execute a processAction per request.

Specified by:

processAction in interface IPortletAdaptor

Throws:

PortalException - If an exception occurs while processing the action.

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

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

getRuntimeProperties

public ChannelRuntimeProperties getRuntimeProperties()

Deprecated.

Description copied from interface: IChannel

Acquires ChannelRuntimeProperites from the channel. This function may be called by the portal framework throughout the session.

Specified by:

getRuntimeProperties in interface IChannel

See Also:

ChannelRuntimeProperties

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

prepareForRefresh

public void prepareForRefresh()

Deprecated.

Description copied from interface: IResetableChannel

Prepare to be refereshed after an error. Information about the last request should be cleared and the channel should be in a renderable state when this method returns. If the channel also implements IPrivileged IPrivileged.setPortalControlStructures(PortalControlStructures) must be called before this method. IChannel.setRuntimeData(ChannelRuntimeData) must also be called before this method.

Specified by:

prepareForRefresh in interface IResetableChannel

prepareForReset

public void prepareForReset()

Deprecated.

Description copied from interface: IResetableChannel

Prepare to be reset after an error. This channel instance may be destroyed and re-created during the reset process so this method gives the old channel a chance to clean up before the reset. State information stored anywhere outside of ChannelRuntimeData should be cleared. If the channel also implements IPrivileged IPrivileged.setPortalControlStructures(PortalControlStructures) must be called before this method. IChannel.setRuntimeData(ChannelRuntimeData) must also be called before this method.

Specified by:

prepareForReset in interface IResetableChannel

setResponse

public void setResponse(HttpServletResponse response)
                 throws PortalException

Deprecated.

Description copied from interface: IDirectResponse

Sets the HttpServletResponse for the channel to use.

Specified by:

setResponse in interface IDirectResponse

Parameters:

response - The HttpServletResponse for the channel to use.

Throws:

PortalException

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

Parameters:

out - the SAX ContentHandler to output content to

Throws:

PortalException

toString

public String toString()

Deprecated.

Overrides:

toString in class Object