| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.util;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import java.io.Serializable;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.util.*;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> /**<a name="line.24"></a> |
| <FONT color="green">025</FONT> * A {@code MapContext} provides a common base for context-based data storage in a {@link Map}. Type-safe attribute<a name="line.25"></a> |
| <FONT color="green">026</FONT> * retrieval is provided for subclasses with the {@link #getTypedValue(String, Class)} method.<a name="line.26"></a> |
| <FONT color="green">027</FONT> *<a name="line.27"></a> |
| <FONT color="green">028</FONT> * @see org.apache.shiro.subject.SubjectContext SubjectContext<a name="line.28"></a> |
| <FONT color="green">029</FONT> * @see org.apache.shiro.session.mgt.SessionContext SessionContext<a name="line.29"></a> |
| <FONT color="green">030</FONT> * @since 1.0<a name="line.30"></a> |
| <FONT color="green">031</FONT> */<a name="line.31"></a> |
| <FONT color="green">032</FONT> public class MapContext implements Map<String, Object>, Serializable {<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> private static final long serialVersionUID = 5373399119017820322L;<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> private final Map<String, Object> backingMap;<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> public MapContext() {<a name="line.38"></a> |
| <FONT color="green">039</FONT> this.backingMap = new HashMap<String, Object>();<a name="line.39"></a> |
| <FONT color="green">040</FONT> }<a name="line.40"></a> |
| <FONT color="green">041</FONT> <a name="line.41"></a> |
| <FONT color="green">042</FONT> public MapContext(Map<String, Object> map) {<a name="line.42"></a> |
| <FONT color="green">043</FONT> this();<a name="line.43"></a> |
| <FONT color="green">044</FONT> if (!CollectionUtils.isEmpty(map)) {<a name="line.44"></a> |
| <FONT color="green">045</FONT> this.backingMap.putAll(map);<a name="line.45"></a> |
| <FONT color="green">046</FONT> }<a name="line.46"></a> |
| <FONT color="green">047</FONT> }<a name="line.47"></a> |
| <FONT color="green">048</FONT> <a name="line.48"></a> |
| <FONT color="green">049</FONT> /**<a name="line.49"></a> |
| <FONT color="green">050</FONT> * Performs a {@link #get get} operation but additionally ensures that the value returned is of the specified<a name="line.50"></a> |
| <FONT color="green">051</FONT> * {@code type}. If there is no value, {@code null} is returned.<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @param key the attribute key to look up a value<a name="line.53"></a> |
| <FONT color="green">054</FONT> * @param type the expected type of the value<a name="line.54"></a> |
| <FONT color="green">055</FONT> * @param <E> the expected type of the value<a name="line.55"></a> |
| <FONT color="green">056</FONT> * @return the typed value or {@code null} if the attribute does not exist.<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> @SuppressWarnings({"unchecked"})<a name="line.58"></a> |
| <FONT color="green">059</FONT> protected <E> E getTypedValue(String key, Class<E> type) {<a name="line.59"></a> |
| <FONT color="green">060</FONT> E found = null;<a name="line.60"></a> |
| <FONT color="green">061</FONT> Object o = backingMap.get(key);<a name="line.61"></a> |
| <FONT color="green">062</FONT> if (o != null) {<a name="line.62"></a> |
| <FONT color="green">063</FONT> if (!type.isAssignableFrom(o.getClass())) {<a name="line.63"></a> |
| <FONT color="green">064</FONT> String msg = "Invalid object found in SubjectContext Map under key [" + key + "]. Expected type " +<a name="line.64"></a> |
| <FONT color="green">065</FONT> "was [" + type.getName() + "], but the object under that key is of type " +<a name="line.65"></a> |
| <FONT color="green">066</FONT> "[" + o.getClass().getName() + "].";<a name="line.66"></a> |
| <FONT color="green">067</FONT> throw new IllegalArgumentException(msg);<a name="line.67"></a> |
| <FONT color="green">068</FONT> }<a name="line.68"></a> |
| <FONT color="green">069</FONT> found = (E) o;<a name="line.69"></a> |
| <FONT color="green">070</FONT> }<a name="line.70"></a> |
| <FONT color="green">071</FONT> return found;<a name="line.71"></a> |
| <FONT color="green">072</FONT> }<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> /**<a name="line.74"></a> |
| <FONT color="green">075</FONT> * Places a value in this context map under the given key only if the given {@code value} argument is not null.<a name="line.75"></a> |
| <FONT color="green">076</FONT> *<a name="line.76"></a> |
| <FONT color="green">077</FONT> * @param key the attribute key under which the non-null value will be stored<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @param value the non-null value to store. If {@code null}, this method does nothing and returns immediately.<a name="line.78"></a> |
| <FONT color="green">079</FONT> */<a name="line.79"></a> |
| <FONT color="green">080</FONT> protected void nullSafePut(String key, Object value) {<a name="line.80"></a> |
| <FONT color="green">081</FONT> if (value != null) {<a name="line.81"></a> |
| <FONT color="green">082</FONT> put(key, value);<a name="line.82"></a> |
| <FONT color="green">083</FONT> }<a name="line.83"></a> |
| <FONT color="green">084</FONT> }<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> public int size() {<a name="line.86"></a> |
| <FONT color="green">087</FONT> return backingMap.size();<a name="line.87"></a> |
| <FONT color="green">088</FONT> }<a name="line.88"></a> |
| <FONT color="green">089</FONT> <a name="line.89"></a> |
| <FONT color="green">090</FONT> public boolean isEmpty() {<a name="line.90"></a> |
| <FONT color="green">091</FONT> return backingMap.isEmpty();<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> public boolean containsKey(Object o) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> return backingMap.containsKey(o);<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> public boolean containsValue(Object o) {<a name="line.98"></a> |
| <FONT color="green">099</FONT> return backingMap.containsValue(o);<a name="line.99"></a> |
| <FONT color="green">100</FONT> }<a name="line.100"></a> |
| <FONT color="green">101</FONT> <a name="line.101"></a> |
| <FONT color="green">102</FONT> public Object get(Object o) {<a name="line.102"></a> |
| <FONT color="green">103</FONT> return backingMap.get(o);<a name="line.103"></a> |
| <FONT color="green">104</FONT> }<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> public Object put(String s, Object o) {<a name="line.106"></a> |
| <FONT color="green">107</FONT> return backingMap.put(s, o);<a name="line.107"></a> |
| <FONT color="green">108</FONT> }<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> public Object remove(Object o) {<a name="line.110"></a> |
| <FONT color="green">111</FONT> return backingMap.remove(o);<a name="line.111"></a> |
| <FONT color="green">112</FONT> }<a name="line.112"></a> |
| <FONT color="green">113</FONT> <a name="line.113"></a> |
| <FONT color="green">114</FONT> public void putAll(Map<? extends String, ?> map) {<a name="line.114"></a> |
| <FONT color="green">115</FONT> backingMap.putAll(map);<a name="line.115"></a> |
| <FONT color="green">116</FONT> }<a name="line.116"></a> |
| <FONT color="green">117</FONT> <a name="line.117"></a> |
| <FONT color="green">118</FONT> public void clear() {<a name="line.118"></a> |
| <FONT color="green">119</FONT> backingMap.clear();<a name="line.119"></a> |
| <FONT color="green">120</FONT> }<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> public Set<String> keySet() {<a name="line.122"></a> |
| <FONT color="green">123</FONT> return Collections.unmodifiableSet(backingMap.keySet());<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> <a name="line.125"></a> |
| <FONT color="green">126</FONT> public Collection<Object> values() {<a name="line.126"></a> |
| <FONT color="green">127</FONT> return Collections.unmodifiableCollection(backingMap.values());<a name="line.127"></a> |
| <FONT color="green">128</FONT> }<a name="line.128"></a> |
| <FONT color="green">129</FONT> <a name="line.129"></a> |
| <FONT color="green">130</FONT> public Set<Entry<String, Object>> entrySet() {<a name="line.130"></a> |
| <FONT color="green">131</FONT> return Collections.unmodifiableSet(backingMap.entrySet());<a name="line.131"></a> |
| <FONT color="green">132</FONT> }<a name="line.132"></a> |
| <FONT color="green">133</FONT> }<a name="line.133"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |