/usr/share/doc/libportlet-api-2.0-spec-java/api/javax/portlet/PortletSession.html is in libportlet-api-2.0-spec-java-doc 1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Sun Jun 27 09:02:35 UTC 2010 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PortletSession (Java Portlet Specification V2.0 1.0 API)
</TITLE>
<META NAME="date" CONTENT="2010-06-27">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PortletSession (Java Portlet Specification V2.0 1.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PortletSession.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/PortletSessionUtil.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/PortletSession.html" target="_top"><B>FRAMES</B></A>
<A HREF="PortletSession.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.portlet</FONT>
<BR>
Interface PortletSession</H2>
<HR>
<DL>
<DT><PRE>public interface <B>PortletSession</B></DL>
</PRE>
<P>
The <CODE>PortletSession</CODE> interface provides a way to identify a user
across more than one request and to store transient information about that user.
<p>
A <code>PortletSession</code> is created per user client per portlet application.
<p>
A portlet can bind an object attribute into a <code>PortletSession</code> by name.
The <code>PortletSession</code> interface defines two scopes for storing objects:
<ul>
<li><code>APPLICATION_SCOPE</code>
<li><code>PORTLET_SCOPE</code>
</ul>
All objects stored in the session using the <code>APPLICATION_SCOPE</code>
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 <code>PORTLET_SCOPE</code> must be
available to the portlet during requests for the same portlet window
that the objects where stored from. Attributes stored in the
<code>PORTLET_SCOPE</code> are not protected from other web components
of the portlet application. They are just conveniently namespaced.
<P>
The portlet session is based on the <code>HttpSession</code>. Therefore all
<code>HttpSession</code> listeners do apply to the portlet session and
attributes set in the portlet session are visible in the <code>HttpSession</code>
and vice versa.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#APPLICATION_SCOPE">APPLICATION_SCOPE</A></B></CODE>
<BR>
This constant defines an application wide scope for the session attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#PORTLET_SCOPE">PORTLET_SCOPE</A></B></CODE>
<BR>
This constant defines the scope of the session attribute to be
private to the portlet and its included resources.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String name)</CODE>
<BR>
Returns the object bound with the specified name in this session
under the <code>PORTLET_SCOPE</code>, or <code>null</code> if no
object is bound under the name in that scope.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getAttribute(java.lang.String, int)">getAttribute</A></B>(java.lang.String name,
int scope)</CODE>
<BR>
Returns the object bound with the specified name in this session,
or <code>null</code> if no object is bound under the name in the given scope.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getAttributeMap()">getAttributeMap</A></B>()</CODE>
<BR>
Returns a <code>Map</code> of the session attributes in
the portlet session scope.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getAttributeMap(int)">getAttributeMap</A></B>(int scope)</CODE>
<BR>
Returns a <code>Map</code> of the session attributes in
the given session scope.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getAttributeNames()">getAttributeNames</A></B>()</CODE>
<BR>
Returns an <code>Enumeration</code> of String objects containing the names of
all the objects bound to this session under the <code>PORTLET_SCOPE</code>, or an
empty <code>Enumeration</code> if no attributes are available.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getAttributeNames(int)">getAttributeNames</A></B>(int scope)</CODE>
<BR>
Returns an <code>Enumeration</code> of String objects containing the names of
all the objects bound to this session in the given scope, or an
empty <code>Enumeration</code> if no attributes are available in the
given scope.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getCreationTime()">getCreationTime</A></B>()</CODE>
<BR>
Returns the time when this session was created, measured in
milliseconds since midnight January 1, 1970 GMT.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getId()">getId</A></B>()</CODE>
<BR>
Returns a string containing the unique identifier assigned to this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getLastAccessedTime()">getLastAccessedTime</A></B>()</CODE>
<BR>
Returns the last time the client sent a request associated with this session,
as the number of milliseconds since midnight January 1, 1970 GMT.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getMaxInactiveInterval()">getMaxInactiveInterval</A></B>()</CODE>
<BR>
Returns the maximum time interval, in seconds, for which the portlet container
keeps this session open between client accesses.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#getPortletContext()">getPortletContext</A></B>()</CODE>
<BR>
Returns the portlet application context associated with this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#invalidate()">invalidate</A></B>()</CODE>
<BR>
Invalidates this session (all scopes) and unbinds any objects bound to it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#isNew()">isNew</A></B>()</CODE>
<BR>
Returns true if the client does not yet know about the session or
if the client chooses not to join the session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#removeAttribute(java.lang.String)">removeAttribute</A></B>(java.lang.String name)</CODE>
<BR>
Removes the object bound with the specified name under
the <code>PORTLET_SCOPE</code> from
this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#removeAttribute(java.lang.String, int)">removeAttribute</A></B>(java.lang.String name,
int scope)</CODE>
<BR>
Removes the object bound with the specified name and the given scope from
this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></B>(java.lang.String name,
java.lang.Object value)</CODE>
<BR>
Binds an object to this session under the <code>PORTLET_SCOPE</code>, using the name specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#setAttribute(java.lang.String, java.lang.Object, int)">setAttribute</A></B>(java.lang.String name,
java.lang.Object value,
int scope)</CODE>
<BR>
Binds an object to this session in the given scope, using the name specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletSession.html#setMaxInactiveInterval(int)">setMaxInactiveInterval</A></B>(int interval)</CODE>
<BR>
Specifies the time, in seconds, between client requests, before the
portlet container invalidates this session.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="APPLICATION_SCOPE"><!-- --></A><H3>
APPLICATION_SCOPE</H3>
<PRE>
static final int <B>APPLICATION_SCOPE</B></PRE>
<DL>
<DD>This constant defines an application wide scope for the session attribute.
<code>APPLICATION_SCOPE</code> session attributes enable Portlets
within one portlet application to share data.
<p>
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.
<p>
Value: <code>0x01</code>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletSession.APPLICATION_SCOPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PORTLET_SCOPE"><!-- --></A><H3>
PORTLET_SCOPE</H3>
<PRE>
static final int <B>PORTLET_SCOPE</B></PRE>
<DL>
<DD>This constant defines the scope of the session attribute to be
private to the portlet and its included resources.
<p>
Value: <code>0x02</code>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletSession.PORTLET_SCOPE">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
getAttribute</H3>
<PRE>
java.lang.Object <B>getAttribute</B>(java.lang.String name)</PRE>
<DL>
<DD>Returns the object bound with the specified name in this session
under the <code>PORTLET_SCOPE</code>, or <code>null</code> if no
object is bound under the name in that scope.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a string specifying the name of the object
<DT><B>Returns:</B><DD>the object with the specified name for
the <code>PORTLET_SCOPE</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on an
invalidated session.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="getAttribute(java.lang.String, int)"><!-- --></A><H3>
getAttribute</H3>
<PRE>
java.lang.Object <B>getAttribute</B>(java.lang.String name,
int scope)</PRE>
<DL>
<DD>Returns the object bound with the specified name in this session,
or <code>null</code> if no object is bound under the name in the given scope.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a string specifying the name of the object<DD><CODE>scope</CODE> - session scope of this attribute
<DT><B>Returns:</B><DD>the object with the specified name
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on an
invalidated session, or the scope is unknown to the container.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeNames()"><!-- --></A><H3>
getAttributeNames</H3>
<PRE>
java.util.Enumeration<java.lang.String> <B>getAttributeNames</B>()</PRE>
<DL>
<DD>Returns an <code>Enumeration</code> of String objects containing the names of
all the objects bound to this session under the <code>PORTLET_SCOPE</code>, or an
empty <code>Enumeration</code> if no attributes are available.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an <code>Enumeration</code> of
<code>String</code> objects specifying the
names of all the objects bound to
this session, or an empty <code>Enumeration</code>
if no attributes are available.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on an
invalidated session</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeNames(int)"><!-- --></A><H3>
getAttributeNames</H3>
<PRE>
java.util.Enumeration<java.lang.String> <B>getAttributeNames</B>(int scope)</PRE>
<DL>
<DD>Returns an <code>Enumeration</code> of String objects containing the names of
all the objects bound to this session in the given scope, or an
empty <code>Enumeration</code> if no attributes are available in the
given scope.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - session scope of the attribute names
<DT><B>Returns:</B><DD>an <code>Enumeration</code> of
<code>String</code> objects specifying the
names of all the objects bound to
this session, or an empty <code>Enumeration</code>
if no attributes are available in the given scope.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on an
invalidated session, or the scope is unknown to the container.</DL>
</DD>
</DL>
<HR>
<A NAME="getCreationTime()"><!-- --></A><H3>
getCreationTime</H3>
<PRE>
long <B>getCreationTime</B>()</PRE>
<DL>
<DD>Returns the time when this session was created, measured in
milliseconds since midnight January 1, 1970 GMT.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <code>long</code> specifying
when this session was created,
expressed in
milliseconds since 1/1/1970 GMT
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on an
invalidated session</DL>
</DD>
</DL>
<HR>
<A NAME="getId()"><!-- --></A><H3>
getId</H3>
<PRE>
java.lang.String <B>getId</B>()</PRE>
<DL>
<DD>Returns a string containing the unique identifier assigned to this session.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a string specifying the identifier
assigned to this session</DL>
</DD>
</DL>
<HR>
<A NAME="getLastAccessedTime()"><!-- --></A><H3>
getLastAccessedTime</H3>
<PRE>
long <B>getLastAccessedTime</B>()</PRE>
<DL>
<DD>Returns the last time the client sent a request associated with this session,
as the number of milliseconds since midnight January 1, 1970 GMT.
<p>Actions that your portlet takes, such as getting or setting
a value associated with the session, do not affect the access
time.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <code>long</code>
representing the last time
the client sent a request associated
with this session, expressed in
milliseconds since 1/1/1970 GMT</DL>
</DD>
</DL>
<HR>
<A NAME="getMaxInactiveInterval()"><!-- --></A><H3>
getMaxInactiveInterval</H3>
<PRE>
int <B>getMaxInactiveInterval</B>()</PRE>
<DL>
<DD>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 <code>setMaxInactiveInterval</code> method.
A negative time indicates the session should never timeout.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an integer specifying the number of
seconds this session remains open
between client requests<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletSession.html#setMaxInactiveInterval(int)"><CODE>setMaxInactiveInterval(int)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="invalidate()"><!-- --></A><H3>
invalidate</H3>
<PRE>
void <B>invalidate</B>()</PRE>
<DL>
<DD>Invalidates this session (all scopes) and unbinds any objects bound to it.
<p>
Invalidating the portlet session will result in invalidating the underlying
<code>HttpSession</code>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a
session which has already been invalidated</DL>
</DD>
</DL>
<HR>
<A NAME="isNew()"><!-- --></A><H3>
isNew</H3>
<PRE>
boolean <B>isNew</B>()</PRE>
<DL>
<DD>Returns true if the client does not yet know about the session or
if the client chooses not to join the session.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the
server has created a session,
but the client has not joined yet.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a
session which has already been invalidated</DL>
</DD>
</DL>
<HR>
<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
removeAttribute</H3>
<PRE>
void <B>removeAttribute</B>(java.lang.String name)</PRE>
<DL>
<DD>Removes the object bound with the specified name under
the <code>PORTLET_SCOPE</code> from
this session. If the session does not have an object
bound with the specified name, this method does nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the object to be
removed from this session in the
<code> PORTLET_SCOPE</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a
session which has been invalidated
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="removeAttribute(java.lang.String, int)"><!-- --></A><H3>
removeAttribute</H3>
<PRE>
void <B>removeAttribute</B>(java.lang.String name,
int scope)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the object to be
removed from this session<DD><CODE>scope</CODE> - session scope of this attribute
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a
session which has been invalidated
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
void <B>setAttribute</B>(java.lang.String name,
java.lang.Object value)</PRE>
<DL>
<DD>Binds an object to this session under the <code>PORTLET_SCOPE</code>, using the name specified.
If an object of the same name in this scope is already bound to the session,
that object is replaced.
<p>After this method has been executed, and if the new object
implements <code>HttpSessionBindingListener</code>,
the container calls
<code>HttpSessionBindingListener.valueBound</code>. The container then
notifies any <code>HttpSessionAttributeListeners</code> in the web
application.
<p>If an object was already bound to this session
that implements <code>HttpSessionBindingListener</code>, its
<code>HttpSessionBindingListener.valueUnbound</code> method is called.
<p>If the value is <code>null</code>, this has the same effect as calling
<code>removeAttribute()</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to which the object is bound under
the <code>PORTLET_SCOPE</code>;
this cannot be <code>null</code>.<DD><CODE>value</CODE> - the object to be bound
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a
session which has been invalidated
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="setAttribute(java.lang.String, java.lang.Object, int)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
void <B>setAttribute</B>(java.lang.String name,
java.lang.Object value,
int scope)</PRE>
<DL>
<DD>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.
<p>After this method has been executed, and if the new object
implements <code>HttpSessionBindingListener</code>,
the container calls
<code>HttpSessionBindingListener.valueBound</code>. The container then
notifies any <code>HttpSessionAttributeListeners</code> in the web
application.
<p>If an object was already bound to this session
that implements <code>HttpSessionBindingListener</code>, its
<code>HttpSessionBindingListener.valueUnbound</code> method is called.
<p>If the value is <code>null</code>, this has the same effect as calling
<code>removeAttribute()</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to which the object is bound;
this cannot be <code>null</code>.<DD><CODE>value</CODE> - the object to be bound<DD><CODE>scope</CODE> - session scope of this attribute
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a
session which has been invalidated
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code> or scope is unknown to the container.</DL>
</DD>
</DL>
<HR>
<A NAME="setMaxInactiveInterval(int)"><!-- --></A><H3>
setMaxInactiveInterval</H3>
<PRE>
void <B>setMaxInactiveInterval</B>(int interval)</PRE>
<DL>
<DD>Specifies the time, in seconds, between client requests, before the
portlet container invalidates this session. A negative time
indicates the session should never timeout.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>interval</CODE> - An integer specifying the number
of seconds</DL>
</DD>
</DL>
<HR>
<A NAME="getPortletContext()"><!-- --></A><H3>
getPortletContext</H3>
<PRE>
<A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A> <B>getPortletContext</B>()</PRE>
<DL>
<DD>Returns the portlet application context associated with this session.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the portlet application context</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeMap()"><!-- --></A><H3>
getAttributeMap</H3>
<PRE>
java.util.Map<java.lang.String,java.lang.Object> <B>getAttributeMap</B>()</PRE>
<DL>
<DD>Returns a <code>Map</code> of the session attributes in
the portlet session scope.
<p>
The keys are of type <code>String</code> and the values in the
returned <code>Map</code> are from type <code>Object</code>.
<p>
If no session attributes exist this method returns an empty <code>Map</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing the session attributes in the
portlet session scope as keys and attribute values as map values, or an empty <code>Map</code>
if no session attributes exist. The keys in the
map are of type String, the values of type
Object.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeMap(int)"><!-- --></A><H3>
getAttributeMap</H3>
<PRE>
java.util.Map<java.lang.String,java.lang.Object> <B>getAttributeMap</B>(int scope)</PRE>
<DL>
<DD>Returns a <code>Map</code> of the session attributes in
the given session scope.
<p>
The keys are of type <code>String</code> and the values in the
returned <code>Map</code> are from type <code>Object</code>.
<p>
If no session attributes exist this method returns an empty <code>Map</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - session scope of this attribute
<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing the session attributes in the
given scope as keys and attribute values as map values, or an empty <code>Map</code>
if no session attributes exist. The keys in the
map are of type String, the values of type
Object.<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PortletSession.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/PortletSessionUtil.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/PortletSession.html" target="_top"><B>FRAMES</B></A>
<A HREF="PortletSession.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2010. All Rights Reserved.
</BODY>
</HTML>
|