| java.lang.Object
 org.jasig.portal.ChannelRegistryManager
| ChannelRegistryManager | | public class ChannelRegistryManager (Code) | | 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)
author:
Ken Weiner, kweiner@unicon.net
version:
$Revision: 36546 $ |
| chanTypesCacheTimeout | | final protected static int chanTypesCacheTimeout(Code) | | Timeout, in seconds, of the cache of channel types.
|
| channelRegistryCache | | final protected static SmartCache channelRegistryCache(Code) | | |
| cpdCacheTimeout | | final protected static int cpdCacheTimeout(Code) | | Timeout, in seconds, of the cache of channel publishing documents.
|
| localeAware | | final protected static boolean localeAware(Code) | | Boolean indicating whether internationalization will be used.
|
| registryCacheTimeout | | final protected static int registryCacheTimeout(Code) | | Timeout, in seconds, of the cache of the registry of channels.
|
| getChannel | | public static Element getChannel(String channelPublishId) throws PortalException(Code) | | Looks in channel registry for a channel element matching the
given channel ID.
Parameters:
channelPublishId - the channel publish id the channel element matching specified channel publish id
throws:
PortalException - |
| getChannelRegistry | | public static Document getChannelRegistry() throws PortalException(Code) | | 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)
a copy of the channel registry as a Document |
| getChannelRegistry | | public static Document getChannelRegistry(IPerson person) throws PortalException(Code) | | Returns the channel registry as a Document. This document is filtered
according to a user's channel permissions.
the filtered channel registry as a Document |
| getChannelRegistryXML | | public static Document getChannelRegistryXML() throws Exception(Code) | | Returns an XML document which describes the channel registry.
See uPortal's channelRegistry.dtd
doc the channel registry document
throws:
java.lang.Exception - |
| getChannelTypes | | public static Document getChannelTypes() throws PortalException(Code) | | Returns the publishable channel types as a Document.
a list of channel types as a Document |
| getChannelTypesXML | | public static Document getChannelTypesXML() throws Exception(Code) | | 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
channelTypesXML, the XML representing the channel types
throws:
java.lang.Exception - |
| getChannelXML | | public static Element getChannelXML(String subscribeId, ChannelDefinition channelDef)(Code) | | 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
Parameters:
channelDef - a channel definition the XML representing this channel definition |
| publishChannel | | public static void publishChannel(Element channel, String[] categoryIDs, IGroupMember[] groupMembers, IPerson publisher) throws Exception(Code) | | Publishes a channel.
Parameters:
channel - the channel XML fragment
Parameters:
categoryIDs - a list of categories that the channel belongs to
Parameters:
groupMembers - a list of groups and/or people that are permitted to subscribe to and view the channel
Parameters:
publisher - the user ID of the channel publisher
throws:
java.lang.Exception - |
| removeChannel | | public static void removeChannel(String channelID, IPerson person) throws Exception(Code) | | Removes a channel from the channel registry.
Parameters:
channelID - the channel ID
Parameters:
person - the person removing the channel
throws:
java.lang.Exception - |
| setChannelXML | | public static void setChannelXML(Element channelE, ChannelDefinition channelDef)(Code) | | Update a channel definition with data from a channel XML
element. I don't think this method really belongs in the
ChannelRegistryManager since this XML fragment contains
a channel subscribe ID, but we'll hold it here for now
and find a better place for it later :)
Note that this method does not set the ID, publisher ID,
approver ID, pubish date, or approval date.
Parameters:
channelE - an XML element representing a channel definition
Parameters:
channelDef - the channel definition to update |
|
|