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