Java Doc for PortletSession.java in  » Portal » Open-Portal » javax » portlet » 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 » Portal » Open Portal » javax.portlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.portlet.PortletSession

All known Subclasses:   com.sun.portal.portlet.impl.PortletSessionImpl,
PortletSession
public interface PortletSession (Code)
The PortletSession interface provides a way to identify a user across more than one request and to store transient information about that user.

A PortletSession is created per user client per portlet application.

A portlet can bind an object attribute into a PortletSession by name. The PortletSession interface defines two scopes for storing objects:

  • APPLICATION_SCOPE
  • PORTLET_SCOPE
All objects stored in the session using the APPLICATION_SCOPE must be available to all the portlets, servlets and JSPs that belongs to the same portlet application and that handles a request identified as being a part of the same session. Objects stored in the session using the PORTLET_SCOPE must be available to the portlet during requests for the same portlet window that the objects where stored from. Attributes stored in the PORTLET_SCOPE are not protected from other web components of the portlet application. They are just conveniently namespaced.

The portlet session is based on the HttpSession. Therefore all HttpSession listeners do apply to the portlet session and attributes set in the portlet session are visible in the HttpSession and vice versa.



Field Summary
final public static  intAPPLICATION_SCOPE
     This constant defines an application wide scope for the session attribute.
final public static  intPORTLET_SCOPE
     This constant defines the scope of the session attribute to be private to the portlet and its included resources.


Method Summary
public  java.lang.ObjectgetAttribute(java.lang.String name)
     Returns the object bound with the specified name in this session under the PORTLET_SCOPE, or null if no object is bound under the name in that scope.
public  java.lang.ObjectgetAttribute(java.lang.String name, int scope)
     Returns the object bound with the specified name in this session, or null if no object is bound under the name in the given scope.
public  java.util.EnumerationgetAttributeNames()
     Returns an Enumeration of String objects containing the names of all the objects bound to this session under the PORTLET_SCOPE, or an empty Enumeration if no attributes are available.
public  java.util.EnumerationgetAttributeNames(int scope)
     Returns an Enumeration of String objects containing the names of all the objects bound to this session in the given scope, or an empty Enumeration if no attributes are available in the given scope.
public  longgetCreationTime()
     Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
public  java.lang.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.
public  intgetMaxInactiveInterval()
     Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses.
public  PortletContextgetPortletContext()
     Returns the portlet application context associated with this session.
public  voidinvalidate()
     Invalidates this session (all scopes) and 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  voidremoveAttribute(String name)
     Removes the object bound with the specified name under the PORTLET_SCOPE from this session.
public  voidremoveAttribute(String name, int scope)
     Removes the object bound with the specified name and the given scope from this session.
public  voidsetAttribute(java.lang.String name, java.lang.Object value)
     Binds an object to this session under the PORTLET_SCOPE, using the name specified.
public  voidsetAttribute(java.lang.String name, java.lang.Object value, int scope)
     Binds an object to this session in the given scope, using the name specified.
public  voidsetMaxInactiveInterval(int interval)
     Specifies the time, in seconds, between client requests, before the portlet container invalidates this session.

Field Detail
APPLICATION_SCOPE
final public static int APPLICATION_SCOPE(Code)
This constant defines an application wide scope for the session attribute. APPLICATION_SCOPE session attributes enable Portlets within one portlet application to share data.

Portlets may need to prefix attributes set in this scope with some ID, to avoid overwriting each other's attributes in the case where two portlets of the same portlet definition are created.

Value: 0x01




PORTLET_SCOPE
final public static int PORTLET_SCOPE(Code)
This constant defines the scope of the session attribute to be private to the portlet and its included resources.

Value: 0x02






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



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



getAttributeNames
public java.util.Enumeration getAttributeNames()(Code)
Returns an Enumeration of String objects containing the names of all the objects bound to this session under the PORTLET_SCOPE, or an empty Enumeration if no attributes are available. an Enumeration of String objects specifying thenames of all the objects bound tothis session, or an empty Enumeration if no attributes are available.
exception:
  java.lang.IllegalStateException - if this method is called on aninvalidated session



getAttributeNames
public java.util.Enumeration getAttributeNames(int scope)(Code)
Returns an Enumeration of String objects containing the names of all the objects bound to this session in the given scope, or an empty Enumeration if no attributes are available in the given scope.
Parameters:
  scope - session scope of the attribute names an Enumeration of String objects specifying thenames of all the objects bound tothis session, or an empty Enumeration if no attributes are available in the given scope.
exception:
  java.lang.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:
  java.lang.IllegalStateException - if this method is called on aninvalidated session



getId
public java.lang.String getId()(Code)
Returns a string containing the unique identifier assigned to this session. a string specifying the identifierassigned to this 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.

Actions that your portlet 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




getMaxInactiveInterval
public int getMaxInactiveInterval()(Code)
Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses. After this interval, the portlet container invalidates 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:   PortletSession.setMaxInactiveInterval



getPortletContext
public PortletContext getPortletContext()(Code)
Returns the portlet application context associated with this session. the portlet application context



invalidate
public void invalidate()(Code)
Invalidates this session (all scopes) and unbinds any objects bound to it.

Invalidating the portlet session will result in invalidating the underlying HttpSession
exception:
  java.lang.IllegalStateException - if this method is called on asession which has already been invalidated




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. true if the server has created a session, but the client has not joined yet.
exception:
  java.lang.IllegalStateException - if this method is called on asession which has already been invalidated



removeAttribute
public void removeAttribute(String name)(Code)
Removes the object bound with the specified name under the PORTLET_SCOPE from this session. If the session does not have an object bound with the specified name, this method does nothing.
Parameters:
  name - the name of the object to beremoved from this session in the PORTLET_SCOPE.
exception:
  java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
  java.lang.IllegalArgumentException - if name is null.



removeAttribute
public void removeAttribute(String name, int scope)(Code)
Removes the object bound with the specified name and the given scope from this session. If the session does not have an object bound with the specified name, this method does nothing.
Parameters:
  name - the name of the object to beremoved from this session
Parameters:
  scope - session scope of this attribute
exception:
  java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
  java.lang.IllegalArgumentException - if name is null.



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

After this method has been executed, 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 that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

If the value is null, this has the same effect as calling removeAttribute().
Parameters:
  name - the name to which the object is bound underthe PORTLET_SCOPE;this cannot be null.
Parameters:
  value - the object to be bound
exception:
  java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
  java.lang.IllegalArgumentException - if name is null.




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

After this method has been executed, 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 that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

If the value is null, this has the same effect as calling removeAttribute().
Parameters:
  name - the name to which the object is bound;this cannot be null.
Parameters:
  value - the object to be bound
Parameters:
  scope - session scope of this attribute
exception:
  java.lang.IllegalStateException - if this method is called on asession which has been invalidated
exception:
  java.lang.IllegalArgumentException - if name is null.




setMaxInactiveInterval
public void setMaxInactiveInterval(int interval)(Code)
Specifies the time, in seconds, between client requests, before the portlet container invalidates 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.