blob: fdc66f9d88c37ecb2a93de74a6304f53ffa88782 [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.util;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.ShiroException;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.slf4j.Logger;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.Collection;</a>
<span class="sourceLineNo">026</span><a id="line.26"></a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">/**</a>
<span class="sourceLineNo">029</span><a id="line.29"> * Utility class to help call {@link org.apache.shiro.util.Initializable#init() Initializable.init()} and</a>
<span class="sourceLineNo">030</span><a id="line.30"> * {@link org.apache.shiro.util.Destroyable#destroy() Destroyable.destroy()} methods cleanly on any object.</a>
<span class="sourceLineNo">031</span><a id="line.31"> *</a>
<span class="sourceLineNo">032</span><a id="line.32"> * @since 0.2</a>
<span class="sourceLineNo">033</span><a id="line.33"> */</a>
<span class="sourceLineNo">034</span><a id="line.34">public abstract class LifecycleUtils {</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36"> private static final Logger log = LoggerFactory.getLogger(LifecycleUtils.class);</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> public static void init(Object o) throws ShiroException {</a>
<span class="sourceLineNo">039</span><a id="line.39"> if (o instanceof Initializable) {</a>
<span class="sourceLineNo">040</span><a id="line.40"> init((Initializable) o);</a>
<span class="sourceLineNo">041</span><a id="line.41"> }</a>
<span class="sourceLineNo">042</span><a id="line.42"> }</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> public static void init(Initializable initializable) throws ShiroException {</a>
<span class="sourceLineNo">045</span><a id="line.45"> initializable.init();</a>
<span class="sourceLineNo">046</span><a id="line.46"> }</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"> * Calls {@link #init(Object) init} for each object in the collection. If the collection is {@code null} or empty,</a>
<span class="sourceLineNo">050</span><a id="line.50"> * this method returns quietly.</a>
<span class="sourceLineNo">051</span><a id="line.51"> *</a>
<span class="sourceLineNo">052</span><a id="line.52"> * @param c the collection containing objects to {@link #init init}.</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @throws ShiroException if unable to initialize one or more instances.</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @since 0.9</a>
<span class="sourceLineNo">055</span><a id="line.55"> */</a>
<span class="sourceLineNo">056</span><a id="line.56"> public static void init(Collection c) throws ShiroException {</a>
<span class="sourceLineNo">057</span><a id="line.57"> if (c == null || c.isEmpty()) {</a>
<span class="sourceLineNo">058</span><a id="line.58"> return;</a>
<span class="sourceLineNo">059</span><a id="line.59"> }</a>
<span class="sourceLineNo">060</span><a id="line.60"> for (Object o : c) {</a>
<span class="sourceLineNo">061</span><a id="line.61"> init(o);</a>
<span class="sourceLineNo">062</span><a id="line.62"> }</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"> public static void destroy(Object o) {</a>
<span class="sourceLineNo">066</span><a id="line.66"> if (o instanceof Destroyable) {</a>
<span class="sourceLineNo">067</span><a id="line.67"> destroy((Destroyable) o);</a>
<span class="sourceLineNo">068</span><a id="line.68"> } else if (o instanceof Collection) {</a>
<span class="sourceLineNo">069</span><a id="line.69"> destroy((Collection)o);</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"> }</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> public static void destroy(Destroyable d) {</a>
<span class="sourceLineNo">074</span><a id="line.74"> if (d != null) {</a>
<span class="sourceLineNo">075</span><a id="line.75"> try {</a>
<span class="sourceLineNo">076</span><a id="line.76"> d.destroy();</a>
<span class="sourceLineNo">077</span><a id="line.77"> } catch (Throwable t) {</a>
<span class="sourceLineNo">078</span><a id="line.78"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">079</span><a id="line.79"> String msg = "Unable to cleanly destroy instance [" + d + "] of type [" + d.getClass().getName() + "].";</a>
<span class="sourceLineNo">080</span><a id="line.80"> log.debug(msg, t);</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> /**</a>
<span class="sourceLineNo">087</span><a id="line.87"> * Calls {@link #destroy(Object) destroy} for each object in the collection.</a>
<span class="sourceLineNo">088</span><a id="line.88"> * If the collection is {@code null} or empty, this method returns quietly.</a>
<span class="sourceLineNo">089</span><a id="line.89"> *</a>
<span class="sourceLineNo">090</span><a id="line.90"> * @param c the collection of objects to destroy.</a>
<span class="sourceLineNo">091</span><a id="line.91"> * @since 0.9</a>
<span class="sourceLineNo">092</span><a id="line.92"> */</a>
<span class="sourceLineNo">093</span><a id="line.93"> public static void destroy(Collection c) {</a>
<span class="sourceLineNo">094</span><a id="line.94"> if (c == null || c.isEmpty()) {</a>
<span class="sourceLineNo">095</span><a id="line.95"> return;</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"> for (Object o : c) {</a>
<span class="sourceLineNo">099</span><a id="line.99"> destroy(o);</a>
<span class="sourceLineNo">100</span><a id="line.100"> }</a>
<span class="sourceLineNo">101</span><a id="line.101"> }</a>
<span class="sourceLineNo">102</span><a id="line.102">}</a>
</pre>
</div>
</main>
</body>
</html>