Java Doc for CGenericXSLT.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » channels » 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.channels 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.CGenericXSLT

CGenericXSLT
public class CGenericXSLT extends BaseChannel implements IChannel,ICacheable(Code)

A channel which transforms XML for rendering in the portal.

Static channel parameters to be supplied:

  1. "xmlUri" - a URI representing the source XML document
  2. "sslUri" - a URI representing the corresponding .ssl (stylesheet list) file
  3. "xslTitle" - a title representing the stylesheet (optional) If no title parameter is specified, a default stylesheet will be chosen according to the media
  4. "xslUri" - a URI representing the stylesheet to use If xslUri is supplied, sslUri and xslTitle will be ignored.
  5. "cacheTimeout" - the amount of time (in seconds) that the contents of the channel should be cached (optional). If this parameter is left out, a default timeout value will be used.
  6. "cacheScope" - the desired scope for caching channel responses. Defaults to "instance" indicating that cache is per-channel-instance-per-user. Cache will not match across users. This is typically desirable to prevent user A from seeing user B's data. Alternately, this parameter may be set to "system" indicating that caching should occur across the entire portal such that two different users' instances of like-configured CGenericXSLT channels will share cache.
  7. "upc_localConnContext" - The class name of the ILocalConnectionContext implementation. Use when local data needs to be sent with the request for the URL.
  8. "upc_allow_xmlUri_prefixes" - Optional parameter specifying as a whitespace delimited String the allowable xmlUri prefixes. Defaults to "http:// https://"
  9. "upc_deny_xmlUri_prefixes" - Optional parameter specifying as a whitespace delimited String URI prefixes that should block a URI as xmlUri even if it matched one of the allow prefixes. Defaults to ""
  10. "restrict_xmlUri_inStaticData" - Optional parameter specifying whether the xmlUri should be restricted according to the allow and deny prefix rules above as presented in ChannelStaticData or just as presented in ChannelRuntimeData. "true" means both ChannelStaticData and ChannelRuntimeData will be restricted. Any other value or the parameter not being present means only ChannelRuntimeData will be restricted. It is important to set this value to true when using subscribe-time channel parameter configuration of the xmlUri.

    The xmlUri and xslTitle static parameters above can be overridden by including parameters of the same name (xmlUri and/or xslTitle) in the HttpRequest string. Prior to uPortal 2.5.1 sslUri and xslUri could also be overridden -- these features have been removed to improve the security of CGenericXSLT instances.

    Additionally, as of uPortal 2.5.1, the xmlUri must match an allowed URI prefix. By default http:// and https:// URIs are allowed. If you are using the empty document or another XML file from the classpath or from the filesystem, you will need to allow a prefix to or the full path of that resource.

    This channel can be used for all XML formats including RSS. Any other parameters passed to this channel via HttpRequest will get passed in turn to the XSLT stylesheet as stylesheet parameters. They can be read in the stylesheet as follows: <xsl:param name="yourParamName">aDefaultValue</xsl:param>

    CGenericXSLT is also useful for channels that have no dynamic data. In these types of channels, all the markup comes from the XSLT stylesheets. An empty XML document can be used and is included with CGenericXSLT. Just set the xml parameter to this empty document and allow the path to the empty document.


    author:
       Steve Toth, stoth@interactivebusiness.com
    author:
       Ken Weiner, kweiner@unicon.net
    author:
       Peter Kharchenko pkharchenko@unicon.net
    version:
       $Revision: 36839 $



Constructor Summary
public  CGenericXSLT()
    

Method Summary
public  ChannelCacheKeygenerateKey()
    
public  booleanisCacheValid(Object validity)
    
public  voidrenderXML(ContentHandler out)
    
public  voidsetRuntimeData(ChannelRuntimeData rd)
    
public  voidsetStaticData(ChannelStaticData sd)
    
public  StringtoString()
    


Constructor Detail
CGenericXSLT
public CGenericXSLT()(Code)




Method Detail
generateKey
public ChannelCacheKey generateKey()(Code)



isCacheValid
public boolean isCacheValid(Object validity)(Code)



renderXML
public void renderXML(ContentHandler out) throws PortalException(Code)



setRuntimeData
public void setRuntimeData(ChannelRuntimeData rd)(Code)



setStaticData
public void setStaticData(ChannelStaticData sd) throws ResourceMissingException(Code)



toString
public String toString()(Code)



Fields inherited from org.jasig.portal.channels.BaseChannel
protected Log log(Code)(Java Doc)
protected ChannelRuntimeData runtimeData(Code)(Java Doc)
protected ChannelStaticData staticData(Code)(Java Doc)

Methods inherited from org.jasig.portal.channels.BaseChannel
public ChannelRuntimeProperties getRuntimeProperties()(Code)(Java Doc)
public void receiveEvent(PortalEvent ev)(Code)(Java Doc)
public void renderXML(ContentHandler out) throws PortalException(Code)(Java Doc)
public void setRuntimeData(ChannelRuntimeData rd) throws PortalException(Code)(Java Doc)
public void setStaticData(ChannelStaticData sd) throws PortalException(Code)(Java Doc)
public String toString()(Code)(Java Doc)

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.