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


001:        /*
002:         * Licensed to the Apache Software Foundation (ASF) under one or more
003:         * contributor license agreements.  See the NOTICE file distributed with
004:         * this work for additional information regarding copyright ownership.
005:         * The ASF licenses this file to You under the Apache License, Version 2.0
006:         * (the "License"); you may not use this file except in compliance with
007:         * the License.  You may obtain a copy of the License at
008:         * 
009:         *      http://www.apache.org/licenses/LICENSE-2.0
010:         * 
011:         * Unless required by applicable law or agreed to in writing, software
012:         * distributed under the License is distributed on an "AS IS" BASIS,
013:         * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014:         * See the License for the specific language governing permissions and
015:         * limitations under the License.
016:         */
017:        package org.apache.cocoon.webapps.session;
018:
019:        import org.apache.cocoon.ProcessingException;
020:        import org.apache.cocoon.environment.Session;
021:        import org.apache.cocoon.xml.XMLConsumer;
022:        import org.w3c.dom.DocumentFragment;
023:        import org.xml.sax.SAXException;
024:
025:        /** 
026:         * 
027:         *  This is the session manager component.
028:         *
029:         *  The main purpose of this component is creating and termination sessions
030:         *
031:         * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
032:         * @deprecated This block is deprecated and will be removed in future versions.
033:         * @version CVS $Id: SessionManager.java 433543 2006-08-22 06:22:54Z crossley $
034:         */
035:        public interface SessionManager {
036:
037:            /** Avalon role */
038:            String ROLE = SessionManager.class.getName();;
039:
040:            /**
041:             *  Create a new session for the user.
042:             *  A new session is created for this user. If the user has already a session,
043:             *  no new session is created and the old one is returned.
044:             */
045:            Session createSession();
046:
047:            /**
048:             * Get the session for the current user.
049:             * If the user has no session right now, <CODE>null</CODE> is returned.
050:             * If createFlag is true, the session is created if it does not exist.
051:             */
052:            Session getSession(boolean createFlag);
053:
054:            /**
055:             *  Terminate the current session.
056:             *  If the user has a session, this session is terminated and all of its
057:             *  data is deleted.
058:             *  @param force If this is set to true the session is terminated, if
059:             *                   it is set to false, the session is only terminated
060:             *                   if no session context is available.
061:             */
062:            void terminateSession(boolean force) throws ProcessingException;
063:
064:            /**
065:             * Get information from the context.
066:             * A document fragment containg the xml data stored in the session context
067:             * with the given name is returned. If the information is not available,
068:             * <CODE>null</CODE> is returned.
069:             * @param contextName The name of the public context.
070:             * @param path        XPath expression specifying which data to get.
071:             * @return A DocumentFragment containing the data or <CODE>null</CODE>
072:             */
073:            DocumentFragment getContextFragment(String contextName, String path)
074:                    throws ProcessingException;
075:
076:            /**
077:             * Stream public context data.
078:             * The document fragment containing the data from a path in the
079:             * given context is streamed to the consumer.
080:             *
081:             * @param contextName The name of the public context.
082:             * @param path        XPath expression specifying which data to get.
083:             *
084:             * @return If the data is available <code>true</code> is returned,
085:             *         otherwise <code>false</code> is returned.
086:             */
087:            boolean streamContextFragment(String contextName, String path,
088:                    XMLConsumer consumer) throws SAXException,
089:                    ProcessingException;
090:
091:            /**
092:             * Set data in a public context.
093:             * The document fragment containing the data is set at the given path in the
094:             * public session context.
095:             *
096:             * @param contextName The name of the public context.
097:             * @param path        XPath expression specifying where to set the data.
098:             * @param fragment    The DocumentFragment containing the data.
099:             *
100:             */
101:            void setContextFragment(String contextName, String path,
102:                    DocumentFragment fragment) throws ProcessingException;
103:
104:            /**
105:             * Append data in a public context.
106:             * The document fragment containing the data is appended at the given
107:             * path in the public session context.
108:             *
109:             * @param contextName The name of the public context.
110:             * @param path        XPath expression specifying where to append the data.
111:             * @param fragment    The DocumentFragment containing the data.
112:             *
113:             */
114:            void appendContextFragment(String contextName, String path,
115:                    DocumentFragment fragment) throws ProcessingException;
116:
117:            /**
118:             * Merge data in a public context.
119:             * The document fragment containing the data is merged at the given
120:             * path in the public session context.
121:             *
122:             * @param contextName The name of the public context.
123:             * @param path        XPath expression specifying where to merge the data.
124:             * @param fragment    The DocumentFragment containing the data.
125:             *
126:             */
127:            void mergeContextFragment(String contextName, String path,
128:                    DocumentFragment fragment) throws ProcessingException;
129:
130:            /**
131:             * Remove data in a public context.
132:             * The data specified by the path is removed from the public session context.
133:             *
134:             * @param contextName The name of the public context.
135:             * @param path        XPath expression specifying where to merge the data.
136:             *
137:             */
138:            void removeContextFragment(String contextName, String path)
139:                    throws ProcessingException;
140:
141:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.