org.jasig.portal
Class ChannelManager

java.lang.Object
  org.jasig.portal.ChannelManager

All Implemented Interfaces:

EventListener, LayoutEventListener

Deprecated. IChannel rendering code will be replaced with portlet specific rendering code in a future release

@Deprecated
public class ChannelManager
extends Object
implements LayoutEventListener

ChannelManager shall have the burden of squeezing content out of channels.

Validation and timeouts, these two are needed for smooth operation of the portal sometimes channels will timeout with information retrieval then the content should be skipped.

Version:

$Revision: 20117 $

Author:

Peter Kharchenko, pkharchenko@unicon.net

Field Summary

static String

channelAddressingPathElement Deprecated.

Constructor Summary

ChannelManager(IUserPreferencesManager manager, HttpSession httpSession)
Deprecated. Creates a new ChannelManager instance.

Method Summary

void	channelAdded(LayoutEvent ev) Deprecated.
void	channelDeleted(LayoutMoveEvent ev) Deprecated.
void	channelMoved(LayoutMoveEvent ev) Deprecated.
void	channelUpdated(LayoutEvent ev) Deprecated.
void	commitToRenderingChannelSet() Deprecated. A method to notify ChannelManager that the channel set for the current rendering cycle is complete.
boolean	doChannelAction(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId, boolean noTimeout) Deprecated.
void	finishedRenderingCycle() Deprecated. Clean up after a rendering round.
void	finishedSession(HttpSession session) Deprecated. Handle end-of-session cleanup
void	folderAdded(LayoutEvent ev) Deprecated.
void	folderDeleted(LayoutMoveEvent ev) Deprecated.
void	folderMoved(LayoutMoveEvent ev) Deprecated.
void	folderUpdated(LayoutEvent ev) Deprecated.
static long	getActiveRenderers() Deprecated.
IChannel	getChannelInstance(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId) Deprecated. Obtain an instance of a channel.
String	getChannelTarget() Deprecated.
String	getChannelTitle(String channelSubscribeId) Deprecated. Get the dynamic channel title for a given channelSubscribeID.
static long	getMaxRenderThreads() Deprecated.
String	getSerializerName() Deprecated. Sets the serializer name.
String	getSubscribeId(String fname) Deprecated.
IChannel	instantiateChannel(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId) Deprecated. Instantiates a channel given just the channel subscribe Id.
boolean	isCharacterCaching() Deprecated. Specifies if this particular rendering cycle is using character caching.
void	layoutLoaded() Deprecated.
void	layoutSaved() Deprecated.
void	outputChannel(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId, ContentHandler contentHandler) Deprecated. Outputs a channel in to a given content handler.
void	passPortalEvent(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId, PortalEvent le) Deprecated. Passes a layout-level event to a channel.
void	removeChannel(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId) Deprecated. Removes channel instance from the internal caches.
void	setChannelInstance(String channelSubscribeId, IChannel channelInstance) Deprecated. Directly places a channel instance into the hashtable of active channels.
void	setCharacterCaching(boolean setting) Deprecated. Specify that the current rendering cycle should be using (or not) character caching.
void	setLocaleManager(LocaleManager lm) Deprecated.
void	setSerializerName(String serializerName) Deprecated. Setter method for the serializer name.
void	setUPElement(UPFileSpec uPElement) Deprecated. Specify UPFileSpec object that will be used to construct file portion of the context path in the auto-generated URLs, also known as the baseActionURL.
IChannelRenderer	startChannelRendering(HttpServletRequest request, HttpServletResponse response, String channelSubscribeId) Deprecated. Initiate channel rendering cycle.
void	startRenderingCycle(HttpServletRequest request, HttpServletResponse response, UPFileSpec uPElement) Deprecated. Signals the start of a new rendering cycle.

Methods inherited from class java.lang.Object

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

Field Detail

channelAddressingPathElement

public static final String channelAddressingPathElement

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ChannelManager

public ChannelManager(IUserPreferencesManager manager,
                      HttpSession httpSession)

Deprecated.

Creates a new ChannelManager instance.

Parameters:

manager - an IUserPreferencesManager value

Method Detail

getActiveRenderers

public static long getActiveRenderers()

Deprecated.

getMaxRenderThreads

public static long getMaxRenderThreads()

Deprecated.

setChannelInstance

public void setChannelInstance(String channelSubscribeId,
                               IChannel channelInstance)

Deprecated.

Directly places a channel instance into the hashtable of active channels. This is designed to be used by the error channel only.

commitToRenderingChannelSet

public void commitToRenderingChannelSet()

Deprecated.

A method to notify ChannelManager that the channel set for the current rendering cycle is complete. Note: This information is used to identify relevant channel communication dependencies

finishedRenderingCycle

public void finishedRenderingCycle()

Deprecated.

Clean up after a rendering round.

finishedSession

public void finishedSession(HttpSession session)

Deprecated.

Handle end-of-session cleanup

outputChannel

public void outputChannel(HttpServletRequest request,
                          HttpServletResponse response,
                          String channelSubscribeId,
                          ContentHandler contentHandler)

Deprecated.

Outputs a channel in to a given content handler. If the current rendering cycle is targeting character cache output, and the content handler passed to the method is an instance of CachingSerializer, the method will take care of character cache compilation and store cache in the tables.

Parameters:

channelSubscribeId - a String value

contentHandler - a ContentHandler value

instantiateChannel

public IChannel instantiateChannel(HttpServletRequest request,
                                   HttpServletResponse response,
                                   String channelSubscribeId)
                            throws PortalException

Deprecated.

Instantiates a channel given just the channel subscribe Id.

Parameters:

channelSubscribeId - a channel instance Id in the userLayout

Returns:

an IChannel object

Throws:

PortalException

passPortalEvent

public void passPortalEvent(HttpServletRequest request,
                            HttpServletResponse response,
                            String channelSubscribeId,
                            PortalEvent le)

Deprecated.

Passes a layout-level event to a channel.

Parameters:

channelSubscribeId - the channel subscribe id

le - the portal event

getChannelInstance

public IChannel getChannelInstance(HttpServletRequest request,
                                   HttpServletResponse response,
                                   String channelSubscribeId)

Deprecated.

Obtain an instance of a channel.

Parameters:

channelSubscribeId - a String value

Returns:

an IChannel object

removeChannel

public void removeChannel(HttpServletRequest request,
                          HttpServletResponse response,
                          String channelSubscribeId)

Deprecated.

Removes channel instance from the internal caches.

Parameters:

channelSubscribeId - a String value

startRenderingCycle

public void startRenderingCycle(HttpServletRequest request,
                                HttpServletResponse response,
                                UPFileSpec uPElement)

Deprecated.

Signals the start of a new rendering cycle.

Parameters:

request - a HttpServletRequest value

response - a HttpServletResponse value

uPElement - an UPFileSpec value

isCharacterCaching

public boolean isCharacterCaching()

Deprecated.

Specifies if this particular rendering cycle is using character caching.

Returns:

a boolean value

setCharacterCaching

public void setCharacterCaching(boolean setting)

Deprecated.

Specify that the current rendering cycle should be using (or not) character caching.

Parameters:

setting - a boolean value

setUPElement

public void setUPElement(UPFileSpec uPElement)

Deprecated.

Specify UPFileSpec object that will be used to construct file portion of the context path in the auto-generated URLs, also known as the baseActionURL.

Parameters:

uPElement - an UPFileSpec value

doChannelAction

public boolean doChannelAction(HttpServletRequest request,
                               HttpServletResponse response,
                               String channelSubscribeId,
                               boolean noTimeout)
                        throws PortalException

Deprecated.

Throws:

PortalException

startChannelRendering

public IChannelRenderer startChannelRendering(HttpServletRequest request,
                                              HttpServletResponse response,
                                              String channelSubscribeId)
                                       throws PortalException

Deprecated.

Initiate channel rendering cycle.

Parameters:

channelSubscribeId - a String value

Returns:

a IChannelRenderer value

Throws:

PortalException - if an error occurs

getChannelTarget

public String getChannelTarget()

Deprecated.

channelAdded

public void channelAdded(LayoutEvent ev)

Deprecated.

Specified by:

channelAdded in interface LayoutEventListener

channelUpdated

public void channelUpdated(LayoutEvent ev)

Deprecated.

Specified by:

channelUpdated in interface LayoutEventListener

channelMoved

public void channelMoved(LayoutMoveEvent ev)

Deprecated.

Specified by:

channelMoved in interface LayoutEventListener

channelDeleted

public void channelDeleted(LayoutMoveEvent ev)

Deprecated.

Specified by:

channelDeleted in interface LayoutEventListener

folderAdded

public void folderAdded(LayoutEvent ev)

Deprecated.

Specified by:

folderAdded in interface LayoutEventListener

folderUpdated

public void folderUpdated(LayoutEvent ev)

Deprecated.

Specified by:

folderUpdated in interface LayoutEventListener

folderMoved

public void folderMoved(LayoutMoveEvent ev)

Deprecated.

Specified by:

folderMoved in interface LayoutEventListener

folderDeleted

public void folderDeleted(LayoutMoveEvent ev)

Deprecated.

Specified by:

folderDeleted in interface LayoutEventListener

layoutLoaded

public void layoutLoaded()

Deprecated.

Specified by:

layoutLoaded in interface LayoutEventListener

layoutSaved

public void layoutSaved()

Deprecated.

Specified by:

layoutSaved in interface LayoutEventListener

setLocaleManager

public void setLocaleManager(LocaleManager lm)

Deprecated.

getChannelTitle

public String getChannelTitle(String channelSubscribeId)

Deprecated.

Get the dynamic channel title for a given channelSubscribeID. Returns null if no dynamic channel (the rendering infrastructure calling this method should fall back on a default title when this method returns null).

Parameters:

channelSubscribeId -

Throws:

IllegalArgumentException - if channelSubcribeId is null

IllegalStateException - if

Since:

uPortal 2.5.1

getSubscribeId

public String getSubscribeId(String fname)
                      throws PortalException

Deprecated.

Throws:

PortalException

getSerializerName

public String getSerializerName()

Deprecated.

Sets the serializer name.

Returns:

serializerName

setSerializerName

public void setSerializerName(String serializerName)

Deprecated.

Setter method for the serializer name.

Parameters:

serializerName -