| <!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=UTF-8" /> |
| <title>NativeSessionManager xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/session/mgt/NativeSessionManager.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Copyright 2008 Les Hazlewood</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.session.mgt; |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.InvalidSessionException; |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Date; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * A {@code Native} session manager is one that manages sessions natively - that is, it is directly responsible</em> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * for the creation, persistence and removal of {@link org.apache.shiro.session.Session Session} instances and their</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * lifecycles.</em> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html">NativeSessionManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html">SessionManager</a> { |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Returns the time the associated {@code Session} started (was created).</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @return the time the specified {@code Session} started (was created).</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#getStartTimestamp()</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> Date getStartTimestamp(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key); |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Returns the time the associated {@code Session} last interacted with the system.</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @return time the session last accessed the system</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#getLastAccessTime()</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#touch()</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> Date getLastAccessTime(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key); |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the associated session is valid (it exists and is not stopped nor expired),</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @return {@code true} if the session is valid (exists and is not stopped or expired), {@code false} otherwise.</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">boolean</strong> isValid(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key); |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Returns quietly if the associated session is valid (it exists and is not stopped or expired) or throws</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * an {@link org.apache.shiro.session.InvalidSessionException} indicating that the session id is invalid. This</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * might be preferred to be used instead of {@link #isValid} since any exception thrown will definitively explain</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * the reason for invalidation.</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.session.InvalidSessionException</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * if the session id is invalid (it does not exist or it is stopped or expired).</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">void</strong> checkValid(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Returns the time in milliseconds that the associated session may remain idle before expiring.</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <li>A negative return value means the session will never expire.</li></em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</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 class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * length of time.</li></em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @return the time in milliseconds that the associated session may remain idle before expiring.</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.session.InvalidSessionException</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * if the session has been stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">long</strong> getTimeout(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Sets the time in milliseconds that the associated session may remain idle before expiring.</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * <li>A negative return value means the session will never expire.</li></em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</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 class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * length of time.</li></em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @param maxIdleTimeInMillis the time in milliseconds that the associated session may remain idle before expiring.</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.session.InvalidSessionException</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * if the session has been stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">void</strong> setTimeout(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key, <strong class="jxr_keyword">long</strong> maxIdleTimeInMillis) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Updates the last accessed time of the session identified by <code>sessionId</code>. This</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * can be used to explicitly ensure that a session does not time out.</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.session.InvalidSessionException</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * if the session has been stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#touch</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">void</strong> touch(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * Returns the host name or IP string of the host where the session was started, if known. If</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * no host name or IP was specified when starting the session, this method returns {@code null}</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @return the host name or ip address of the host where the session originated, if known. If unknown,</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * this method returns {@code null}.</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> String getHost(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key); |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Explicitly stops the associated session, thereby releasing all of its resources.</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param key the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the session has stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#stop</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">void</strong> stop(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Returns all attribute keys maintained by the target session or an empty collection if there are no attributes.</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @param sessionKey the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @return all attribute keys maintained by the target session or an empty collection if there are no attributes.</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the associated session has stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#getAttributeKeys()</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> Collection<Object> getAttributeKeys(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> sessionKey); |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * Returns the object bound to the associated session identified by the specified attribute key. If there</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * is no object bound under the attribute key for the given session, {@code null} is returned.</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param sessionKey session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @param attributeKey the unique name of the object bound to the associated session</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @return the object bound under the {@code attributeKey} or {@code null} if there is no object bound.</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the specified session has stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#getAttribute(Object key)</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> Object getAttribute(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> sessionKey, Object attributeKey) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * Binds the specified {@code value} to the associated session uniquely identified by the {@code attributeKey}.</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * If there is already a session attribute bound under the {@code attributeKey}, that existing object will be</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * replaced by the new {@code value}.</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * If the {@code value} parameter is null, it has the same effect as if the</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * {@link #removeAttribute(SessionKey sessionKey, Object attributeKey)} method was called.</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @param sessionKey the session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param attributeKey the key under which the {@code value} object will be bound in this session</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param value the object to bind in this session.</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the specified session has stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#setAttribute(Object key, Object value)</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">void</strong> setAttribute(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> sessionKey, Object attributeKey, Object value) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Removes (unbinds) the object bound to associated {@code Session} under the given {@code attributeKey}.</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param sessionKey session key to use to look up the target session.</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @param attributeKey the key uniquely identifying the object to remove</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @return the object removed or {@code null} if there was no object bound under the specified {@code attributeKey}.</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @throws InvalidSessionException if the specified session has stopped or expired prior to calling this method.</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.session.Session#removeAttribute(Object key)</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> Object removeAttribute(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> sessionKey, Object attributeKey) <strong class="jxr_keyword">throws</strong> InvalidSessionException; |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
