Java Doc for TclServerTemplate.java in  » Web-Server » Brazil » sunlabs » brazil » tcl » 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 » Web Server » Brazil » sunlabs.brazil.tcl 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   sunlabs.brazil.template.Template
      sunlabs.brazil.tcl.TclServerTemplate

TclServerTemplate
public class TclServerTemplate extends Template (Code)
The TclServerTemplate looks for each <server language="tcl"> tag in an HTML page and treats the following data up to the next </server> tag as a Tcl script to evaluate.

The reason that Tcl scripts are included in an HTML page is usually to generate dynamic, server-side content. After running this template, everything between and including the <server> and </server> tags is replaced with the result of evaluating the Tcl script as follows:

  • Anything printed to the standard output of the Tcl interpreter is added to the HTML document (for instance, puts "hello").
  • Additionally, if the Tcl script returns a value, that value is added to the HTML document (for instance, return "bob").
Multiple puts and a final return can both be used within a single Tcl fragment.

All Tcl fragments within a given page are evaluated in the same Tcl interpreter. The Tcl interpreter actually lives for the entire duration of this Template object, so the user can implement persistence across requests.

The following configuration parameters are used to initialize this template.

script
The name of the Tcl script to evaluate when the interpreter is created. This script only evaluated when the interp is created, not on every request. The variables prefix and server are set before this file is evaluated, and are references to the parameters passed to a handler init method.
root
The document root, if the script is a relative file name. If the "root" property under the template prefix is not found, the global "root" property is used. If the global "root" property is not found, the current directory is used.
debug
If this configuration parameter is present, this class replaces the <server> and </server> tags with comments, so the user can keep track of where the dynamically generated content is coming from by examining the comments in the resultant HTML document. By default, the <server> and </server> are completely eliminated from the HTML document rather than changed into comments.

Before evaluating each HTML document, this class variables in the Tcl interpreter, which can be used to interact back with Java to do things like set the response headers:

request
Exposes the sunlabs.brazil.server.Request Java object. It is set anew at each request.
prefix
Exposes the handler prefix String.
server
Exposes the handler sunlabs.brazil.server.Server object.
SessionId
Exposes the session id for this interp, or "none".
If a serialized version of this object is reconstituted, the init method must be called again.
author:
   Colin Stevens (colin.stevens@sun.com)
version:
   1.17, 00/12/11


Field Summary
transient  TclTemplateChannelchan
    
transient  booleandebug
    
 Interpinterp
    
transient  TclObjectrequest
    


Method Summary
public  booleandone(RewriteContext hr)
     Called after the HTML document has been processed.

Releases the resources allocated by init.

public  booleaninit(RewriteContext hr)
     Called at the beginning of each HTML document that this TclServerTemplate is asked to process.
public  voidtag_server(RewriteContext hr)
     Processes the <server> tag.

Field Detail
chan
transient TclTemplateChannel chan(Code)



debug
transient boolean debug(Code)



interp
Interp interp(Code)



request
transient TclObject request(Code)





Method Detail
done
public boolean done(RewriteContext hr)(Code)
Called after the HTML document has been processed.

Releases the resources allocated by init. This method should be called to ensure that the HtmlRewriter and all its attendant data structures are not preserved indefinitely (until the next request).
Parameters:
  hr - The request and associated HTML document that was processed.




init
public boolean init(RewriteContext hr)(Code)
Called at the beginning of each HTML document that this TclServerTemplate is asked to process.

Redirects the standard output of the Tcl interpreter to the resultant HTML document and exposes the Request object as a Tcl variable.

The first time this method is called, the initialization script is sourced into the interpreter, based on the configuration properties in the Request
Parameters:
  hr - The request and associated HTML document that will beprocessed.




tag_server
public void tag_server(RewriteContext hr)(Code)
Processes the <server> tag. Substitues the result of evaluating the following Tcl script into the resultant HTML document.

Note: Currently, there is no mechanism for other language interpreters to share the same server tag.
Parameters:
  hr - The request and associated HTML document that will beprocessed.




Methods inherited from sunlabs.brazil.template.Template
public boolean done(RewriteContext hr)(Code)(Java Doc)
public boolean init(RewriteContext hr)(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.