uPortal 2.4.1
API Documentation

org.jasig.portal
Class ChannelFactory

java.lang.Object
  extended byorg.jasig.portal.ChannelFactory

public class ChannelFactory
extends java.lang.Object

A factory class that produces IChannel instances.

Version:
$Revision: 1.16 $
Author:
Peter Kharchenko

Field Summary
static java.util.Hashtable staticChannels
           
 
Constructor Summary
ChannelFactory()
           
 
Method Summary
static IChannel instantiateChannel(java.lang.String className, java.lang.String uid)
          Produce an IChannel based on a java class name.
static IChannel instantiateLayoutChannel(IUserLayoutChannelDescription description, java.lang.String sessionId)
          Construct channel instance based on a channel description object.
static IChannel instantiateLayoutChannel(java.lang.String channelSubscribeId, IUserLayoutManager ulm, java.lang.String sessionId)
          Instantiate a channel from information supplied by the user layout manager.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

staticChannels

public static final java.util.Hashtable staticChannels
Constructor Detail

ChannelFactory

public ChannelFactory()
Method Detail

instantiateLayoutChannel

public static IChannel instantiateLayoutChannel(java.lang.String channelSubscribeId,
                                                IUserLayoutManager ulm,
                                                java.lang.String sessionId)
                                         throws PortalException
Instantiate a channel from information supplied by the user layout manager.

Parameters:
channelSubscribeId - a String value
ulm - an IUserLayoutManager value
sessionId - a String HTTP session Id value
Returns:
an IChannel instance
Throws:
PortalException - if an error occurs

instantiateLayoutChannel

public static IChannel instantiateLayoutChannel(IUserLayoutChannelDescription description,
                                                java.lang.String sessionId)
                                         throws PortalException
Construct channel instance based on a channel description object.

Parameters:
description - an IUserLayoutChannelDescription value
sessionId - a String HTTP session Id value
Returns:
an IChannel value
Throws:
PortalException

instantiateChannel

public static IChannel instantiateChannel(java.lang.String className,
                                          java.lang.String uid)
                                   throws PortalException
Produce an IChannel based on a java class name. If the java class specified implements a channel interface other than org.jasig.portal.IChannel, it will be wrapped by an appropriate adapter class that does implement IChannel.

Parameters:
className - the channel's java class name
uid - a unique ID for use with multithreaded channels
Returns:
an IChannel object
Throws:
PortalException

uPortal 2.4.1
API Documentation