| org.apache.cocoon.webapps.session.context.SessionContext
All known Subclasses: org.apache.cocoon.webapps.session.context.RequestSessionContext, org.apache.cocoon.webapps.authentication.context.AuthenticationContext, org.apache.cocoon.webapps.portal.context.SessionContextImpl, org.apache.cocoon.webapps.session.context.SimpleSessionContext,
| 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 | |
| void | appendXML(String path, DocumentFragment fragment)
Append a document fragment at the given path. | | Object | getAttribute(String key)
Get the value of a context attribute. | | Object | getAttribute(String key, Object defaultObject)
Get the value of a context attribute. | | String | getName()
| | NodeList | getNodeList(String path)
Get a copy of all nodes specified by the path. | | Node | getSingleNode(String path)
Get a copy of the first node specified by the path. | | String | getValueOfNode(String path)
Get the value of this node. | | DocumentFragment | getXML(String path)
Get a document fragment. | | void | loadXML(String path, SourceParameters parameters)
Try to load XML into the context. | | void | removeXML(String path)
Remove some content from the context. | | void | saveXML(String path, SourceParameters parameters)
Try to save XML from the context. | | void | setAttribute(String key, Object value)
Set a context attribute.
Attributes over a means to store any data (object) in a session
context. | | void | setNode(String path, Node node)
Set the value of a node. | | void | setValueOfNode(String path, String value)
Set the value of a node. | | void | setXML(String path, DocumentFragment fragment)
Set a document fragment at the given path. | | void | setup(String value, String loadResource, String saveResource)
Set the name of the context. | | boolean | streamXML(String path, ContentHandler contentHandler, LexicalHandler lexicalHandler)
Stream the XML directly to the handler. |
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
|
|