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