| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>HttpSessionBindingEvent</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HttpSessionBindingEvent"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="../../../jakarta/servlet/http/HttpSessionAttributeListener.html" title="interface in jakarta.servlet.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/servlet/http/HttpSessionBindingListener.html" title="interface in jakarta.servlet.http"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/servlet/http/HttpSessionBindingEvent.html" target="_top">Frames</a></li> |
| <li><a href="HttpSessionBindingEvent.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><a href="#fields.inherited.from.class.java.util.EventObject">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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">jakarta.servlet.http</div> |
| <h2 title="Class HttpSessionBindingEvent" class="title">Class HttpSessionBindingEvent</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.util.EventObject</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../jakarta/servlet/http/HttpSessionEvent.html" title="class in jakarta.servlet.http">jakarta.servlet.http.HttpSessionEvent</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.servlet.http.HttpSessionBindingEvent</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HttpSessionBindingEvent</span> |
| extends <a href="../../../jakarta/servlet/http/HttpSessionEvent.html" title="class in jakarta.servlet.http">HttpSessionEvent</a></pre> |
| <div class="block">Events of this type are either sent to an object that implements <a href="../../../jakarta/servlet/http/HttpSessionBindingListener.html" title="interface in jakarta.servlet.http"><code>HttpSessionBindingListener</code></a> when it is bound |
| or unbound from a session, or to a <a href="../../../jakarta/servlet/http/HttpSessionAttributeListener.html" title="interface in jakarta.servlet.http"><code>HttpSessionAttributeListener</code></a> that has been configured in the deployment |
| descriptor when any attribute is bound, unbound or replaced in a session. |
| |
| <p> |
| The session binds the object by a call to <code>HttpSession.setAttribute</code> and unbinds the object by a call to |
| <code>HttpSession.removeAttribute</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/servlet/http/HttpSession.html" title="interface in jakarta.servlet.http"><code>HttpSession</code></a>, |
| <a href="../../../jakarta/servlet/http/HttpSessionBindingListener.html" title="interface in jakarta.servlet.http"><code>HttpSessionBindingListener</code></a>, |
| <a href="../../../jakarta/servlet/http/HttpSessionAttributeListener.html" title="interface in jakarta.servlet.http"><code>HttpSessionAttributeListener</code></a>, |
| <a href="../../../serialized-form.html#jakarta.servlet.http.HttpSessionBindingEvent">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.java.util.EventObject"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class java.util.EventObject</h3> |
| <code>source</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/http/HttpSessionBindingEvent.html#HttpSessionBindingEvent-jakarta.servlet.http.HttpSession-java.lang.String-">HttpSessionBindingEvent</a></span>(<a href="../../../jakarta/servlet/http/HttpSession.html" title="interface in jakarta.servlet.http">HttpSession</a> session, |
| java.lang.String name)</code> |
| <div class="block">Constructs an event that notifies an object that it has been bound to or unbound from a session.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/http/HttpSessionBindingEvent.html#HttpSessionBindingEvent-jakarta.servlet.http.HttpSession-java.lang.String-java.lang.Object-">HttpSessionBindingEvent</a></span>(<a href="../../../jakarta/servlet/http/HttpSession.html" title="interface in jakarta.servlet.http">HttpSession</a> session, |
| java.lang.String name, |
| java.lang.Object value)</code> |
| <div class="block">Constructs an event that notifies an object that it has been bound to or unbound from a session.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/http/HttpSessionBindingEvent.html#getName--">getName</a></span>()</code> |
| <div class="block">Returns the name with which the attribute is bound to or unbound from the session.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/http/HttpSessionBindingEvent.html#getValue--">getValue</a></span>()</code> |
| <div class="block">Returns the value of the attribute that has been added, removed or replaced.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.servlet.http.HttpSessionEvent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class jakarta.servlet.http.<a href="../../../jakarta/servlet/http/HttpSessionEvent.html" title="class in jakarta.servlet.http">HttpSessionEvent</a></h3> |
| <code><a href="../../../jakarta/servlet/http/HttpSessionEvent.html#getSession--">getSession</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.util.EventObject</h3> |
| <code>getSource, toString</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HttpSessionBindingEvent-jakarta.servlet.http.HttpSession-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HttpSessionBindingEvent</h4> |
| <pre>public HttpSessionBindingEvent(<a href="../../../jakarta/servlet/http/HttpSession.html" title="interface in jakarta.servlet.http">HttpSession</a> session, |
| java.lang.String name)</pre> |
| <div class="block">Constructs an event that notifies an object that it has been bound to or unbound from a session. To receive the |
| event, the object must implement <a href="../../../jakarta/servlet/http/HttpSessionBindingListener.html" title="interface in jakarta.servlet.http"><code>HttpSessionBindingListener</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to which the object is bound or unbound</dd> |
| <dd><code>name</code> - the name with which the object is bound or unbound</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/servlet/http/HttpSessionBindingEvent.html#getName--"><code>getName()</code></a>, |
| <a href="../../../jakarta/servlet/http/HttpSessionEvent.html#getSession--"><code>HttpSessionEvent.getSession()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HttpSessionBindingEvent-jakarta.servlet.http.HttpSession-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpSessionBindingEvent</h4> |
| <pre>public HttpSessionBindingEvent(<a href="../../../jakarta/servlet/http/HttpSession.html" title="interface in jakarta.servlet.http">HttpSession</a> session, |
| java.lang.String name, |
| java.lang.Object value)</pre> |
| <div class="block">Constructs an event that notifies an object that it has been bound to or unbound from a session. To receive the |
| event, the object must implement <a href="../../../jakarta/servlet/http/HttpSessionBindingListener.html" title="interface in jakarta.servlet.http"><code>HttpSessionBindingListener</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to which the object is bound or unbound</dd> |
| <dd><code>name</code> - the name with which the object is bound or unbound</dd> |
| <dd><code>value</code> - the object that is bound or unbound</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/servlet/http/HttpSessionBindingEvent.html#getName--"><code>getName()</code></a>, |
| <a href="../../../jakarta/servlet/http/HttpSessionEvent.html#getSession--"><code>HttpSessionEvent.getSession()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public java.lang.String getName()</pre> |
| <div class="block">Returns the name with which the attribute is bound to or unbound from the session.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string specifying the name with which the object is bound to or unbound from the session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>public java.lang.Object getValue()</pre> |
| <div class="block">Returns the value of the attribute that has been added, removed or replaced. If the attribute was added (or bound), |
| this is the value of the attribute. If the attribute was removed (or unbound), this is the value of the removed |
| attribute. If the attribute was replaced, this is the old value of the attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the attribute that has been added, removed or replaced</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Servlet 2.3</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="../../../jakarta/servlet/http/HttpSessionAttributeListener.html" title="interface in jakarta.servlet.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/servlet/http/HttpSessionBindingListener.html" title="interface in jakarta.servlet.http"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/servlet/http/HttpSessionBindingEvent.html" target="_top">Frames</a></li> |
| <li><a href="HttpSessionBindingEvent.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><a href="#fields.inherited.from.class.java.util.EventObject">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
