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