Java Doc for SessionContext.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » webapps » session » context » 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 » Content Management System » apache lenya 2.0 » org.apache.cocoon.webapps.session.context 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.cocoon.webapps.session.context.SessionContext

All known Subclasses:   org.apache.cocoon.webapps.session.context.RequestSessionContext,  org.apache.cocoon.webapps.session.context.SimpleSessionContext,  org.apache.cocoon.webapps.authentication.context.AuthenticationContext,  org.apache.cocoon.webapps.portal.context.SessionContextImpl,
SessionContext
public interface SessionContext extends Serializable(Code)
Interface for a SessionContext. This interface describes a SessionContext. The SessionContext is a data container containing structured XML which can be retrieved/set by the session transformer. This interface does not specify how the session context stores the data. This is left to the implementation itself, but actually this interface is build in the DOM model. As this context is used in a web context, all methods must be synchronized.
author:
   Carsten Ziegeler
version:
   CVS $Id: SessionContext.java 433543 2006-08-22 06:22:54Z crossley $




Method Summary
 voidappendXML(String path, DocumentFragment fragment)
     Append a document fragment at the given path.
 ObjectgetAttribute(String key)
     Get the value of a context attribute.
 ObjectgetAttribute(String key, Object defaultObject)
     Get the value of a context attribute.
 StringgetName()
    
 NodeListgetNodeList(String path)
     Get a copy of all nodes specified by the path.
 NodegetSingleNode(String path)
     Get a copy of the first node specified by the path.
 StringgetValueOfNode(String path)
     Get the value of this node.
 DocumentFragmentgetXML(String path)
     Get a document fragment.
 voidloadXML(String path, SourceParameters parameters)
     Try to load XML into the context.
 voidremoveXML(String path)
     Remove some content from the context.
 voidsaveXML(String path, SourceParameters parameters)
     Try to save XML from the context.
 voidsetAttribute(String key, Object value)
     Set a context attribute. Attributes over a means to store any data (object) in a session context.
 voidsetNode(String path, Node node)
     Set the value of a node.
 voidsetValueOfNode(String path, String value)
     Set the value of a node.
 voidsetXML(String path, DocumentFragment fragment)
     Set a document fragment at the given path.
 voidsetup(String value, String loadResource, String saveResource)
     Set the name of the context.
 booleanstreamXML(String path, ContentHandler contentHandler, LexicalHandler lexicalHandler)
     Stream the XML directly to the handler.



Method Detail
appendXML
void appendXML(String path, DocumentFragment fragment) throws ProcessingException(Code)
Append a document fragment at the given path. The implementation of this method is context specific. Usually the children of the fragment are appended as new children of the node specified by the path. If the path is not existent it is created and this method should work in the same way as setXML.



getAttribute
Object getAttribute(String key) throws ProcessingException(Code)
Get the value of a context attribute. If the attribute is not available return null.



getAttribute
Object getAttribute(String key, Object defaultObject) throws ProcessingException(Code)
Get the value of a context attribute. If the attribute is not available the return the defaultObject.



getName
String getName()(Code)
Get the name of the context



getNodeList
NodeList getNodeList(String path) throws ProcessingException(Code)
Get a copy of all nodes specified by the path.



getSingleNode
Node getSingleNode(String path) throws ProcessingException(Code)
Get a copy of the first node specified by the path. If the node does not exist, null is returned.



getValueOfNode
String getValueOfNode(String path) throws ProcessingException(Code)
Get the value of this node. This is similiar to the xsl:value-of function. If the node does not exist, null is returned.



getXML
DocumentFragment getXML(String path) throws ProcessingException(Code)
Get a document fragment. If the node specified by the path exist, its content is returned as a DocumentFragment. If the node does not exists, null is returned.



loadXML
void loadXML(String path, SourceParameters parameters) throws SAXException, ProcessingException, IOException(Code)
Try to load XML into the context. If the context does not provide the ability of loading, an exception is thrown.



removeXML
void removeXML(String path) throws ProcessingException(Code)
Remove some content from the context. The implementation of this method is context specific. Usually this method should remove all children of the node specified by the path.



saveXML
void saveXML(String path, SourceParameters parameters) throws SAXException, ProcessingException, IOException(Code)
Try to save XML from the context. If the context does not provide the ability of saving, an exception is thrown.



setAttribute
void setAttribute(String key, Object value) throws ProcessingException(Code)
Set a context attribute. Attributes over a means to store any data (object) in a session context. If value is null the attribute is removed. If already an attribute exists with the same key, the value is overwritten with the new one.



setNode
void setNode(String path, Node node) throws ProcessingException(Code)
Set the value of a node. The node is copied before insertion.



setValueOfNode
void setValueOfNode(String path, String value) throws ProcessingException(Code)
Set the value of a node. All children of the node are removed beforehand and one single text node with the given value is appended to the node.



setXML
void setXML(String path, DocumentFragment fragment) throws ProcessingException(Code)
Set a document fragment at the given path. The implementation of this method is context specific. Usually all children of the node specified by the path are removed and the children of the fragment are inserted as new children. If the path is not existent it is created.



setup
void setup(String value, String loadResource, String saveResource)(Code)
Set the name of the context. This method must be invoked in the init phase. In addition a load and a save resource can be provided.



streamXML
boolean streamXML(String path, ContentHandler contentHandler, LexicalHandler lexicalHandler) throws SAXException, ProcessingException(Code)
Stream the XML directly to the handler. This streams the contents of getXML() to the given handler without creating a DocumentFragment containing a copy of the data. If no data is available (if the path does not exist) false is returned, otherwise true.



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