sessionattributeinitializingfilter.html

MINA+API 关于MINA的API

<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     *</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * @param key the key of the attribute</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * @param value the value of the attribute</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * @return The old value of the attribute.  &lt;tt&gt;null&lt;/tt&gt; if it is new.</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     */</em>
<a name="79" href="#79">79</a>      <strong class="jxr_keyword">public</strong> Object setAttribute(String key, Object value) {
<a name="80" href="#80">80</a>          <strong class="jxr_keyword">if</strong> (value == <strong class="jxr_keyword">null</strong>) {
<a name="81" href="#81">81</a>              <strong class="jxr_keyword">return</strong> removeAttribute(key);
<a name="82" href="#82">82</a>          } <strong class="jxr_keyword">else</strong> {
<a name="83" href="#83">83</a>              <strong class="jxr_keyword">return</strong> attributes.put(key, value);
<a name="84" href="#84">84</a>          }
<a name="85" href="#85">85</a>      }
<a name="86" href="#86">86</a>  
<a name="87" href="#87">87</a>      <em class="jxr_javadoccomment">/**</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     * Sets a user defined attribute without a value.  This is useful when</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * you just want to put a 'mark' attribute.  Its value is set to</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * {@link Boolean#TRUE}.</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     *</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * @param key the key of the attribute</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @return The old value of the attribute.  &lt;tt&gt;null&lt;/tt&gt; if it is new.</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     */</em>
<a name="95" href="#95">95</a>      <strong class="jxr_keyword">public</strong> Object setAttribute(String key) {
<a name="96" href="#96">96</a>          <strong class="jxr_keyword">return</strong> attributes.put(key, Boolean.TRUE);
<a name="97" href="#97">97</a>      }
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>      <em class="jxr_javadoccomment">/**</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * Removes a user-defined attribute with the specified key.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     *</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * @return The old value of the attribute.  &lt;tt&gt;null&lt;/tt&gt; if not found.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     */</em>
<a name="104" href="#104">104</a>     <strong class="jxr_keyword">public</strong> Object removeAttribute(String key) {
<a name="105" href="#105">105</a>         <strong class="jxr_keyword">return</strong> attributes.remove(key);
<a name="106" href="#106">106</a>     }
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if this session contains the attribute with</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * the specified &lt;tt&gt;key&lt;/tt&gt;.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     */</em>
<a name="112" href="#112">112</a>     <strong class="jxr_keyword">boolean</strong> containsAttribute(String key) {
<a name="113" href="#113">113</a>         <strong class="jxr_keyword">return</strong> attributes.containsKey(key);
<a name="114" href="#114">114</a>     }
<a name="115" href="#115">115</a> 
<a name="116" href="#116">116</a>     <em class="jxr_javadoccomment">/**</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * Returns the set of keys of all user-defined attributes.</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     */</em>
<a name="119" href="#119">119</a>     <strong class="jxr_keyword">public</strong> Set&lt;String&gt; getAttributeKeys() {
<a name="120" href="#120">120</a>         <strong class="jxr_keyword">return</strong> attributes.keySet();
<a name="121" href="#121">121</a>     }
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>     <em class="jxr_javadoccomment">/**</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * Sets the attribute map.  The specified attributes are copied into the</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * underlying map, so modifying the specified attributes parameter after</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * the call won't change the internal state.</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     */</em>
<a name="128" href="#128">128</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAttributes(Map&lt;String, ? <strong class="jxr_keyword">extends</strong> Object&gt; attributes) {
<a name="129" href="#129">129</a>         <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) {
<a name="130" href="#130">130</a>             attributes = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Object&gt;();
<a name="131" href="#131">131</a>         }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>         <strong class="jxr_keyword">this</strong>.attributes.clear();
<a name="134" href="#134">134</a>         <strong class="jxr_keyword">this</strong>.attributes.putAll(attributes);
<a name="135" href="#135">135</a>     }
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>     <em class="jxr_javadoccomment">/**</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * Puts all pre-configured attributes into the actual session attribute</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * map and forward the event to the next filter.</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     */</em>
<a name="141" href="#141">141</a>     @Override
<a name="142" href="#142">142</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> sessionCreated(<a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter, <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session)
<a name="143" href="#143">143</a>             <strong class="jxr_keyword">throws</strong> Exception {
<a name="144" href="#144">144</a>         <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, Object&gt; e : attributes.entrySet()) {
<a name="145" href="#145">145</a>             session.setAttribute(e.getKey(), e.getValue());
<a name="146" href="#146">146</a>         }
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>         nextFilter.sessionCreated(session);
<a name="149" href="#149">149</a>     }
<a name="150" href="#150">150</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>