org.jasig.portal
Class ChannelRegistryManager

java.lang.Object
  org.jasig.portal.ChannelRegistryManager

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

@Deprecated
public class ChannelRegistryManager
extends Object

Manages the channel registry which is a listing of published channels that one can subscribe to (add to their layout). Also currently manages the channel types data and CPD documents. (maybe these should be managed by another class -Ken)

Version:

$Revision: 21632 $

Author:

Ken Weiner, kweiner@unicon.net

Field Summary

protected static SmartCache	channelRegistryCache Deprecated.
protected static SmartCache	channelTypesCache Deprecated.
protected static int	chanTypesCacheTimeout Deprecated. Timeout, in seconds, of the cache of channel types.
protected static SmartCache	cpdCache Deprecated.
protected static int	cpdCacheTimeout Deprecated. Timeout, in seconds, of the cache of channel publishing documents.
protected static IChannelRegistryStore	crs Deprecated.
protected static boolean	localeAware Deprecated. Boolean indicating whether internationalization will be used.
protected static int	registryCacheTimeout Deprecated. Timeout, in seconds, of the cache of the registry of channels.

Constructor Summary

ChannelRegistryManager()
Deprecated.

Method Summary

static void	expireCache() Deprecated.
static NodeList	getCategories(String channelPublishId) Deprecated. Looks in channel registry for a channel element matching the given channel ID.
static Element	getChannel(String channelPublishId) Deprecated. Looks in channel registry for a channel element matching the given channel ID.
static Document	getChannelRegistry() Deprecated. Returns a copy of the channel registry as a Document.
static Document	getChannelRegistry(IPerson person) Deprecated. Returns the channel registry as a Document.
static Document	getChannelRegistryXML() Deprecated. Returns an XML document which describes the channel registry.
static Document	getChannelTypes() Deprecated. Returns the publishable channel types as a Document.
static Document	getChannelTypesXML() Deprecated. Create XML representing the channel types.
static Element	getChannelXML(String subscribeId, IChannelDefinition channelDef) Deprecated. Create XML representing this channel definition.
static Document	getCPD(String chanTypeID) Deprecated. Returns a CPD (channel publishing document) as a Document
static Document	getManageableChannelRegistry(IPerson person) Deprecated. Returns the channel registry as a Document.
static void	removeChannel(String channelID, IPerson person) Deprecated. Removes a channel from the channel registry.

Methods inherited from class java.lang.Object

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

Field Detail

crs

protected static final IChannelRegistryStore crs

Deprecated.

registryCacheTimeout

protected static final int registryCacheTimeout

Deprecated.

Timeout, in seconds, of the cache of the registry of channels.

chanTypesCacheTimeout

protected static final int chanTypesCacheTimeout

Deprecated.

Timeout, in seconds, of the cache of channel types.

cpdCacheTimeout

protected static final int cpdCacheTimeout

Deprecated.

Timeout, in seconds, of the cache of channel publishing documents.

localeAware

protected static final boolean localeAware

Deprecated.

Boolean indicating whether internationalization will be used.

channelRegistryCache

protected static final SmartCache channelRegistryCache

Deprecated.

channelTypesCache

protected static final SmartCache channelTypesCache

Deprecated.

cpdCache

protected static final SmartCache cpdCache

Deprecated.

Constructor Detail

ChannelRegistryManager

public ChannelRegistryManager()

Deprecated.

Method Detail

getChannelRegistry

public static Document getChannelRegistry()
                                   throws PortalException

Deprecated.

Returns a copy of the channel registry as a Document. This document is not filtered according to a user's channel permissions. For a filtered list, see getChannelRegistry(IPerson person)

Returns:

a copy of the channel registry as a Document

Throws:

PortalException

getChannelRegistry

public static Document getChannelRegistry(IPerson person)
                                   throws PortalException

Deprecated.

Returns the channel registry as a Document. This document is filtered according to a user's channel permissions.

Returns:

the filtered channel registry as a Document

Throws:

PortalException

getManageableChannelRegistry

public static Document getManageableChannelRegistry(IPerson person)
                                             throws PortalException

Deprecated.

Returns the channel registry as a Document. This document is filtered according to a user's channel permissions.

Returns:

the filtered channel registry as a Document

Throws:

PortalException

getChannelRegistryXML

public static Document getChannelRegistryXML()
                                      throws Exception

Deprecated.

Returns an XML document which describes the channel registry. See uPortal's channelRegistry.dtd

Returns:

doc the channel registry document

Throws:

Exception

getChannel

public static Element getChannel(String channelPublishId)
                          throws PortalException

Deprecated.

Looks in channel registry for a channel element matching the given channel ID.

Parameters:

channelPublishId - the channel publish id

Returns:

the channel element matching specified channel publish id

Throws:

PortalException

getChannelXML

public static Element getChannelXML(String subscribeId,
                                    IChannelDefinition channelDef)

Deprecated.

Create XML representing this channel definition. I don't think this method really belongs in the ChannelRegistryManager since this XML fragment is related more to a channel instance, but we'll hold it here for now and find a better place for it later :)

Parameters:

subscribeId - the channel subscibe ID, formerly called instance ID

channelDef - a channel definition

Returns:

the XML representing this channel definition

getChannelTypesXML

public static Document getChannelTypesXML()
                                   throws Exception

Deprecated.

Create XML representing the channel types. It will look something like this:

org.jasig.portal.channels.CImage Image Simple channel to display an image with optional caption and subcaption webpages/media/org/jasig/portal/channels/CImage/CImage.cpd org.jasig.portal.channels.CWebProxy Web Proxy Incorporate a dynamic HTML or XML application webpages/media/org/jasig/portal/channels/CWebProxy/CWebProxy.cpd

Returns:

channelTypesXML, the XML representing the channel types

Throws:

Exception

getCategories

public static NodeList getCategories(String channelPublishId)
                              throws PortalException

Deprecated.

Looks in channel registry for a channel element matching the given channel ID.

Parameters:

channelPublishId - the channel publish ID

Returns:

the channel element matching chanID

Throws:

PortalException

removeChannel

public static void removeChannel(String channelID,
                                 IPerson person)
                          throws Exception

Deprecated.

Removes a channel from the channel registry.

Parameters:

channelID - the channel ID

person - the person removing the channel

Throws:

Exception

getChannelTypes

public static Document getChannelTypes()
                                throws PortalException

Deprecated.

Returns the publishable channel types as a Document.

Returns:

a list of channel types as a Document

Throws:

PortalException

getCPD

public static Document getCPD(String chanTypeID)
                       throws PortalException

Deprecated.

Returns a CPD (channel publishing document) as a Document

Parameters:

chanTypeID - the channel type ID, "-1" if channel type is "custom"

Returns:

the CPD document matching the chanTypeID, null if "custom" channel

Throws:

PortalException

expireCache

public static void expireCache()

Deprecated.