Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.4 / apidocs / src-html / org / apache / shiro / config / IniFactorySupport.html
blob: a719333749a69320b00f5a12891d3b3a4cffa922 [file] [log] [blame]
<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.config;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.io.ResourceUtils;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.util.AbstractFactory;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.util.Factory;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.slf4j.Logger;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.slf4j.LoggerFactory;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * Base support class for {@link Factory} implementations that generate their instance(s) 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> *<a name="line.31"></a>
<FONT color="green">032</FONT> * @since 1.0<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public abstract class IniFactorySupport&lt;T&gt; extends AbstractFactory&lt;T&gt; {<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> public static final String DEFAULT_INI_RESOURCE_PATH = "classpath:shiro.ini";<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> private static transient final Logger log = LoggerFactory.getLogger(IniFactorySupport.class);<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> private Ini ini;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> protected IniFactorySupport() {<a name="line.42"></a>
<FONT color="green">043</FONT> }<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> protected IniFactorySupport(Ini ini) {<a name="line.45"></a>
<FONT color="green">046</FONT> this.ini = ini;<a name="line.46"></a>
<FONT color="green">047</FONT> }<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> public Ini getIni() {<a name="line.49"></a>
<FONT color="green">050</FONT> return ini;<a name="line.50"></a>
<FONT color="green">051</FONT> }<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> public void setIni(Ini ini) {<a name="line.53"></a>
<FONT color="green">054</FONT> this.ini = ini;<a name="line.54"></a>
<FONT color="green">055</FONT> }<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * Returns a new Ini instance created from the default {@code classpath:shiro.ini} file, or {@code null} if<a name="line.58"></a>
<FONT color="green">059</FONT> * the file does not exist.<a name="line.59"></a>
<FONT color="green">060</FONT> *<a name="line.60"></a>
<FONT color="green">061</FONT> * @return a new Ini instance created from the default {@code classpath:shiro.ini} file, or {@code null} if<a name="line.61"></a>
<FONT color="green">062</FONT> * the file does not exist.<a name="line.62"></a>
<FONT color="green">063</FONT> */<a name="line.63"></a>
<FONT color="green">064</FONT> public static Ini loadDefaultClassPathIni() {<a name="line.64"></a>
<FONT color="green">065</FONT> Ini ini = null;<a name="line.65"></a>
<FONT color="green">066</FONT> if (ResourceUtils.resourceExists(DEFAULT_INI_RESOURCE_PATH)) {<a name="line.66"></a>
<FONT color="green">067</FONT> log.debug("Found shiro.ini at the root of the classpath.");<a name="line.67"></a>
<FONT color="green">068</FONT> ini = new Ini();<a name="line.68"></a>
<FONT color="green">069</FONT> ini.loadFromPath(DEFAULT_INI_RESOURCE_PATH);<a name="line.69"></a>
<FONT color="green">070</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.70"></a>
<FONT color="green">071</FONT> log.warn("shiro.ini found at the root of the classpath, but it did not contain any data.");<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> }<a name="line.73"></a>
<FONT color="green">074</FONT> return 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> * Tries to resolve the Ini instance to use for configuration. This implementation functions as follows:<a name="line.78"></a>
<FONT color="green">079</FONT> * &lt;ol&gt;<a name="line.79"></a>
<FONT color="green">080</FONT> * &lt;li&gt;The {@code Ini} instance returned from {@link #getIni()} will be returned if it is not null or empty.&lt;/li&gt;<a name="line.80"></a>
<FONT color="green">081</FONT> * &lt;li&gt;If {@link #getIni()} is {@code null} or empty, this implementation will attempt to find and load the<a name="line.81"></a>
<FONT color="green">082</FONT> * {@link #loadDefaultClassPathIni() default class path Ini}.&lt;/li&gt;<a name="line.82"></a>
<FONT color="green">083</FONT> * &lt;li&gt;If neither of the two attempts above returns an instance, {@code null} is returned&lt;/li&gt;<a name="line.83"></a>
<FONT color="green">084</FONT> * &lt;/ol&gt;<a name="line.84"></a>
<FONT color="green">085</FONT> *<a name="line.85"></a>
<FONT color="green">086</FONT> * @return the Ini instance to use for configuration.<a name="line.86"></a>
<FONT color="green">087</FONT> */<a name="line.87"></a>
<FONT color="green">088</FONT> protected Ini resolveIni() {<a name="line.88"></a>
<FONT color="green">089</FONT> Ini ini = getIni();<a name="line.89"></a>
<FONT color="green">090</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.90"></a>
<FONT color="green">091</FONT> log.debug("Null or empty Ini instance. Falling back to the default {} file.", DEFAULT_INI_RESOURCE_PATH);<a name="line.91"></a>
<FONT color="green">092</FONT> ini = loadDefaultClassPathIni();<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> return ini;<a name="line.94"></a>
<FONT color="green">095</FONT> }<a name="line.95"></a>
<FONT color="green">096</FONT> <a name="line.96"></a>
<FONT color="green">097</FONT> /**<a name="line.97"></a>
<FONT color="green">098</FONT> * Creates a new object instance by using a configured INI source. This implementation functions as follows:<a name="line.98"></a>
<FONT color="green">099</FONT> * &lt;ol&gt;<a name="line.99"></a>
<FONT color="green">100</FONT> * &lt;li&gt;{@link #resolveIni() Resolve} the {@code Ini} source to use for configuration.&lt;/li&gt;<a name="line.100"></a>
<FONT color="green">101</FONT> * &lt;li&gt;If there was no resolved Ini source, create and return a simple default instance via the<a name="line.101"></a>
<FONT color="green">102</FONT> * {@link #createDefaultInstance()} method.&lt;/li&gt;<a name="line.102"></a>
<FONT color="green">103</FONT> * &lt;/ol&gt;<a name="line.103"></a>
<FONT color="green">104</FONT> *<a name="line.104"></a>
<FONT color="green">105</FONT> * @return a new {@code SecurityManager} instance by using a configured INI source.<a name="line.105"></a>
<FONT color="green">106</FONT> */<a name="line.106"></a>
<FONT color="green">107</FONT> public T createInstance() {<a name="line.107"></a>
<FONT color="green">108</FONT> Ini ini = resolveIni();<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> T instance;<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.112"></a>
<FONT color="green">113</FONT> log.debug("No populated Ini available. Creating a default instance.");<a name="line.113"></a>
<FONT color="green">114</FONT> instance = createDefaultInstance();<a name="line.114"></a>
<FONT color="green">115</FONT> if (instance == null) {<a name="line.115"></a>
<FONT color="green">116</FONT> String msg = getClass().getName() + " implementation did not return a default instance in " +<a name="line.116"></a>
<FONT color="green">117</FONT> "the event of a null/empty Ini configuration. This is required to support the " +<a name="line.117"></a>
<FONT color="green">118</FONT> "Factory interface. Please check your implementation.";<a name="line.118"></a>
<FONT color="green">119</FONT> throw new IllegalStateException(msg);<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
<FONT color="green">121</FONT> } else {<a name="line.121"></a>
<FONT color="green">122</FONT> log.debug("Creating instance from Ini [" + ini + "]");<a name="line.122"></a>
<FONT color="green">123</FONT> instance = createInstance(ini);<a name="line.123"></a>
<FONT color="green">124</FONT> if (instance == null) {<a name="line.124"></a>
<FONT color="green">125</FONT> String msg = getClass().getName() + " implementation did not return a constructed instance from " +<a name="line.125"></a>
<FONT color="green">126</FONT> "the createInstance(Ini) method implementation.";<a name="line.126"></a>
<FONT color="green">127</FONT> throw new IllegalStateException(msg);<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> return instance;<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> protected abstract T createInstance(Ini ini);<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> protected abstract T createDefaultInstance();<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
</PRE>
</BODY>
</HTML>