/usr/share/doc/libservlet2.5-java/api/javax/servlet/http/HttpSession.html is in libservlet2.5-java-doc 6.0.45+dfsg-1~deb8u1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_91) on Fri Apr 01 14:23:33 UTC 2016 -->
<title>HttpSession (Tomcat API Documentation)</title>
<meta name="date" content="2016-04-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpSession (Tomcat API Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html" title="class in javax.servlet.http"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/servlet/http/HttpSessionActivationListener.html" title="interface in javax.servlet.http"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/servlet/http/HttpSession.html" target="_top">Frames</a></li>
<li><a href="HttpSession.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.servlet.http</div>
<h2 title="Interface HttpSession" class="title">Interface HttpSession</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">HttpSession</span></pre>
<div class="block">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.
<p>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.
<p>This interface allows servlets to
<ul>
<li>View and manipulate information about a session, such as
the session identifier, creation time, and last accessed time
<li>Bind objects to sessions, allowing user information to persist
across multiple user connections
</ul>
<p>When an application stores an object in or removes an object from a
session, the session checks whether the object implements
<a href="../../../javax/servlet/http/HttpSessionBindingListener.html" title="interface in javax.servlet.http"><code>HttpSessionBindingListener</code></a>. 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.
<p> When container migrates a session between VMs in a distributed container
setting, all session attributes implementing the <a href="../../../javax/servlet/http/HttpSessionActivationListener.html" title="interface in javax.servlet.http"><code>HttpSessionActivationListener</code></a>
interface are notified.
<p>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,
<code>isNew</code> returns <code>true</code>. If the client chooses
not to join
the session, <code>getSession</code> will return a different session
on each request, and <code>isNew</code> will always return
<code>true</code>.
<p>Session information is scoped only to the current web application
(<code>ServletContext</code>), so information stored in one context
will not be directly visible in another.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Various</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpSessionBindingListener.html" title="interface in javax.servlet.http"><code>HttpSessionBindingListener</code></a>,
<a href="../../../javax/servlet/http/HttpSessionContext.html" title="interface in javax.servlet.http"><code>HttpSessionContext</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getAttribute(java.lang.String)">getAttribute</a></strong>(java.lang.String name)</code>
<div class="block">Returns the object bound with the specified name in this session, or
<code>null</code> if no object is bound under the name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getAttributeNames()">getAttributeNames</a></strong>()</code>
<div class="block">Returns an <code>Enumeration</code> of <code>String</code> objects
containing the names of all the objects bound to this session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getCreationTime()">getCreationTime</a></strong>()</code>
<div class="block">Returns the time when this session was created, measured
in milliseconds since midnight January 1, 1970 GMT.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getId()">getId</a></strong>()</code>
<div class="block">Returns a string containing the unique identifier assigned
to this session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getLastAccessedTime()">getLastAccessedTime</a></strong>()</code>
<div class="block">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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getMaxInactiveInterval()">getMaxInactiveInterval</a></strong>()</code>
<div class="block">Returns the maximum time interval, in seconds, that
the servlet container will keep this session open between
client accesses.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getServletContext()">getServletContext</a></strong>()</code>
<div class="block">Returns the ServletContext to which this session belongs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/servlet/http/HttpSessionContext.html" title="interface in javax.servlet.http">HttpSessionContext</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getSessionContext()">getSessionContext</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Version 2.1, this method is
deprecated and has no replacement.
It will be removed in a future
version of the Java Servlet API.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getValue(java.lang.String)">getValue</a></strong>(java.lang.String name)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a>.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getValueNames()">getValueNames</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#getAttributeNames()"><code>getAttributeNames()</code></a></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#invalidate()">invalidate</a></strong>()</code>
<div class="block">Invalidates this session then unbinds any objects bound
to it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#isNew()">isNew</a></strong>()</code>
<div class="block">Returns <code>true</code> if the client does not yet know about the
session or if the client chooses not to join the session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#putValue(java.lang.String,%20java.lang.Object)">putValue</a></strong>(java.lang.String name,
java.lang.Object value)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#setAttribute(java.lang.String,%20java.lang.Object)"><code>setAttribute(java.lang.String, java.lang.Object)</code></a></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#removeAttribute(java.lang.String)">removeAttribute</a></strong>(java.lang.String name)</code>
<div class="block">Removes the object bound with the specified name from
this session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#removeValue(java.lang.String)">removeValue</a></strong>(java.lang.String name)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#removeAttribute(java.lang.String)"><code>removeAttribute(java.lang.String)</code></a></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#setAttribute(java.lang.String,%20java.lang.Object)">setAttribute</a></strong>(java.lang.String name,
java.lang.Object value)</code>
<div class="block">Binds an object to this session, using the name specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#setMaxInactiveInterval(int)">setMaxInactiveInterval</a></strong>(int interval)</code>
<div class="block">Specifies the time, in seconds, between client requests before the
servlet container will invalidate this session.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCreationTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationTime</h4>
<pre>long getCreationTime()</pre>
<div class="block">Returns the time when this session was created, measured
in milliseconds since midnight January 1, 1970 GMT.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>long</code> specifying
when this session was created,
expressed in
milliseconds since 1/1/1970 GMT</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>java.lang.String getId()</pre>
<div class="block">Returns a string containing the unique identifier assigned
to this session. The identifier is assigned
by the servlet container and is implementation dependent.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a string specifying the identifier
assigned to this session</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="getLastAccessedTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastAccessedTime</h4>
<pre>long getLastAccessedTime()</pre>
<div class="block">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.
<p>Actions that your application takes, such as getting or setting
a value associated with the session, do not affect the access
time.</div>
<dl><dt><span class="strong">Returns:</span></dt><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</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="getServletContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletContext</h4>
<pre><a href="../../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a> getServletContext()</pre>
<div class="block">Returns the ServletContext to which this session belongs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ServletContext object for the web application</dd><dt><span class="strong">Since:</span></dt>
<dd>2.3</dd></dl>
</li>
</ul>
<a name="setMaxInactiveInterval(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxInactiveInterval</h4>
<pre>void setMaxInactiveInterval(int interval)</pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - An integer specifying the number
of seconds</dd></dl>
</li>
</ul>
<a name="getMaxInactiveInterval()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxInactiveInterval</h4>
<pre>int getMaxInactiveInterval()</pre>
<div class="block">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 <code>setMaxInactiveInterval</code> method.
A negative time indicates the session should never timeout.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the number of
seconds this session remains open
between client requests</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpSession.html#setMaxInactiveInterval(int)"><code>setMaxInactiveInterval(int)</code></a></dd></dl>
</li>
</ul>
<a name="getSessionContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionContext</h4>
<pre><a href="../../../javax/servlet/http/HttpSessionContext.html" title="interface in javax.servlet.http">HttpSessionContext</a> getSessionContext()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.1, this method is
deprecated and has no replacement.
It will be removed in a future
version of the Java Servlet API.</i></div>
</li>
</ul>
<a name="getAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.Object getAttribute(java.lang.String name)</pre>
<div class="block">Returns the object bound with the specified name in this session, or
<code>null</code> if no object is bound under the name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the object with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="getValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.Object getValue(java.lang.String name)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a>.</i></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the object with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="getAttributeNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNames</h4>
<pre>java.util.Enumeration getAttributeNames()</pre>
<div class="block">Returns an <code>Enumeration</code> of <code>String</code> objects
containing the names of all the objects bound to this session.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of
<code>String</code> objects specifying the
names of all the objects bound to
this session</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="getValueNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueNames</h4>
<pre>java.lang.String[] getValueNames()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#getAttributeNames()"><code>getAttributeNames()</code></a></i></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array of <code>String</code>
objects specifying the
names of all the objects bound to
this session</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="setAttribute(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>void setAttribute(java.lang.String name,
java.lang.Object value)</pre>
<div class="block">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.
<p>After this method executes, and if the new object
implements <code>HttpSessionBindingListener</code>,
the container calls
<code>HttpSessionBindingListener.valueBound</code>. The container then
notifies any <code>HttpSessionAttributeListener</code>s in the web
application.
<p>If an object was already bound to this session of this name
that implements <code>HttpSessionBindingListener</code>, its
<code>HttpSessionBindingListener.valueUnbound</code> method is called.
<p>If the value passed in is null, this has the same effect as calling
<code>removeAttribute()</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to which the object is bound;
cannot be null</dd><dd><code>value</code> - the object to be bound</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="putValue(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putValue</h4>
<pre>void putValue(java.lang.String name,
java.lang.Object value)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#setAttribute(java.lang.String,%20java.lang.Object)"><code>setAttribute(java.lang.String, java.lang.Object)</code></a></i></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to which the object is bound;
cannot be null</dd><dd><code>value</code> - the object to be bound; cannot be null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="removeAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAttribute</h4>
<pre>void removeAttribute(java.lang.String name)</pre>
<div class="block">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.
<p>After this method executes, and if the object
implements <code>HttpSessionBindingListener</code>,
the container calls
<code>HttpSessionBindingListener.valueUnbound</code>. The container
then notifies any <code>HttpSessionAttributeListener</code>s in the web
application.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the object to
remove from this session</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="removeValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeValue</h4>
<pre>void removeValue(java.lang.String name)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is
replaced by <a href="../../../javax/servlet/http/HttpSession.html#removeAttribute(java.lang.String)"><code>removeAttribute(java.lang.String)</code></a></i></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the object to
remove from this session</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
invalidated session</dd></dl>
</li>
</ul>
<a name="invalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidate</h4>
<pre>void invalidate()</pre>
<div class="block">Invalidates this session then unbinds any objects bound
to it.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
already invalidated session</dd></dl>
</li>
</ul>
<a name="isNew()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isNew</h4>
<pre>boolean isNew()</pre>
<div class="block">Returns <code>true</code> 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.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the
server has created a session,
but the client has not yet joined</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this method is called on an
already invalidated session</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html" title="class in javax.servlet.http"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/servlet/http/HttpSessionActivationListener.html" title="interface in javax.servlet.http"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/servlet/http/HttpSession.html" target="_top">Frames</a></li>
<li><a href="HttpSession.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|