| <!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.realm.text;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.config.Ini;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.util.CollectionUtils;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.util.StringUtils;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.slf4j.Logger;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.slf4j.LoggerFactory;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * A {@link org.apache.shiro.realm.Realm Realm} implementation that creates<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * {@link org.apache.shiro.authc.SimpleAccount SimpleAccount} instances based on<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * {@link Ini} configuration.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p/><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * This implementation looks for two {@link Ini.Section sections} in the {@code Ini} configuration:<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <pre><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * [users]<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * # One or more {@link org.apache.shiro.realm.text.TextConfigurationRealm#setUserDefinitions(String) user definitions}<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * ...<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * [roles]<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * # One or more {@link org.apache.shiro.realm.text.TextConfigurationRealm#setRoleDefinitions(String) role definitions}</pre><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p/><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * This class also supports setting the {@link #setResourcePath(String) resourcePath} property to create account<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * data from an .ini resource. This will only be used if there isn't already account data in the Realm.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @since 1.0<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public class IniRealm extends TextConfigurationRealm {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public static final String USERS_SECTION_NAME = "users";<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public static final String ROLES_SECTION_NAME = "roles";<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private static transient final Logger log = LoggerFactory.getLogger(IniRealm.class);<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private String resourcePath;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private Ini ini; //reference added in 1.2 for SHIRO-322<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public IniRealm() {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> super();<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> }<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * This constructor will immediately process the definitions in the {@code Ini} argument. If you need to perform<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * additional configuration before processing (e.g. setting a permissionResolver, etc), do not call this<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * constructor. Instead, do the following:<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <ol><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <li>Call the default no-arg constructor</li><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <li>Set the Ini instance you wish to use via {@code #setIni}</li><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <li>Set any other configuration properties</li><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <li>Call {@link #init()}</li><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * </ol><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param ini the Ini instance which will be inspected to create accounts, groups and permissions for this realm.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public IniRealm(Ini ini) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> this();<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> processDefinitions(ini);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * This constructor will immediately process the definitions in the {@code Ini} resolved from the specified<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * {@code resourcePath}. If you need to perform additional configuration before processing (e.g. setting a<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * permissionResolver, etc), do not call this constructor. Instead, do the following:<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <ol><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <li>Call the default no-arg constructor</li><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <li>Set the Ini instance you wish to use via {@code #setIni}</li><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <li>Set any other configuration properties</li><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <li>Call {@link #init()}</li><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * </ol><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param resourcePath the resource path of the Ini config which will be inspected to create accounts, groups and<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * permissions for this realm.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public IniRealm(String resourcePath) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> Ini ini = Ini.fromResourcePath(resourcePath);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.ini = ini;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> this.resourcePath = resourcePath;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> processDefinitions(ini);<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> public String getResourcePath() {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> return resourcePath;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public void setResourcePath(String resourcePath) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this.resourcePath = resourcePath;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Returns the Ini instance used to configure this realm. Provided for JavaBeans-style configuration of this<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * realm, particularly useful in Dependency Injection environments.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return the Ini instance which will be inspected to create accounts, groups and permissions for this realm.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public Ini getIni() {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return ini;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * Sets the Ini instance used to configure this realm. Provided for JavaBeans-style configuration of this<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * realm, particularly useful in Dependency Injection environments.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * <a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @param ini the Ini instance which will be inspected to create accounts, groups and permissions for this realm.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public void setIni(Ini ini) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> this.ini = ini;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> @Override<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> protected void onInit() {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> super.onInit();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> // This is an in-memory realm only - no need for an additional cache when we're already<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> // as memory-efficient as we can be.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> <a name="line.133"></a> |
| <span class="sourceLineNo">134</span> Ini ini = getIni();<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> String resourcePath = getResourcePath();<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> <a name="line.136"></a> |
| <span class="sourceLineNo">137</span> if (!CollectionUtils.isEmpty(this.users) || !CollectionUtils.isEmpty(this.roles)) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> if (!CollectionUtils.isEmpty(ini)) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> log.warn("Users or Roles are already populated. Configured Ini instance will be ignored.");<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> if (StringUtils.hasText(resourcePath)) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> log.warn("Users or Roles are already populated. resourcePath '{}' will be ignored.", resourcePath);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> <a name="line.144"></a> |
| <span class="sourceLineNo">145</span> log.debug("Instance is already populated with users or roles. No additional user/role population " +<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> "will be performed.");<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> <a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (CollectionUtils.isEmpty(ini)) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> log.debug("No INI instance configuration present. Checking resourcePath...");<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> <a name="line.152"></a> |
| <span class="sourceLineNo">153</span> if (StringUtils.hasText(resourcePath)) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> log.debug("Resource path {} defined. Creating INI instance.", resourcePath);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> ini = Ini.fromResourcePath(resourcePath);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> if (!CollectionUtils.isEmpty(ini)) {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> setIni(ini);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> <a name="line.161"></a> |
| <span class="sourceLineNo">162</span> if (CollectionUtils.isEmpty(ini)) {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> String msg = "Ini instance and/or resourcePath resulted in null or empty Ini configuration. Cannot " +<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> "load account data.";<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> throw new IllegalStateException(msg);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> processDefinitions(ini);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> private void processDefinitions(Ini ini) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (CollectionUtils.isEmpty(ini)) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> log.warn("{} defined, but the ini instance is null or empty.", getClass().getSimpleName());<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return;<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> Ini.Section rolesSection = ini.getSection(ROLES_SECTION_NAME);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if (!CollectionUtils.isEmpty(rolesSection)) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> log.debug("Discovered the [{}] section. Processing...", ROLES_SECTION_NAME);<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> processRoleDefinitions(rolesSection);<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> }<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> Ini.Section usersSection = ini.getSection(USERS_SECTION_NAME);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> if (!CollectionUtils.isEmpty(usersSection)) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> log.debug("Discovered the [{}] section. Processing...", USERS_SECTION_NAME);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> processUserDefinitions(usersSection);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> } else {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> log.info("{} defined, but there is no [{}] section defined. This realm will not be populated with any " +<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> "users and it is assumed that they will be populated programatically. Users must be defined " +<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> "for this Realm instance to be useful.", getClass().getSimpleName(), USERS_SECTION_NAME);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span>}<a name="line.193"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
