|
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.ChannelManager
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 retreival then the content should be skipped.
Field Summary | |
static java.lang.String |
channelAddressingPathElement
|
static int |
SYSTEM_CHANNEL_CACHE_MIN_SIZE
|
static SoftHashMap |
systemCache
|
UPFileSpec |
uPElement
|
Constructor Summary | |
ChannelManager()
|
|
ChannelManager(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
IUserPreferencesManager manager,
UPFileSpec uPElement)
Creates a new ChannelManager instance. |
|
ChannelManager(IUserPreferencesManager manager)
Creates a new ChannelManager instance. |
Method Summary | |
void |
channelAdded(LayoutEvent ev)
|
void |
channelDeleted(LayoutMoveEvent ev)
|
void |
channelMoved(LayoutMoveEvent ev)
|
void |
channelUpdated(LayoutEvent ev)
|
void |
commitToRenderingChannelSet()
A method to notify ChannelManager that the channel set for
the current rendering cycle is complete. |
void |
finishedRenderingCycle()
Clean up after a rendering round. |
void |
finishedSession()
Handle end-of-session cleanup |
void |
folderAdded(LayoutEvent ev)
|
void |
folderDeleted(LayoutMoveEvent ev)
|
void |
folderMoved(LayoutMoveEvent ev)
|
void |
folderUpdated(LayoutEvent ev)
|
IChannel |
getChannelInstance(java.lang.String channelSubscribeId)
Obtain an instance of a channel. |
IChannel |
instantiateChannel(java.lang.String channelSubscribeId)
Instantiates a channel given just the channel subscribe Id. |
boolean |
isCharacterCaching()
Specifies if this particular rendering cycle is using character caching. |
static boolean |
isUseAnchors()
Determines whether or not anchors should be inserted at the end of URLS within channels. |
void |
layoutLoaded()
|
void |
layoutSaved()
|
void |
outputChannel(java.lang.String channelSubscribeId,
org.xml.sax.ContentHandler contentHandler)
Outputs a channel in to a given content handler. |
void |
passPortalEvent(java.lang.String channelSubscribeId,
PortalEvent le)
Passes a layout-level event to a channel. |
void |
removeChannel(java.lang.String channelSubscribeId)
Removes channel instance from the internal caches. |
void |
setChannelInstance(java.lang.String channelSubscribeId,
IChannel channelInstance)
Directly places a channel instance into the hashtable of active channels. |
void |
setCharacterCaching(boolean setting)
Specify that the current rendering cycle should be using (or not) character caching. |
void |
setLocaleManager(LocaleManager lm)
|
void |
setUPElement(UPFileSpec uPElement)
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. |
void |
setUserPreferencesManager(IUserPreferencesManager m)
Specify IUserPreferencesManager to use. |
IChannelRenderer |
startChannelRendering(java.lang.String channelSubscribeId)
Initiate channel rendering cycle. |
void |
startRenderingCycle(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
UPFileSpec uPElement)
Signals the start of a new rendering cycle. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public UPFileSpec uPElement
public static final int SYSTEM_CHANNEL_CACHE_MIN_SIZE
public static final SoftHashMap systemCache
public static final java.lang.String channelAddressingPathElement
Constructor Detail |
public ChannelManager()
public ChannelManager(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, IUserPreferencesManager manager, UPFileSpec uPElement)
ChannelManager
instance.
request
- a HttpServletRequest
valueresponse
- a HttpServletResponse
valuemanager
- an IUserPreferencesManager
valueuPElement
- an UPFileSpec
that includes a tag number.public ChannelManager(IUserPreferencesManager manager)
ChannelManager
instance.
manager
- an IUserPreferencesManager
valueMethod Detail |
public void setChannelInstance(java.lang.String channelSubscribeId, IChannel channelInstance)
public void commitToRenderingChannelSet()
ChannelManager
that the channel set for
the current rendering cycle is complete.
Note: This information is used to identify relevant channel communication dependencies
public void finishedRenderingCycle()
public void finishedSession()
public void outputChannel(java.lang.String channelSubscribeId, org.xml.sax.ContentHandler contentHandler)
CachingSerializer
, the method
will take care of character cache compilation and store cache
in the tables.
channelSubscribeId
- a String
valuecontentHandler
- a ContentHandler
valuepublic IChannel instantiateChannel(java.lang.String channelSubscribeId) throws PortalException
channelSubscribeId
- a channel instance Id in the userLayout
IChannel
object
PortalException
public void passPortalEvent(java.lang.String channelSubscribeId, PortalEvent le)
channelSubscribeId
- the channel subscribe idle
- the portal eventpublic IChannel getChannelInstance(java.lang.String channelSubscribeId)
channelSubscribeId
- a String
value
IChannel
objectpublic void removeChannel(java.lang.String channelSubscribeId)
channelSubscribeId
- a String
valuepublic void startRenderingCycle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, UPFileSpec uPElement)
request
- a HttpServletRequest
valueresponse
- a HttpServletResponse
valueuPElement
- an UPFileSpec
valuepublic boolean isCharacterCaching()
boolean
valuepublic void setCharacterCaching(boolean setting)
setting
- a boolean
valuepublic void setUPElement(UPFileSpec uPElement)
UPFileSpec
object that will be
used to construct file portion of the context path
in the auto-generated URLs, also known as the baseActionURL.
uPElement
- an UPFileSpec
valuepublic void setUserPreferencesManager(IUserPreferencesManager m)
IUserPreferencesManager
to use.
m
- an IUserPreferencesManager
valuepublic IChannelRenderer startChannelRendering(java.lang.String channelSubscribeId) throws PortalException
channelSubscribeId
- a String
value
IChannelRenderer
value
PortalException
- if an error occurspublic static boolean isUseAnchors()
true
if use of anchors is enabled, otherwise false
public void channelAdded(LayoutEvent ev)
channelAdded
in interface LayoutEventListener
public void channelUpdated(LayoutEvent ev)
channelUpdated
in interface LayoutEventListener
public void channelMoved(LayoutMoveEvent ev)
channelMoved
in interface LayoutEventListener
public void channelDeleted(LayoutMoveEvent ev)
channelDeleted
in interface LayoutEventListener
public void folderAdded(LayoutEvent ev)
folderAdded
in interface LayoutEventListener
public void folderUpdated(LayoutEvent ev)
folderUpdated
in interface LayoutEventListener
public void folderMoved(LayoutMoveEvent ev)
folderMoved
in interface LayoutEventListener
public void folderDeleted(LayoutMoveEvent ev)
folderDeleted
in interface LayoutEventListener
public void layoutLoaded()
layoutLoaded
in interface LayoutEventListener
public void layoutSaved()
layoutSaved
in interface LayoutEventListener
public void setLocaleManager(LocaleManager lm)
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |