Java Doc for Session.java in  » Sevlet-Container » tomcat-catalina » org » apache » catalina » 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 » Sevlet Container » tomcat catalina » org.apache.catalina 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.catalina.Session

All known Subclasses:   org.apache.catalina.session.StandardSession,
Session
public interface Session (Code)
A Session is the Catalina-internal facade for an HttpSession that is used to maintain state information between requests for a particular user of a web application.
author:
   Craig R. McClanahan
version:
   $Revision: 1.4 $ $Date: 2004/02/27 14:58:39 $


Field Summary
final public static  StringSESSION_CREATED_EVENT
     The SessionEvent event type when a session is created.
final public static  StringSESSION_DESTROYED_EVENT
     The SessionEvent event type when a session is destroyed.


Method Summary
public  voidaccess()
     Update the accessed time information for this session.
public  voidaddSessionListener(SessionListener listener)
     Add a session event listener to this component.
public  voidendAccess()
     End access to the session.
public  voidexpire()
     Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.
public  StringgetAuthType()
     Return the authentication type used to authenticate our cached Principal, if any.
public  longgetCreationTime()
     Return the creation time for this session.
public  StringgetId()
     Return the session identifier for this session.
public  StringgetInfo()
     Return descriptive information about this Session implementation and the corresponding version number, in the format <description>/<version>.
public  longgetLastAccessedTime()
     Return the last time the client sent a request associated with this session, as the number of milliseconds since midnight, January 1, 1970 GMT.
public  ManagergetManager()
     Return the Manager within which this Session is valid.
public  intgetMaxInactiveInterval()
     Return the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session.
public  ObjectgetNote(String name)
     Return the object bound with the specified name to the internal notes for this session, or null if no such binding exists.
public  IteratorgetNoteNames()
     Return an Iterator containing the String names of all notes bindings that exist for this session.
public  PrincipalgetPrincipal()
     Return the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request.
public  HttpSessiongetSession()
     Return the HttpSession for which this object is the facade.
public  booleanisValid()
     Return the isValid flag for this session.
public  voidrecycle()
     Release all object references, and initialize instance variables, in preparation for reuse of this object.
public  voidremoveNote(String name)
     Remove any object bound to the specified name in the internal notes for this session.
public  voidremoveSessionListener(SessionListener listener)
     Remove a session event listener from this component.
public  voidsetAuthType(String authType)
     Set the authentication type used to authenticate our cached Principal, if any.
public  voidsetCreationTime(long time)
     Set the creation time for this session.
public  voidsetId(String id)
     Set the session identifier for this session.
public  voidsetManager(Manager manager)
     Set the Manager within which this Session is valid.
public  voidsetMaxInactiveInterval(int interval)
     Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session.
public  voidsetNew(boolean isNew)
     Set the isNew flag for this session.
public  voidsetNote(String name, Object value)
     Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.
public  voidsetPrincipal(Principal principal)
     Set the authenticated Principal that is associated with this Session.
public  voidsetValid(boolean isValid)
     Set the isValid flag for this session.

Field Detail
SESSION_CREATED_EVENT
final public static String SESSION_CREATED_EVENT(Code)
The SessionEvent event type when a session is created.



SESSION_DESTROYED_EVENT
final public static String SESSION_DESTROYED_EVENT(Code)
The SessionEvent event type when a session is destroyed.





Method Detail
access
public void access()(Code)
Update the accessed time information for this session. This method should be called by the context when a request comes in for a particular session, even if the application does not reference it.



addSessionListener
public void addSessionListener(SessionListener listener)(Code)
Add a session event listener to this component.



endAccess
public void endAccess()(Code)
End access to the session.



expire
public void expire()(Code)
Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.



getAuthType
public String getAuthType()(Code)
Return the authentication type used to authenticate our cached Principal, if any.



getCreationTime
public long getCreationTime()(Code)
Return the creation time for this session.



getId
public String getId()(Code)
Return the session identifier for this session.



getInfo
public String getInfo()(Code)
Return descriptive information about this Session implementation and the corresponding version number, in the format <description>/<version>.



getLastAccessedTime
public long getLastAccessedTime()(Code)
Return the last time the client sent a request associated with this session, as the number of milliseconds since midnight, January 1, 1970 GMT. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.



getManager
public Manager getManager()(Code)
Return the Manager within which this Session is valid.



getMaxInactiveInterval
public int getMaxInactiveInterval()(Code)
Return the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.



getNote
public Object getNote(String name)(Code)
Return the object bound with the specified name to the internal notes for this session, or null if no such binding exists.
Parameters:
  name - Name of the note to be returned



getNoteNames
public Iterator getNoteNames()(Code)
Return an Iterator containing the String names of all notes bindings that exist for this session.



getPrincipal
public Principal getPrincipal()(Code)
Return the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request. If there is no current associated Principal, return null.



getSession
public HttpSession getSession()(Code)
Return the HttpSession for which this object is the facade.



isValid
public boolean isValid()(Code)
Return the isValid flag for this session.



recycle
public void recycle()(Code)
Release all object references, and initialize instance variables, in preparation for reuse of this object.



removeNote
public void removeNote(String name)(Code)
Remove any object bound to the specified name in the internal notes for this session.
Parameters:
  name - Name of the note to be removed



removeSessionListener
public void removeSessionListener(SessionListener listener)(Code)
Remove a session event listener from this component.



setAuthType
public void setAuthType(String authType)(Code)
Set the authentication type used to authenticate our cached Principal, if any.
Parameters:
  authType - The new cached authentication type



setCreationTime
public void setCreationTime(long time)(Code)
Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.
Parameters:
  time - The new creation time



setId
public void setId(String id)(Code)
Set the session identifier for this session.
Parameters:
  id - The new session identifier



setManager
public void setManager(Manager manager)(Code)
Set the Manager within which this Session is valid.
Parameters:
  manager - The new Manager



setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)(Code)
Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.
Parameters:
  interval - The new maximum interval



setNew
public void setNew(boolean isNew)(Code)
Set the isNew flag for this session.
Parameters:
  isNew - The new value for the isNew flag



setNote
public void setNote(String name, Object value)(Code)
Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.
Parameters:
  name - Name to which the object should be bound
Parameters:
  value - Object to be bound to the specified name



setPrincipal
public void setPrincipal(Principal principal)(Code)
Set the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request.
Parameters:
  principal - The new Principal, or null if none



setValid
public void setValid(boolean isValid)(Code)
Set the isValid flag for this session.
Parameters:
  isValid - The new value for the isValid flag



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