Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.4 / apidocs / src-html / org / apache / shiro / spring / LifecycleBeanPostProcessor.html
blob: 61400bcd275489f5628b78d439bb5b864a19d138 [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.spring;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.springframework.beans.BeansException;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.springframework.beans.FatalBeanException;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.springframework.core.PriorityOrdered;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.slf4j.Logger;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.slf4j.LoggerFactory;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.util.Destroyable;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.shiro.util.Initializable;<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;p&gt;Bean post processor for Spring that automatically calls the &lt;tt&gt;init()&lt;/tt&gt; and/or<a name="line.34"></a>
<FONT color="green">035</FONT> * &lt;tt&gt;destroy()&lt;/tt&gt; methods on Shiro objects that implement the {@link org.apache.shiro.util.Initializable}<a name="line.35"></a>
<FONT color="green">036</FONT> * or {@link org.apache.shiro.util.Destroyable} interfaces, respectfully. This post processor makes it easier<a name="line.36"></a>
<FONT color="green">037</FONT> * to configure Shiro beans in Spring, since the user never has to worry about whether or not if they<a name="line.37"></a>
<FONT color="green">038</FONT> * have to specify init-method and destroy-method bean attributes.&lt;/p&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> *<a name="line.39"></a>
<FONT color="green">040</FONT> * &lt;p&gt;&lt;b&gt;Warning: This post processor has no way to determine if &lt;tt&gt;init()&lt;/tt&gt; or &lt;tt&gt;destroy()&lt;/tt&gt; have<a name="line.40"></a>
<FONT color="green">041</FONT> * already been called, so if you define this post processor in your applicationContext, do not also call these<a name="line.41"></a>
<FONT color="green">042</FONT> * methods manually or via Spring's &lt;tt&gt;init-method&lt;/tt&gt; or &lt;tt&gt;destroy-method&lt;/tt&gt; bean attributes.&lt;/b&gt;&lt;/p&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * @since 0.2<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public class LifecycleBeanPostProcessor implements DestructionAwareBeanPostProcessor, PriorityOrdered {<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> * Private internal class log instance.<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> private static final Logger log = LoggerFactory.getLogger(LifecycleBeanPostProcessor.class);<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /**<a name="line.53"></a>
<FONT color="green">054</FONT> * Order value of this BeanPostProcessor.<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> private int order;<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> /**<a name="line.58"></a>
<FONT color="green">059</FONT> * Default Constructor.<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public LifecycleBeanPostProcessor() {<a name="line.61"></a>
<FONT color="green">062</FONT> this(LOWEST_PRECEDENCE);<a name="line.62"></a>
<FONT color="green">063</FONT> }<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /**<a name="line.65"></a>
<FONT color="green">066</FONT> * Constructor with definable {@link #getOrder() order value}.<a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> * @param order order value of this BeanPostProcessor.<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> public LifecycleBeanPostProcessor(int order) {<a name="line.70"></a>
<FONT color="green">071</FONT> this.order = order;<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> /**<a name="line.74"></a>
<FONT color="green">075</FONT> * Calls the &lt;tt&gt;init()&lt;/tt&gt; methods on the bean if it implements {@link org.apache.shiro.util.Initializable}<a name="line.75"></a>
<FONT color="green">076</FONT> *<a name="line.76"></a>
<FONT color="green">077</FONT> * @param object the object being initialized.<a name="line.77"></a>
<FONT color="green">078</FONT> * @param name the name of the bean being initialized.<a name="line.78"></a>
<FONT color="green">079</FONT> * @return the initialized bean.<a name="line.79"></a>
<FONT color="green">080</FONT> * @throws BeansException if any exception is thrown during initialization.<a name="line.80"></a>
<FONT color="green">081</FONT> */<a name="line.81"></a>
<FONT color="green">082</FONT> public Object postProcessBeforeInitialization(Object object, String name) throws BeansException {<a name="line.82"></a>
<FONT color="green">083</FONT> if (object instanceof Initializable) {<a name="line.83"></a>
<FONT color="green">084</FONT> try {<a name="line.84"></a>
<FONT color="green">085</FONT> if (log.isDebugEnabled()) {<a name="line.85"></a>
<FONT color="green">086</FONT> log.debug("Initializing bean [" + name + "]...");<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> ((Initializable) object).init();<a name="line.89"></a>
<FONT color="green">090</FONT> } catch (Exception e) {<a name="line.90"></a>
<FONT color="green">091</FONT> throw new FatalBeanException("Error initializing bean [" + name + "]", e);<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> return object;<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> /**<a name="line.98"></a>
<FONT color="green">099</FONT> * Does nothing - merely returns the object argument immediately.<a name="line.99"></a>
<FONT color="green">100</FONT> */<a name="line.100"></a>
<FONT color="green">101</FONT> public Object postProcessAfterInitialization(Object object, String name) throws BeansException {<a name="line.101"></a>
<FONT color="green">102</FONT> // Does nothing after initialization<a name="line.102"></a>
<FONT color="green">103</FONT> return object;<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> /**<a name="line.107"></a>
<FONT color="green">108</FONT> * Calls the &lt;tt&gt;destroy()&lt;/tt&gt; methods on the bean if it implements {@link org.apache.shiro.util.Destroyable}<a name="line.108"></a>
<FONT color="green">109</FONT> *<a name="line.109"></a>
<FONT color="green">110</FONT> * @param object the object being initialized.<a name="line.110"></a>
<FONT color="green">111</FONT> * @param name the name of the bean being initialized.<a name="line.111"></a>
<FONT color="green">112</FONT> * @throws BeansException if any exception is thrown during initialization.<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> public void postProcessBeforeDestruction(Object object, String name) throws BeansException {<a name="line.114"></a>
<FONT color="green">115</FONT> if (object instanceof Destroyable) {<a name="line.115"></a>
<FONT color="green">116</FONT> try {<a name="line.116"></a>
<FONT color="green">117</FONT> if (log.isDebugEnabled()) {<a name="line.117"></a>
<FONT color="green">118</FONT> log.debug("Destroying bean [" + name + "]...");<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> ((Destroyable) object).destroy();<a name="line.121"></a>
<FONT color="green">122</FONT> } catch (Exception e) {<a name="line.122"></a>
<FONT color="green">123</FONT> throw new FatalBeanException("Error destroying bean [" + name + "]", e);<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> /**<a name="line.128"></a>
<FONT color="green">129</FONT> * Order value of this BeanPostProcessor.<a name="line.129"></a>
<FONT color="green">130</FONT> *<a name="line.130"></a>
<FONT color="green">131</FONT> * @return order value.<a name="line.131"></a>
<FONT color="green">132</FONT> */<a name="line.132"></a>
<FONT color="green">133</FONT> public int getOrder() {<a name="line.133"></a>
<FONT color="green">134</FONT> // LifecycleBeanPostProcessor needs Order. See https://issues.apache.org/jira/browse/SHIRO-222<a name="line.134"></a>
<FONT color="green">135</FONT> return order;<a name="line.135"></a>
<FONT color="green">136</FONT> }<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
</PRE>
</BODY>
</HTML>