Java Doc for TurbineSessionService.java in  » Web-Framework » TURBINE » org » apache » turbine » services » 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 » Web Framework » TURBINE » org.apache.turbine.services.session 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.turbine.services.TurbineBaseService
   org.apache.turbine.services.session.TurbineSessionService

TurbineSessionService
public class TurbineSessionService extends TurbineBaseService implements SessionService(Code)
The SessionService allows thread-safe access to the current sessions of the current context. The session objects that are cached by this service are obtained through a listener, which must be configured via your web application's web.xml deployement descriptor as follows:
 <listener>
 <listener-class>
 org.apache.turbine.session.SessionListener
 </listener-class>
 </listener>
 

author:
   Quinton McCombs
author:
   Daniel Rall
since:
   2.3
version:
   $Id: TurbineSessionService.java 534527 2007-05-02 16:10:59Z tv $
See Also:   org.apache.turbine.services.session.TurbineSession
See Also:   org.apache.turbine.services.session.SessionListener




Method Summary
public  voidaddSession(HttpSession session)
     Adds a session to the current list.
public  CollectiongetActiveSessions()
     Gets a list of the active sessions.
public  CollectiongetActiveUsers()
     Gets a collection of all user objects representing the users currently logged in.
public  HttpSessiongetSession(String sessionId)
     Gets the HttpSession by the session identifier
Parameters:
  sessionId - The unique session identifier.
public  CollectiongetSessionsForUser(User user)
     Get a collection of all session on which the given user is logged in.
public  UsergetUserFromSession(HttpSession session)
     Gets the User object of the the specified HttpSession.
Parameters:
  session - The session from which to extract a user.
public  voidinit()
    
public  booleanisUserLoggedIn(User user)
     Determines if a given user is currently logged in.
public  voidremoveSession(HttpSession session)
     Removes a session from the current list.
public  voidshutdown()
     Returns to uninitialized state.



Method Detail
addSession
public void addSession(HttpSession session)(Code)
Adds a session to the current list. This method should only be called by the listener.
Parameters:
  session - Session to add



getActiveSessions
public Collection getActiveSessions()(Code)
Gets a list of the active sessions. A copy of the list of HttpSession objects.



getActiveUsers
public Collection getActiveUsers()(Code)
Gets a collection of all user objects representing the users currently logged in. This will exclude any instances of anonymous user that Turbine will use before the user actually logs on. A set of org.apache.turbine.om.security.User objects.



getSession
public HttpSession getSession(String sessionId)(Code)
Gets the HttpSession by the session identifier
Parameters:
  sessionId - The unique session identifier. The session keyed by the specified identifier.



getSessionsForUser
public Collection getSessionsForUser(User user)(Code)
Get a collection of all session on which the given user is logged in.
Parameters:
  user - the user Collection of HtttSession objects



getUserFromSession
public User getUserFromSession(HttpSession session)(Code)
Gets the User object of the the specified HttpSession.
Parameters:
  session - The session from which to extract a user. The Turbine User object.



init
public void init()(Code)
Initializes the service



isUserLoggedIn
public boolean isUserLoggedIn(User user)(Code)
Determines if a given user is currently logged in. The actual implementation of the User object must implement the equals() method. By default, Torque based objects (liek TurbineUser) have an implementation of equals() that will compare the result of getPrimaryKey().
Parameters:
  user - User to check for true if the user is logged in on one of theactive sessions.



removeSession
public void removeSession(HttpSession session)(Code)
Removes a session from the current list. This method should only be called by the listener.
Parameters:
  session - Session to remove



shutdown
public void shutdown()(Code)
Returns to uninitialized state.



Methods inherited from org.apache.turbine.services.TurbineBaseService
public void init(Object data) throws InitializationException(Code)(Java Doc)
public void init(ServletConfig config) throws InitializationException(Code)(Java Doc)
public void init(RunData data) throws InitializationException(Code)(Java Doc)
public void init() throws InitializationException(Code)(Java Doc)
public void shutdown()(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.