| <!DOCTYPE HTML> |
| <html lang="fr"> |
| <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.config;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.io.ResourceUtils;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.util.AbstractFactory;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.util.CollectionUtils;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.util.Factory;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">027</span><a id="line.27"></a> |
| <span class="sourceLineNo">028</span><a id="line.28">import java.util.HashMap;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import java.util.Map;</a> |
| <span class="sourceLineNo">030</span><a id="line.30"></a> |
| <span class="sourceLineNo">031</span><a id="line.31">/**</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * Base support class for {@link Factory} implementations that generate their instance(s) based on</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * {@link Ini} configuration.</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> *</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @since 1.0</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @deprecated use Shiro's {@code Environment} mechanisms instead.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> */</a> |
| <span class="sourceLineNo">038</span><a id="line.38">@Deprecated</a> |
| <span class="sourceLineNo">039</span><a id="line.39">public abstract class IniFactorySupport<T> extends AbstractFactory<T> {</a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> public static final String DEFAULT_INI_RESOURCE_PATH = "classpath:shiro.ini";</a> |
| <span class="sourceLineNo">042</span><a id="line.42"></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> private static transient final Logger log = LoggerFactory.getLogger(IniFactorySupport.class);</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> private Ini ini;</a> |
| <span class="sourceLineNo">046</span><a id="line.46"></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private Map<String, ?> defaultBeans;</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> protected IniFactorySupport() {</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> }</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> protected IniFactorySupport(Ini ini) {</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> this.ini = ini;</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> }</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> public Ini getIni() {</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> return ini;</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"> public void setIni(Ini ini) {</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> this.ini = ini;</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> }</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> /**</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Returns a mapping of String to bean representing the default set of object used by the factory.</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * These beans can be used by this factory in conjunction with objects parsed from the INI configuration.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * @return A Map of default objects, or <code>null</code>.</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * @since 1.4</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> */</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> protected Map<String, ?> getDefaults() {</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> return defaultBeans;</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> }</a> |
| <span class="sourceLineNo">073</span><a id="line.73"></a> |
| <span class="sourceLineNo">074</span><a id="line.74"> /**</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * Sets the default objects used by this factory. These defaults may be used in conjunction with the INI</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * configuration.</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @param defaultBeans String to object mapping used for default configuration in this factory.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * @since 1.4</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> */</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> public void setDefaults(Map<String, ?> defaultBeans) {</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> this.defaultBeans = defaultBeans;</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> }</a> |
| <span class="sourceLineNo">083</span><a id="line.83"></a> |
| <span class="sourceLineNo">084</span><a id="line.84"> /**</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * Returns a new Ini instance created from the default {@code classpath:shiro.ini} file, or {@code null} if</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * the file does not exist.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> *</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @return a new Ini instance created from the default {@code classpath:shiro.ini} file, or {@code null} if</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * the file does not exist.</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> */</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> public static Ini loadDefaultClassPathIni() {</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> Ini ini = null;</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> if (ResourceUtils.resourceExists(DEFAULT_INI_RESOURCE_PATH)) {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> log.debug("Found shiro.ini at the root of the classpath.");</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> ini = new Ini();</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> ini.loadFromPath(DEFAULT_INI_RESOURCE_PATH);</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> if (CollectionUtils.isEmpty(ini)) {</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> log.warn("shiro.ini found at the root of the classpath, but it did not contain any data.");</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> }</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> }</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> return ini;</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> }</a> |
| <span class="sourceLineNo">103</span><a id="line.103"></a> |
| <span class="sourceLineNo">104</span><a id="line.104"> /**</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * Tries to resolve the Ini instance to use for configuration. This implementation functions as follows:</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * <ol></a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * <li>The {@code Ini} instance returned from {@link #getIni()} will be returned if it is not null or empty.</li></a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * <li>If {@link #getIni()} is {@code null} or empty, this implementation will attempt to find and load the</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * {@link #loadDefaultClassPathIni() default class path Ini}.</li></a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * <li>If neither of the two attempts above returns an instance, {@code null} is returned</li></a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * </ol></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> *</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * @return the Ini instance to use for configuration.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> */</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> protected Ini resolveIni() {</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> Ini ini = getIni();</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> if (CollectionUtils.isEmpty(ini)) {</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> log.debug("Null or empty Ini instance. Falling back to the default {} file.", DEFAULT_INI_RESOURCE_PATH);</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> ini = loadDefaultClassPathIni();</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> }</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> return ini;</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> }</a> |
| <span class="sourceLineNo">123</span><a id="line.123"></a> |
| <span class="sourceLineNo">124</span><a id="line.124"> /**</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * Creates a new object instance by using a configured INI source. This implementation functions as follows:</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * <ol></a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * <li>{@link #resolveIni() Resolve} the {@code Ini} source to use for configuration.</li></a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * <li>If there was no resolved Ini source, create and return a simple default instance via the</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * {@link #createDefaultInstance()} method.</li></a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * </ol></a> |
| <span class="sourceLineNo">131</span><a id="line.131"> *</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * @return a new {@code SecurityManager} instance by using a configured INI source.</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> */</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> public T createInstance() {</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> Ini ini = resolveIni();</a> |
| <span class="sourceLineNo">136</span><a id="line.136"></a> |
| <span class="sourceLineNo">137</span><a id="line.137"> T instance;</a> |
| <span class="sourceLineNo">138</span><a id="line.138"></a> |
| <span class="sourceLineNo">139</span><a id="line.139"> if (CollectionUtils.isEmpty(ini)) {</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> log.debug("No populated Ini available. Creating a default instance.");</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> instance = createDefaultInstance();</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> if (instance == null) {</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> String msg = getClass().getName() + " implementation did not return a default instance in " +</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> "the event of a null/empty Ini configuration. This is required to support the " +</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> "Factory interface. Please check your implementation.";</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> throw new IllegalStateException(msg);</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> }</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> } else {</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> log.debug("Creating instance from Ini [" + ini + "]");</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> instance = createInstance(ini);</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> if (instance == null) {</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> String msg = getClass().getName() + " implementation did not return a constructed instance from " +</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> "the createInstance(Ini) method implementation.";</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> throw new IllegalStateException(msg);</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> }</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> }</a> |
| <span class="sourceLineNo">157</span><a id="line.157"></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> return instance;</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"> protected abstract T createInstance(Ini ini);</a> |
| <span class="sourceLineNo">162</span><a id="line.162"></a> |
| <span class="sourceLineNo">163</span><a id="line.163"> protected abstract T createDefaultInstance();</a> |
| <span class="sourceLineNo">164</span><a id="line.164">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
