|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.ChannelRegistryManager
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)
Constructor Summary | |
ChannelRegistryManager()
|
Method Summary | |
static org.w3c.dom.NodeList |
getCategories(java.lang.String channelPublishId)
Looks in channel registry for a channel element matching the given channel ID. |
static org.w3c.dom.Element |
getChannel(java.lang.String channelPublishId)
Looks in channel registry for a channel element matching the given channel ID. |
static org.w3c.dom.Document |
getChannelRegistry()
Returns a copy of the channel registry as a Document. |
static org.w3c.dom.Document |
getChannelRegistry(IPerson person)
Returns the channel registry as a Document. |
static org.w3c.dom.Document |
getChannelRegistryXML()
Returns an XML document which describes the channel registry. |
static org.w3c.dom.Document |
getChannelTypes()
Returns the publishable channel types as a Document. |
static org.w3c.dom.Document |
getChannelTypesXML()
Create XML representing the channel types. |
static org.w3c.dom.Element |
getChannelXML(java.lang.String subscribeId,
ChannelDefinition channelDef)
Create XML representing this channel definition. |
static org.w3c.dom.Document |
getCPD(java.lang.String chanTypeID)
Returns a CPD (channel publishing document) as a Document |
static void |
publishChannel(org.w3c.dom.Element channel,
java.lang.String[] categoryIDs,
IGroupMember[] groupMembers,
IPerson publisher)
Publishes a channel. |
static void |
removeChannel(java.lang.String channelID,
IPerson person)
Removes a channel from the channel registry. |
static void |
setChannelXML(org.w3c.dom.Element channelE,
ChannelDefinition channelDef)
Update a channel definition with data from a channel XML element. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ChannelRegistryManager()
Method Detail |
public static org.w3c.dom.Document getChannelRegistry() throws PortalException
getChannelRegistry(IPerson person)
PortalException
public static org.w3c.dom.Document getChannelRegistry(IPerson person) throws PortalException
PortalException
public static org.w3c.dom.Document getChannelRegistryXML() throws java.lang.Exception
channelRegistry.dtd
java.lang.Exception
public static org.w3c.dom.Element getChannel(java.lang.String channelPublishId) throws PortalException
channelPublishId
- the channel publish id
PortalException
public static org.w3c.dom.Element getChannelXML(java.lang.String subscribeId, ChannelDefinition channelDef)
subscribeId
- the channel subscibe ID, formerly called instance IDchannelDef
- a channel definition
public static void setChannelXML(org.w3c.dom.Element channelE, ChannelDefinition channelDef)
channelE
- an XML element representing a channel definitionchannelDef
- the channel definition to updatepublic static org.w3c.dom.Document getChannelTypesXML() throws java.lang.Exception
java.lang.Exception
public static org.w3c.dom.NodeList getCategories(java.lang.String channelPublishId) throws PortalException
channelPublishId
- the channel publish ID
PortalException
public static void publishChannel(org.w3c.dom.Element channel, java.lang.String[] categoryIDs, IGroupMember[] groupMembers, IPerson publisher) throws java.lang.Exception
channel
- the channel XML fragmentcategoryIDs
- a list of categories that the channel belongs togroupMembers
- a list of groups and/or people that are permitted to subscribe to and view the channelpublisher
- the user ID of the channel publisher
java.lang.Exception
public static void removeChannel(java.lang.String channelID, IPerson person) throws java.lang.Exception
channelID
- the channel IDperson
- the person removing the channel
java.lang.Exception
public static org.w3c.dom.Document getChannelTypes() throws PortalException
PortalException
public static org.w3c.dom.Document getCPD(java.lang.String chanTypeID) throws PortalException
chanTypeID
- the channel type ID, "-1" if channel type is "custom"
null
if "custom" channel
PortalException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |