Java Doc for HttpSession.java in  » Sevlet-Container » apache-tomcat-6.0.14 » javax » servlet » http » 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 » apache tomcat 6.0.14 » javax.servlet.http 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.servlet.http.HttpSession

All known Subclasses:   org.apache.catalina.session.StandardSession,  org.apache.catalina.session.StandardSessionFacade,
HttpSession
public interface HttpSession (Code)
Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.

The servlet container uses this interface to create a session between an HTTP client and an HTTP server. The session persists for a specified time period, across more than one connection or page request from the user. A session usually corresponds to one user, who may visit a site many times. The server can maintain a session in many ways such as using cookies or rewriting URLs.

This interface allows servlets to

  • View and manipulate information about a session, such as the session identifier, creation time, and last accessed time
  • Bind objects to sessions, allowing user information to persist across multiple user connections

When an application stores an object in or removes an object from a session, the session checks whether the object implements HttpSessionBindingListener . If it does, the servlet notifies the object that it has been bound to or unbound from the session. Notifications are sent after the binding methods complete. For session that are invalidated or expire, notifications are sent after the session has been invalidated or expired.

When container migrates a session between VMs in a distributed container setting, all session attributes implementing the HttpSessionActivationListener interface are notified.

A servlet should be able to handle cases in which the client does not choose to join a session, such as when cookies are intentionally turned off. Until the client joins the session, isNew returns true. If the client chooses not to join the session, getSession will return a different session on each request, and isNew will always return true.

Session information is scoped only to the current web application (ServletContext), so information stored in one context will not be directly visible in another.
author:
   Various
version:
   $Version$
See Also:   HttpSessionBindingListener
See Also:   HttpSessionContext





Method Summary
public  ObjectgetAttribute(String name)
     Returns the object bound with the specified name in this session, or null if no object is bound under the name.
public  EnumerationgetAttributeNames()
     Returns an Enumeration of String objects containing the names of all the objects bound to this session.
public  longgetCreationTime()
     Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
public  StringgetId()
     Returns a string containing the unique identifier assigned to this session.
public  longgetLastAccessedTime()
     Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.
public  intgetMaxInactiveInterval()
     Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
public  ServletContextgetServletContext()
     Returns the ServletContext to which this session belongs.
public  HttpSessionContextgetSessionContext()
    
public  ObjectgetValue(String name)
    
public  String[]getValueNames()
    
public  voidinvalidate()
     Invalidates this session then unbinds any objects bound to it.
public  booleanisNew()
     Returns true if the client does not yet know about the session or if the client chooses not to join the session.
public  voidputValue(String name, Object value)
    
public  voidremoveAttribute(String name)
     Removes the object bound with the specified name from this session.
public  voidremoveValue(String name)
    
public  voidsetAttribute(String name, Object value)
     Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound.

public  voidsetMaxInactiveInterval(int interval)
     Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.



Method Detail
getAttribute
public Object getAttribute(String name)(Code)
Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Parameters:
  name - a string specifying the name of the object the object with the specified name
exception:
  IllegalStateException - if this method is called on aninvalidated session



getAttributeNames
public Enumeration getAttributeNames()(Code)
Returns an Enumeration of String objects containing the names of all the objects bound to this session. an Enumeration of String objects specifying thenames of all the objects bound tothis session
exception:
  IllegalStateException - if this method is called on aninvalidated session



getCreationTime
public long getCreationTime()(Code)
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT. a long specifyingwhen this session was created,expressed in milliseconds since 1/1/1970 GMT
exception:
  IllegalStateException - if this method is called on aninvalidated session



getId
public String getId()(Code)
Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent. a string specifying the identifierassigned to this session
exception:
  IllegalStateException - if this method is called on aninvalidated session



getLastAccessedTime
public long getLastAccessedTime()(Code)
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time. a longrepresenting the last time the client sent a request associatedwith this session, expressed in milliseconds since 1/1/1970 GMT
exception:
  IllegalStateException - if this method is called on aninvalidated session




getMaxInactiveInterval
public int getMaxInactiveInterval()(Code)
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout. an integer specifying the number ofseconds this session remains openbetween client requests
See Also:   HttpSession.setMaxInactiveInterval



getServletContext
public ServletContext getServletContext()(Code)
Returns the ServletContext to which this session belongs. The ServletContext object for the web application
since:
   2.3



getSessionContext
public HttpSessionContext getSessionContext()(Code)



getValue
public Object getValue(String name)(Code)
HttpSession.getAttribute
Parameters:
  name - a string specifying the name of the object the object with the specified name
exception:
  IllegalStateException - if this method is called on aninvalidated session



getValueNames
public String[] getValueNames()(Code)
HttpSession.getAttributeNames an array of Stringobjects specifying thenames of all the objects bound tothis session
exception:
  IllegalStateException - if this method is called on aninvalidated session



invalidate
public void invalidate()(Code)
Invalidates this session then unbinds any objects bound to it.
exception:
  IllegalStateException - if this method is called on analready invalidated session



isNew
public boolean isNew()(Code)
Returns true if the client does not yet know about the session or if the client chooses not to join the session. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request. true if the server has created a session, but the client has not yet joined
exception:
  IllegalStateException - if this method is called on analready invalidated session



putValue
public void putValue(String name, Object value)(Code)
HttpSession.setAttribute
Parameters:
  name - the name to which the object is bound;cannot be null
Parameters:
  value - the object to be bound; cannot be null
exception:
  IllegalStateException - if this method is called on aninvalidated session



removeAttribute
public void removeAttribute(String name)(Code)
Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueUnbound. The container then notifies any HttpSessionAttributeListeners in the web application.
Parameters:
  name - the name of the object toremove from this session
exception:
  IllegalStateException - if this method is called on aninvalidated session




removeValue
public void removeValue(String name)(Code)
HttpSession.removeAttribute
Parameters:
  name - the name of the object toremove from this session
exception:
  IllegalStateException - if this method is called on aninvalidated session



setAttribute
public void setAttribute(String name, Object value)(Code)
Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application.

If an object was already bound to this session of this name that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

If the value passed in is null, this has the same effect as calling removeAttribute().
Parameters:
  name - the name to which the object is bound;cannot be null
Parameters:
  value - the object to be bound
exception:
  IllegalStateException - if this method is called on aninvalidated session




setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)(Code)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. A negative time indicates the session should never timeout.
Parameters:
  interval - An integer specifying the numberof seconds



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