| <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;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.mgt.SecurityManager;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.subject.Subject;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.util.ThreadContext;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> /**<a name="line.26"></a> |
| <FONT color="green">027</FONT> * Accesses the currently accessible {@code Subject} for the calling code depending on runtime environment.<a name="line.27"></a> |
| <FONT color="green">028</FONT> *<a name="line.28"></a> |
| <FONT color="green">029</FONT> * @since 0.2<a name="line.29"></a> |
| <FONT color="green">030</FONT> */<a name="line.30"></a> |
| <FONT color="green">031</FONT> public abstract class SecurityUtils {<a name="line.31"></a> |
| <FONT color="green">032</FONT> <a name="line.32"></a> |
| <FONT color="green">033</FONT> /**<a name="line.33"></a> |
| <FONT color="green">034</FONT> * ONLY used as a 'backup' in VM Singleton environments (that is, standalone environments), since the<a name="line.34"></a> |
| <FONT color="green">035</FONT> * ThreadContext should always be the primary source for Subject instances when possible.<a name="line.35"></a> |
| <FONT color="green">036</FONT> */<a name="line.36"></a> |
| <FONT color="green">037</FONT> private static SecurityManager securityManager;<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> /**<a name="line.39"></a> |
| <FONT color="green">040</FONT> * Returns the currently accessible {@code Subject} available to the calling code depending on<a name="line.40"></a> |
| <FONT color="green">041</FONT> * runtime environment.<a name="line.41"></a> |
| <FONT color="green">042</FONT> * <p/><a name="line.42"></a> |
| <FONT color="green">043</FONT> * This method is provided as a way of obtaining a {@code Subject} without having to resort to<a name="line.43"></a> |
| <FONT color="green">044</FONT> * implementation-specific methods. It also allows the Shiro team to change the underlying implementation of<a name="line.44"></a> |
| <FONT color="green">045</FONT> * this method in the future depending on requirements/updates without affecting your code that uses it.<a name="line.45"></a> |
| <FONT color="green">046</FONT> *<a name="line.46"></a> |
| <FONT color="green">047</FONT> * @return the currently accessible {@code Subject} accessible to the calling code.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @throws IllegalStateException if no {@link Subject Subject} instance or<a name="line.48"></a> |
| <FONT color="green">049</FONT> * {@link SecurityManager SecurityManager} instance is available with which to obtain<a name="line.49"></a> |
| <FONT color="green">050</FONT> * a {@code Subject}, which which is considered an invalid application configuration<a name="line.50"></a> |
| <FONT color="green">051</FONT> * - a Subject should <em>always</em> be available to the caller.<a name="line.51"></a> |
| <FONT color="green">052</FONT> */<a name="line.52"></a> |
| <FONT color="green">053</FONT> public static Subject getSubject() {<a name="line.53"></a> |
| <FONT color="green">054</FONT> Subject subject = ThreadContext.getSubject();<a name="line.54"></a> |
| <FONT color="green">055</FONT> if (subject == null) {<a name="line.55"></a> |
| <FONT color="green">056</FONT> subject = (new Subject.Builder()).buildSubject();<a name="line.56"></a> |
| <FONT color="green">057</FONT> ThreadContext.bind(subject);<a name="line.57"></a> |
| <FONT color="green">058</FONT> }<a name="line.58"></a> |
| <FONT color="green">059</FONT> return subject;<a name="line.59"></a> |
| <FONT color="green">060</FONT> }<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> /**<a name="line.62"></a> |
| <FONT color="green">063</FONT> * Sets a VM (static) singleton SecurityManager, specifically for transparent use in the<a name="line.63"></a> |
| <FONT color="green">064</FONT> * {@link #getSubject() getSubject()} implementation.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * <p/><a name="line.65"></a> |
| <FONT color="green">066</FONT> * <b>This method call exists mainly for framework development support. Application developers should rarely,<a name="line.66"></a> |
| <FONT color="green">067</FONT> * if ever, need to call this method.</b><a name="line.67"></a> |
| <FONT color="green">068</FONT> * <p/><a name="line.68"></a> |
| <FONT color="green">069</FONT> * The Shiro development team prefers that SecurityManager instances are non-static application singletons<a name="line.69"></a> |
| <FONT color="green">070</FONT> * and <em>not</em> VM static singletons. Application singletons that do not use static memory require some sort<a name="line.70"></a> |
| <FONT color="green">071</FONT> * of application configuration framework to maintain the application-wide SecurityManager instance for you<a name="line.71"></a> |
| <FONT color="green">072</FONT> * (for example, Spring or EJB3 environments) such that the object reference does not need to be static.<a name="line.72"></a> |
| <FONT color="green">073</FONT> * <p/><a name="line.73"></a> |
| <FONT color="green">074</FONT> * In these environments, Shiro acquires Subject data based on the currently executing Thread via its own<a name="line.74"></a> |
| <FONT color="green">075</FONT> * framework integration code, and this is the preferred way to use Shiro.<a name="line.75"></a> |
| <FONT color="green">076</FONT> * <p/><a name="line.76"></a> |
| <FONT color="green">077</FONT> * However in some environments, such as a standalone desktop application or Applets that do not use Spring or<a name="line.77"></a> |
| <FONT color="green">078</FONT> * EJB or similar config frameworks, a VM-singleton might make more sense (although the former is still preferred).<a name="line.78"></a> |
| <FONT color="green">079</FONT> * In these environments, setting the SecurityManager via this method will automatically enable the<a name="line.79"></a> |
| <FONT color="green">080</FONT> * {@link #getSubject() getSubject()} call to function with little configuration.<a name="line.80"></a> |
| <FONT color="green">081</FONT> * <p/><a name="line.81"></a> |
| <FONT color="green">082</FONT> * For example, in these environments, this will work:<a name="line.82"></a> |
| <FONT color="green">083</FONT> * <pre><a name="line.83"></a> |
| <FONT color="green">084</FONT> * DefaultSecurityManager securityManager = new {@link org.apache.shiro.mgt.DefaultSecurityManager DefaultSecurityManager}();<a name="line.84"></a> |
| <FONT color="green">085</FONT> * securityManager.setRealms( ... ); //one or more Realms<a name="line.85"></a> |
| <FONT color="green">086</FONT> * <b>SecurityUtils.setSecurityManager( securityManager );</b></pre><a name="line.86"></a> |
| <FONT color="green">087</FONT> * <p/><a name="line.87"></a> |
| <FONT color="green">088</FONT> * And then anywhere in the application code, the following call will return the application's Subject:<a name="line.88"></a> |
| <FONT color="green">089</FONT> * <pre><a name="line.89"></a> |
| <FONT color="green">090</FONT> * Subject currentUser = SecurityUtils.getSubject();</pre><a name="line.90"></a> |
| <FONT color="green">091</FONT> *<a name="line.91"></a> |
| <FONT color="green">092</FONT> * @param securityManager the securityManager instance to set as a VM static singleton.<a name="line.92"></a> |
| <FONT color="green">093</FONT> */<a name="line.93"></a> |
| <FONT color="green">094</FONT> public static void setSecurityManager(SecurityManager securityManager) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> SecurityUtils.securityManager = securityManager;<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> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * Returns the SecurityManager accessible to the calling code.<a name="line.99"></a> |
| <FONT color="green">100</FONT> * <p/><a name="line.100"></a> |
| <FONT color="green">101</FONT> * This implementation favors acquiring a thread-bound {@code SecurityManager} if it can find one. If one is<a name="line.101"></a> |
| <FONT color="green">102</FONT> * not available to the executing thread, it will attempt to use the static singleton if available (see the<a name="line.102"></a> |
| <FONT color="green">103</FONT> * {@link #setSecurityManager setSecurityManager} method for more on the static singleton).<a name="line.103"></a> |
| <FONT color="green">104</FONT> * <p/><a name="line.104"></a> |
| <FONT color="green">105</FONT> * If neither the thread-local or static singleton instances are available, this method throws an<a name="line.105"></a> |
| <FONT color="green">106</FONT> * {@code UnavailableSecurityManagerException} to indicate an error - a SecurityManager should always be accessible<a name="line.106"></a> |
| <FONT color="green">107</FONT> * to calling code in an application. If it is not, it is likely due to a Shiro configuration problem.<a name="line.107"></a> |
| <FONT color="green">108</FONT> *<a name="line.108"></a> |
| <FONT color="green">109</FONT> * @return the SecurityManager accessible to the calling code.<a name="line.109"></a> |
| <FONT color="green">110</FONT> * @throws UnavailableSecurityManagerException<a name="line.110"></a> |
| <FONT color="green">111</FONT> * if there is no {@code SecurityManager} instance available to the<a name="line.111"></a> |
| <FONT color="green">112</FONT> * calling code, which typically indicates an invalid application configuration.<a name="line.112"></a> |
| <FONT color="green">113</FONT> */<a name="line.113"></a> |
| <FONT color="green">114</FONT> public static SecurityManager getSecurityManager() throws UnavailableSecurityManagerException {<a name="line.114"></a> |
| <FONT color="green">115</FONT> SecurityManager securityManager = ThreadContext.getSecurityManager();<a name="line.115"></a> |
| <FONT color="green">116</FONT> if (securityManager == null) {<a name="line.116"></a> |
| <FONT color="green">117</FONT> securityManager = SecurityUtils.securityManager;<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> if (securityManager == null) {<a name="line.119"></a> |
| <FONT color="green">120</FONT> String msg = "No SecurityManager accessible to the calling code, either bound to the " +<a name="line.120"></a> |
| <FONT color="green">121</FONT> ThreadContext.class.getName() + " or as a vm static singleton. This is an invalid application " +<a name="line.121"></a> |
| <FONT color="green">122</FONT> "configuration.";<a name="line.122"></a> |
| <FONT color="green">123</FONT> throw new UnavailableSecurityManagerException(msg);<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> return securityManager;<a name="line.125"></a> |
| <FONT color="green">126</FONT> }<a name="line.126"></a> |
| <FONT color="green">127</FONT> }<a name="line.127"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
