Java Doc for ChannelManager.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jasig.portal.ChannelManager

ChannelManager
public class ChannelManager implements LayoutEventListener(Code)
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.
author:
   Peter Kharchenko, pkharchenko@unicon.net
version:
   $Revision: 42516 $



Field Summary
final public static  intSYSTEM_CHANNEL_CACHE_MIN_SIZE
    
final public static  AtomicLongactiveRenderers
    
final public static  StringchannelAddressingPathElement
    
public static  AtomicLongmaxRenderThreads
    
final public static  MapsystemCache
    
public  UPFileSpecuPElement
    

Constructor Summary
public  ChannelManager()
    
public  ChannelManager(HttpServletRequest request, HttpServletResponse response, IUserPreferencesManager manager, UPFileSpec uPElement)
     Creates a new ChannelManager instance.
public  ChannelManager(IUserPreferencesManager manager)
     Creates a new ChannelManager instance.

Method Summary
public  voidchannelAdded(LayoutEvent ev)
    
public  voidchannelDeleted(LayoutMoveEvent ev)
    
public  voidchannelMoved(LayoutMoveEvent ev)
    
public  voidchannelUpdated(LayoutEvent ev)
    
public  voidcommitToRenderingChannelSet()
     A method to notify ChannelManager that the channel set for the current rendering cycle is complete.
public  voidfinishedRenderingCycle()
     Clean up after a rendering round.
public  voidfinishedSession()
    
public  voidfolderAdded(LayoutEvent ev)
    
public  voidfolderDeleted(LayoutMoveEvent ev)
    
public  voidfolderMoved(LayoutMoveEvent ev)
    
public  voidfolderUpdated(LayoutEvent ev)
    
public  IChannelgetChannelInstance(String channelSubscribeId)
     Obtain an instance of a channel.
public  StringgetChannelTarget()
    
public  StringgetChannelTitle(String channelSubscribeId)
     Get the dynamic channel title for a given channelSubscribeID.
public  StringgetSerializerName()
     Sets the serializer name.
public  StringgetSubscribeId(String fname)
    
public  IChannelinstantiateChannel(String channelSubscribeId)
     Instantiates a channel given just the channel subscribe Id.
public  booleanisCharacterCaching()
     Specifies if this particular rendering cycle is using character caching.
public static  booleanisUseAnchors()
     Determines whether or not anchors should be inserted at the end of URLS within channels.
public  voidlayoutLoaded()
    
public  voidlayoutSaved()
    
public  voidoutputChannel(String channelSubscribeId, ContentHandler contentHandler)
     Outputs a channel in to a given content handler.
public  voidpassPortalEvent(HttpServletRequest req, HttpServletResponse res, String channelSubscribeId, PortalEvent le)
     Passes a layout-level event to a channel.
synchronized  voidregisterChannelDependency(String listenerChannelSubscribeId, String talkerChannelSubscribeId)
    
public  voidremoveChannel(String channelSubscribeId)
     Removes channel instance from the internal caches.
synchronized  voidremoveChannelDependency(String listenerChannelSubscribeId, String talkerChannelSubscribeId)
    
public  voidsetChannelInstance(String channelSubscribeId, IChannel channelInstance)
     Directly places a channel instance into the hashtable of active channels.
public  voidsetCharacterCaching(boolean setting)
     Specify that the current rendering cycle should be using (or not) character caching.
public  voidsetLocaleManager(LocaleManager lm)
    
public  voidsetSerializerName(String serializerName)
     Setter method for the serializer name.
public  voidsetUPElement(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.
public  voidsetUserPreferencesManager(IUserPreferencesManager m)
     Specify IUserPreferencesManager to use.
public  IChannelRendererstartChannelRendering(String channelSubscribeId)
     Initiate channel rendering cycle.
public  voidstartRenderingCycle(HttpServletRequest request, HttpServletResponse response, UPFileSpec uPElement)
     Signals the start of a new rendering cycle.

Field Detail
SYSTEM_CHANNEL_CACHE_MIN_SIZE
final public static int SYSTEM_CHANNEL_CACHE_MIN_SIZE(Code)



activeRenderers
final public static AtomicLong activeRenderers(Code)



channelAddressingPathElement
final public static String channelAddressingPathElement(Code)



maxRenderThreads
public static AtomicLong maxRenderThreads(Code)



systemCache
final public static Map systemCache(Code)



uPElement
public UPFileSpec uPElement(Code)




Constructor Detail
ChannelManager
public ChannelManager()(Code)



ChannelManager
public ChannelManager(HttpServletRequest request, HttpServletResponse response, IUserPreferencesManager manager, UPFileSpec uPElement)(Code)
Creates a new ChannelManager instance.
Parameters:
  request - a HttpServletRequest value
Parameters:
  response - a HttpServletResponse value
Parameters:
  manager - an IUserPreferencesManager value
Parameters:
  uPElement - an UPFileSpec that includes a tag number.



ChannelManager
public ChannelManager(IUserPreferencesManager manager)(Code)
Creates a new ChannelManager instance.
Parameters:
  manager - an IUserPreferencesManager value




Method Detail
channelAdded
public void channelAdded(LayoutEvent ev)(Code)



channelDeleted
public void channelDeleted(LayoutMoveEvent ev)(Code)



channelMoved
public void channelMoved(LayoutMoveEvent ev)(Code)



channelUpdated
public void channelUpdated(LayoutEvent ev)(Code)



commitToRenderingChannelSet
public void commitToRenderingChannelSet()(Code)
A method to notify ChannelManager that the channel set for the current rendering cycle is complete. Note: This information is used to identify relevant channel communication dependencies



finishedRenderingCycle
public void finishedRenderingCycle()(Code)
Clean up after a rendering round.



finishedSession
public void finishedSession()(Code)
Handle end-of-session cleanup



folderAdded
public void folderAdded(LayoutEvent ev)(Code)



folderDeleted
public void folderDeleted(LayoutMoveEvent ev)(Code)



folderMoved
public void folderMoved(LayoutMoveEvent ev)(Code)



folderUpdated
public void folderUpdated(LayoutEvent ev)(Code)



getChannelInstance
public IChannel getChannelInstance(String channelSubscribeId)(Code)
Obtain an instance of a channel.
Parameters:
  channelSubscribeId - a String value an IChannel object



getChannelTarget
public String getChannelTarget()(Code)



getChannelTitle
public String getChannelTitle(String channelSubscribeId)(Code)
Get the dynamic channel title for a given channelSubscribeID. Returns null if no dynamic channel (the rendering infrastructure calling this method should fall back on a default title when this method returns null).
since:
   uPortal 2.5.1
Parameters:
  channelSubscribeId -
throws:
  IllegalArgumentException - if channelSubcribeId is null
throws:
  IllegalStateException - if



getSerializerName
public String getSerializerName()(Code)
Sets the serializer name. serializerName



getSubscribeId
public String getSubscribeId(String fname) throws PortalException(Code)



instantiateChannel
public IChannel instantiateChannel(String channelSubscribeId) throws PortalException(Code)
Instantiates a channel given just the channel subscribe Id.
Parameters:
  channelSubscribeId - a channel instance Id in the userLayout an IChannel object



isCharacterCaching
public boolean isCharacterCaching()(Code)
Specifies if this particular rendering cycle is using character caching. a boolean value



isUseAnchors
public static boolean isUseAnchors()(Code)
Determines whether or not anchors should be inserted at the end of URLS within channels. These anchors typically tell a browser to position itself with the channel in-view after a link is clicked or a form is submitted. true if use of anchors is enabled, otherwise false



layoutLoaded
public void layoutLoaded()(Code)



layoutSaved
public void layoutSaved()(Code)



outputChannel
public void outputChannel(String channelSubscribeId, ContentHandler contentHandler)(Code)
Outputs a channel in to a given content handler. If the current rendering cycle is targeting character cache output, and the content handler passed to the method is an instance of CachingSerializer, the method will take care of character cache compilation and store cache in the tables.
Parameters:
  channelSubscribeId - a String value
Parameters:
  contentHandler - a ContentHandler value



passPortalEvent
public void passPortalEvent(HttpServletRequest req, HttpServletResponse res, String channelSubscribeId, PortalEvent le)(Code)
Passes a layout-level event to a channel.
Parameters:
  channelSubscribeId - the channel subscribe id
Parameters:
  le - the portal event



registerChannelDependency
synchronized void registerChannelDependency(String listenerChannelSubscribeId, String talkerChannelSubscribeId)(Code)



removeChannel
public void removeChannel(String channelSubscribeId)(Code)
Removes channel instance from the internal caches.
Parameters:
  channelSubscribeId - a String value



removeChannelDependency
synchronized void removeChannelDependency(String listenerChannelSubscribeId, String talkerChannelSubscribeId)(Code)



setChannelInstance
public void setChannelInstance(String channelSubscribeId, IChannel channelInstance)(Code)
Directly places a channel instance into the hashtable of active channels. This is designed to be used by the error channel only.



setCharacterCaching
public void setCharacterCaching(boolean setting)(Code)
Specify that the current rendering cycle should be using (or not) character caching.
Parameters:
  setting - a boolean value



setLocaleManager
public void setLocaleManager(LocaleManager lm)(Code)



setSerializerName
public void setSerializerName(String serializerName)(Code)
Setter method for the serializer name.
Parameters:
  serializerName -



setUPElement
public void setUPElement(UPFileSpec uPElement)(Code)
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.
Parameters:
  uPElement - an UPFileSpec value



setUserPreferencesManager
public void setUserPreferencesManager(IUserPreferencesManager m)(Code)
Specify IUserPreferencesManager to use.
Parameters:
  m - an IUserPreferencesManager value



startChannelRendering
public IChannelRenderer startChannelRendering(String channelSubscribeId) throws PortalException(Code)
Initiate channel rendering cycle.
Parameters:
  channelSubscribeId - a String value a IChannelRenderer value
exception:
  PortalException - if an error occurs



startRenderingCycle
public void startRenderingCycle(HttpServletRequest request, HttpServletResponse response, UPFileSpec uPElement)(Code)
Signals the start of a new rendering cycle.
Parameters:
  request - a HttpServletRequest value
Parameters:
  response - a HttpServletResponse value
Parameters:
  uPElement - an UPFileSpec value



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.