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