| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>Session xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/session/Session.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.session; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Date; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * A {@code Session} is a stateful data context associated with a single Subject (user, daemon process,</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * etc) who interacts with a software system over a period of time.</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * A {@code Session} is intended to be managed by the business tier and accessible via other</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * tiers without being tied to any given client technology. This is a <em>great</em> benefit to Java</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * systems, since until now, the only viable session mechanisms were the</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * {@code javax.servlet.http.HttpSession} or Stateful Session EJB's, which many times</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * unnecessarily coupled applications to web or ejb technologies.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> { |
| <a name="38" href="#38">38</a> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Returns the unique identifier assigned by the system upon session creation.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * All return values from this method are expected to have proper {@code toString()},</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * {@code equals()}, and {@code hashCode()} implementations. Good candidates for such</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * an identifier are {@link java.util.UUID UUID}s, {@link java.lang.Integer Integer}s, and</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * {@link java.lang.String String}s.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @return The unique identifier assigned to the session upon creation.</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="49" href="#49">49</a> Serializable getId(); |
| <a name="50" href="#50">50</a> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Returns the time the session was started; that is, the time the system created the instance.</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @return The time the system created the session.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="56" href="#56">56</a> Date getStartTimestamp(); |
| <a name="57" href="#57">57</a> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Returns the last time the application received a request or method invocation from the user associated</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * with this session. Application calls to this method do not affect this access time.</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @return The time the user last interacted with the system.</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @see #touch()</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="65" href="#65">65</a> Date getLastAccessTime(); |
| <a name="66" href="#66">66</a> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Returns the time in milliseconds that the session session may remain idle before expiring.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * <li>A negative return value means the session will never expire.</li></em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <li>A non-negative return value (0 or greater) means the session expiration will occur if idle for that</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * length of time.</li></em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * <b>*Note:</b> if you are used to the {@code HttpSession}'s {@code getMaxInactiveInterval()} method, the scale on</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * this method is different: Shiro Sessions use millisecond values for timeout whereas</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * {@code HttpSession.getMaxInactiveInterval} uses seconds. Always use millisecond values with Shiro sessions.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds the session may remain idle before expiring.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the session has been stopped or expired prior to calling this method.</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">long</strong> getTimeout() <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="83" href="#83">83</a> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Sets the time in milliseconds that the session may remain idle before expiring.</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <li>A negative value means the session will never expire.</li></em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <li>A non-negative value (0 or greater) means the session expiration will occur if idle for that</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * length of time.</li></em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <b>*Note:</b> if you are used to the {@code HttpSession}'s {@code getMaxInactiveInterval()} method, the scale on</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * this method is different: Shiro Sessions use millisecond values for timeout whereas</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * {@code HttpSession.getMaxInactiveInterval} uses seconds. Always use millisecond values with Shiro sessions.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param maxIdleTimeInMillis the time in milliseconds that the session may remain idle before expiring.</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the session has been stopped or expired prior to calling this method.</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">void</strong> setTimeout(<strong class="jxr_keyword">long</strong> maxIdleTimeInMillis) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="101" href="#101">101</a> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Returns the host name or IP string of the host that originated this session, or {@code null}</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * if the host is unknown.</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @return the host name or IP string of the host that originated this session, or {@code null}</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * if the host address is unknown.</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="109" href="#109">109</a> String getHost(); |
| <a name="110" href="#110">110</a> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Explicitly updates the {@link #getLastAccessTime() lastAccessTime} of this session to the current time when</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * this method is invoked. This method can be used to ensure a session does not time out.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Most programmers won't use this method directly and will instead rely on the last access time to be updated</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * automatically as a result of an incoming web request or remote procedure call/method invocation.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * However, this method is particularly useful when supporting rich-client applications such as</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Java Web Start appp, Java or Flash applets, etc. Although rare, it is possible in a rich-client</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * environment that a user continuously interacts with the client-side application without a</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * server-side method call ever being invoked. If this happens over a long enough period of</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * time, the user's server-side session could time-out. Again, such cases are rare since most</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * rich-clients frequently require server-side method invocations.</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * In this example though, the user's session might still be considered valid because</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * the user is actively &quot;using&quot; the application, just not communicating with the</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * server. But because no server-side method calls are invoked, there is no way for the server</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * to know if the user is sitting idle or not, so it must assume so to maintain session</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * integrity. This {@code touch()} method could be invoked by the rich-client application code during those</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * times to ensure that the next time a server-side method is invoked, the invocation will not</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * throw an {@link ExpiredSessionException ExpiredSessionException}. In short terms, it could be used periodically</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * to ensure a session does not time out.</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * How often this rich-client &quot;maintenance&quot; might occur is entirely dependent upon</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * the application and would be based on variables such as session timeout configuration,</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * usage characteristics of the client application, network utilization and application server</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * performance.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if this session has stopped or expired prior to calling this method.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">void</strong> touch() <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="142" href="#142">142</a> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Explicitly stops (invalidates) this session and releases all associated resources.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * If this session has already been authenticated (i.e. the {@code Subject} that</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * owns this session has logged-in), calling this method explicitly might have undesired side effects:</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * It is common for a {@code Subject} implementation to retain authentication state in the</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * {@code Session}. If the session</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * is explicitly stopped by application code by calling this method directly, it could clear out any</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * authentication state that might exist, thereby effectively &quot;unauthenticating&quot; the {@code Subject}.</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * As such, you might consider {@link org.apache.shiro.subject.Subject#logout logging-out} the 'owning'</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * {@code Subject} instead of manually calling this method, as a log out is expected to stop the</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * corresponding session automatically, and also allows framework code to execute additional cleanup logic.</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if this session has stopped or expired prior to calling this method.</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="160" href="#160">160</a> <strong class="jxr_keyword">void</strong> stop() <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="161" href="#161">161</a> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * Returns the keys of all the attributes stored under this session. If there are no</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * attributes, this returns an empty collection.</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @return the keys of all attributes stored under this session, or an empty collection if</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * there are no session attributes.</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if this session has stopped or expired prior to calling this method.</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="171" href="#171">171</a> Collection<Object> getAttributeKeys() <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * Returns the object bound to this session identified by the specified key. If there is no</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * object bound under the key, {@code null} is returned.</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @param key the unique name of the object bound to this session</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @return the object bound under the specified {@code key} name or {@code null} if there is</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * no object bound under that name.</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if this session has stopped or expired prior to calling</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * this method.</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="183" href="#183">183</a> Object getAttribute(Object key) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * Binds the specified {@code value} to this session, uniquely identified by the specifed</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * {@code key} name. If there is already an object bound under the {@code key} name, that</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * existing object will be replaced by the new {@code value}.</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * If the {@code value} parameter is null, it has the same effect as if</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * {@link #removeAttribute(Object) removeAttribute} was called.</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @param key the name under which the {@code value} object will be bound in this session</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @param value the object to bind in this session.</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if this session has stopped or expired prior to calling</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * this method.</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">void</strong> setAttribute(Object key, Object value) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="199" href="#199">199</a> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * Removes (unbinds) the object bound to this session under the specified {@code key} name.</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * @param key the name uniquely identifying the object to remove</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * @return the object removed or {@code null} if there was no object bound under the name</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * {@code key}.</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if this session has stopped or expired prior to calling</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * this method.</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="209" href="#209">209</a> Object removeAttribute(Object key) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a name="210" href="#210">210</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
