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