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