| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>IniRealm xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/text/IniRealm.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.text; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.config.Ini; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="26" href="#26">26</a> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * A {@link org.apache.shiro.realm.Realm Realm} implementation that creates</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.SimpleAccount SimpleAccount} instances based on</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * {@link Ini} configuration.</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * This implementation looks for two {@link Ini.Section sections} in the {@code Ini} configuration:</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * [users]</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * # One or more {@link org.apache.shiro.realm.text.TextConfigurationRealm#setUserDefinitions(String) user definitions}</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * [roles]</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * # One or more {@link org.apache.shiro.realm.text.TextConfigurationRealm#setRoleDefinitions(String) role definitions}</pre></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * This class also supports setting the {@link #setResourcePath(String) resourcePath} property to create account</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * data from an .ini resource. This will only be used if there isn't already account data in the Realm.</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/text/IniRealm.html">IniRealm</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/realm/text/TextConfigurationRealm.html">TextConfigurationRealm</a> { |
| <a name="46" href="#46">46</a> |
| <a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String USERS_SECTION_NAME = <span class="jxr_string">"users"</span>; |
| <a name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ROLES_SECTION_NAME = <span class="jxr_string">"roles"</span>; |
| <a name="49" href="#49">49</a> |
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(IniRealm.<strong class="jxr_keyword">class</strong>); |
| <a name="51" href="#51">51</a> |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> String resourcePath; |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini; <em class="jxr_comment">//reference added in 1.2 for SHIRO-322</em> |
| <a name="54" href="#54">54</a> |
| <a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/realm/text/IniRealm.html">IniRealm</a>() { |
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">super</strong>(); |
| <a name="57" href="#57">57</a> } |
| <a name="58" href="#58">58</a> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * This constructor will immediately process the definitions in the {@code Ini} argument. If you need to perform</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * additional configuration before processing (e.g. setting a permissionResolver, etc), do not call this</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * constructor. Instead, do the following:</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <li>Call the default no-arg constructor</li></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <li>Set the Ini instance you wish to use via {@code #setIni}</li></em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <li>Set any other configuration properties</li></em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <li>Call {@link #init()}</li></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @param ini the Ini instance which will be inspected to create accounts, groups and permissions for this realm.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/realm/text/IniRealm.html">IniRealm</a>(<a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini) { |
| <a name="73" href="#73">73</a> <strong class="jxr_keyword">this</strong>(); |
| <a name="74" href="#74">74</a> processDefinitions(ini); |
| <a name="75" href="#75">75</a> } |
| <a name="76" href="#76">76</a> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * This constructor will immediately process the definitions in the {@code Ini} resolved from the specified</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * {@code resourcePath}. If you need to perform additional configuration before processing (e.g. setting a</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * permissionResolver, etc), do not call this constructor. Instead, do the following:</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <li>Call the default no-arg constructor</li></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <li>Set the Ini instance you wish to use via {@code #setIni}</li></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <li>Set any other configuration properties</li></em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * <li>Call {@link #init()}</li></em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param resourcePath the resource path of the Ini config which will be inspected to create accounts, groups and</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * permissions for this realm.</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/realm/text/IniRealm.html">IniRealm</a>(String resourcePath) { |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">this</strong>(); |
| <a name="93" href="#93">93</a> <a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini = Ini.fromResourcePath(resourcePath); |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.ini = ini; |
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.resourcePath = resourcePath; |
| <a name="96" href="#96">96</a> processDefinitions(ini); |
| <a name="97" href="#97">97</a> } |
| <a name="98" href="#98">98</a> |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">public</strong> String getResourcePath() { |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">return</strong> resourcePath; |
| <a name="101" href="#101">101</a> } |
| <a name="102" href="#102">102</a> |
| <a name="103" href="#103">103</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setResourcePath(String resourcePath) { |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">this</strong>.resourcePath = resourcePath; |
| <a name="105" href="#105">105</a> } |
| <a name="106" href="#106">106</a> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * Returns the Ini instance used to configure this realm. Provided for JavaBeans-style configuration of this</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * realm, particularly useful in Dependency Injection environments.</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @return the Ini instance which will be inspected to create accounts, groups and permissions for this realm.</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> getIni() { |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">return</strong> ini; |
| <a name="115" href="#115">115</a> } |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Sets the Ini instance used to configure this realm. Provided for JavaBeans-style configuration of this</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * realm, particularly useful in Dependency Injection environments.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param ini the Ini instance which will be inspected to create accounts, groups and permissions for this realm.</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIni(<a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini) { |
| <a name="124" href="#124">124</a> <strong class="jxr_keyword">this</strong>.ini = ini; |
| <a name="125" href="#125">125</a> } |
| <a name="126" href="#126">126</a> |
| <a name="127" href="#127">127</a> @Override |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onInit() { |
| <a name="129" href="#129">129</a> <strong class="jxr_keyword">super</strong>.onInit(); |
| <a name="130" href="#130">130</a> |
| <a name="131" href="#131">131</a> <em class="jxr_comment">// This is an in-memory realm only - no need for an additional cache when we're already</em> |
| <a name="132" href="#132">132</a> <em class="jxr_comment">// as memory-efficient as we can be.</em> |
| <a name="133" href="#133">133</a> |
| <a name="134" href="#134">134</a> <a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini = getIni(); |
| <a name="135" href="#135">135</a> String resourcePath = getResourcePath(); |
| <a name="136" href="#136">136</a> |
| <a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(<strong class="jxr_keyword">this</strong>.users) || !CollectionUtils.isEmpty(<strong class="jxr_keyword">this</strong>.roles)) { |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(ini)) { |
| <a name="139" href="#139">139</a> log.warn(<span class="jxr_string">"Users or Roles are already populated. Configured Ini instance will be ignored."</span>); |
| <a name="140" href="#140">140</a> } |
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(resourcePath)) { |
| <a name="142" href="#142">142</a> log.warn(<span class="jxr_string">"Users or Roles are already populated. resourcePath '{}' will be ignored."</span>, resourcePath); |
| <a name="143" href="#143">143</a> } |
| <a name="144" href="#144">144</a> |
| <a name="145" href="#145">145</a> log.debug(<span class="jxr_string">"Instance is already populated with users or roles. No additional user/role population "</span> + |
| <a name="146" href="#146">146</a> <span class="jxr_string">"will be performed."</span>); |
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">return</strong>; |
| <a name="148" href="#148">148</a> } |
| <a name="149" href="#149">149</a> |
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a name="151" href="#151">151</a> log.debug(<span class="jxr_string">"No INI instance configuration present. Checking resourcePath..."</span>); |
| <a name="152" href="#152">152</a> |
| <a name="153" href="#153">153</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(resourcePath)) { |
| <a name="154" href="#154">154</a> log.debug(<span class="jxr_string">"Resource path {} defined. Creating INI instance."</span>, resourcePath); |
| <a name="155" href="#155">155</a> ini = Ini.fromResourcePath(resourcePath); |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(ini)) { |
| <a name="157" href="#157">157</a> setIni(ini); |
| <a name="158" href="#158">158</a> } |
| <a name="159" href="#159">159</a> } |
| <a name="160" href="#160">160</a> } |
| <a name="161" href="#161">161</a> |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a name="163" href="#163">163</a> String msg = <span class="jxr_string">"Ini instance and/or resourcePath resulted in null or empty Ini configuration. Cannot "</span> + |
| <a name="164" href="#164">164</a> <span class="jxr_string">"load account data."</span>; |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="166" href="#166">166</a> } |
| <a name="167" href="#167">167</a> |
| <a name="168" href="#168">168</a> processDefinitions(ini); |
| <a name="169" href="#169">169</a> } |
| <a name="170" href="#170">170</a> |
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processDefinitions(<a href="../../../../../org/apache/shiro/config/Ini.html">Ini</a> ini) { |
| <a name="172" href="#172">172</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(ini)) { |
| <a name="173" href="#173">173</a> log.warn(<span class="jxr_string">"{} defined, but the ini instance is null or empty."</span>, getClass().getSimpleName()); |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong>; |
| <a name="175" href="#175">175</a> } |
| <a name="176" href="#176">176</a> |
| <a name="177" href="#177">177</a> Ini.Section rolesSection = ini.getSection(ROLES_SECTION_NAME); |
| <a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(rolesSection)) { |
| <a name="179" href="#179">179</a> log.debug(<span class="jxr_string">"Discovered the [{}] section. Processing..."</span>, ROLES_SECTION_NAME); |
| <a name="180" href="#180">180</a> processRoleDefinitions(rolesSection); |
| <a name="181" href="#181">181</a> } |
| <a name="182" href="#182">182</a> |
| <a name="183" href="#183">183</a> Ini.Section usersSection = ini.getSection(USERS_SECTION_NAME); |
| <a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(usersSection)) { |
| <a name="185" href="#185">185</a> log.debug(<span class="jxr_string">"Discovered the [{}] section. Processing..."</span>, USERS_SECTION_NAME); |
| <a name="186" href="#186">186</a> processUserDefinitions(usersSection); |
| <a name="187" href="#187">187</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="188" href="#188">188</a> log.info(<span class="jxr_string">"{} defined, but there is no [{}] section defined. This realm will not be populated with any "</span> + |
| <a name="189" href="#189">189</a> <span class="jxr_string">"users and it is assumed that they will be populated programatically. Users must be defined "</span> + |
| <a name="190" href="#190">190</a> <span class="jxr_string">"for this Realm instance to be useful."</span>, getClass().getSimpleName(), USERS_SECTION_NAME); |
| <a name="191" href="#191">191</a> } |
| <a name="192" href="#192">192</a> } |
| <a name="193" href="#193">193</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
