| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> *<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> */<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.mina.core.session;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * Stores the user-defined attributes which is provided per {@link IoSession}.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * All user-defined attribute accesses in {@link IoSession} are forwarded to<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * the instance of {@link IoSessionAttributeMap}. <a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public interface IoSessionAttributeMap {<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @return the value of user defined attribute associated with the<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * specified key. If there's no such attribute, the specified default<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * value is associated with the specified key, and the default value is<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * returned. This method is same with the following code except that the<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * operation is performed atomically.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <pre><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * if (containsAttribute(key)) {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * return getAttribute(key);<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * } else {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * setAttribute(key, defaultValue);<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * return defaultValue;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * }<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </pre><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param session the session for which we want to get an attribute<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param key The key we are looking for<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param defaultValue The default returned value if the attribute is not found<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> Object getAttribute(IoSession session, Object key, Object defaultValue);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Sets a user-defined attribute.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param session the session for which we want to set an attribute<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param key the key of the attribute<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param value the value of the attribute<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return The old value of the attribute. <tt>null</tt> if it is new.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> Object setAttribute(IoSession session, Object key, Object value);<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /**<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Sets a user defined attribute if the attribute with the specified key<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * is not set yet. This method is same with the following code except<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * that the operation is performed atomically.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <pre><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * if (containsAttribute(key)) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * return getAttribute(key);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * } else {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * return setAttribute(key, value);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * </pre><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param session the session for which we want to set an attribute<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param key The key we are looking for<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param value The value to inject<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return The previous attribute<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> Object setAttributeIfAbsent(IoSession session, Object key, Object value);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Removes a user-defined attribute with the specified key.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @return The old value of the attribute. <tt>null</tt> if not found.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @param session the session for which we want to remove an attribute<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param key The key we are looking for<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> Object removeAttribute(IoSession session, Object key);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Removes a user defined attribute with the specified key if the current<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * attribute value is equal to the specified value. This method is same<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * with the following code except that the operation is performed<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * atomically.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * <pre><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(value)) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * removeAttribute(key);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * return true;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * } else {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * return false;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * </pre><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param session the session for which we want to remove a value<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param key The key we are looking for<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param value The value to remove<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return <tt>true</tt> if the value has been removed, <tt>false</tt> if the key was<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * not found of the value not removed<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> boolean removeAttribute(IoSession session, Object key, Object value);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Replaces a user defined attribute with the specified key if the<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * value of the attribute is equals to the specified old value.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * This method is same with the following code except that the operation<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * is performed atomically.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <pre><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(oldValue)) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * setAttribute(key, newValue);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * return true;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * } else {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * return false;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * </pre><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * <a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param session the session for which we want to replace an attribute<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @param key The key we are looking for<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param oldValue The old value to replace<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param newValue The new value to set<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @return <tt>true</tt> if the value has been replaced, <tt>false</tt> if the key was<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * not found of the value not replaced<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> boolean replaceAttribute(IoSession session, Object key, Object oldValue, Object newValue);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @return <tt>true</tt> if this session contains the attribute with<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * the specified <tt>key</tt>.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * <a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param session the session for which wa want to check if an attribute is present<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @param key The key we are looking for<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> boolean containsAttribute(IoSession session, Object key);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @return the set of keys of all user-defined attributes.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * <a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param session the session for which we want the set of attributes<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> */<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> Set<Object> getAttributeKeys(IoSession session);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> /**<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * Disposes any releases associated with the specified session.<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * This method is invoked on disconnection.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param session the session to be disposed<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @throws Exception If the session can't be disposed <a name="line.158"></a> |
| <span class="sourceLineNo">159</span> */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> void dispose(IoSession session) throws Exception;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span>}<a name="line.161"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
