| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <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.jndi;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Enumeration;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Hashtable;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Properties;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.naming.Context;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import javax.naming.InitialContext;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import javax.naming.NameNotFoundException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.naming.NamingException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.slf4j.Logger;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.slf4j.LoggerFactory;<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> * Helper class that simplifies JNDI operations. It provides methods to lookup and<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * bind objects, and allows implementations of the {@link JndiCallback} interface<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * to perform any operation they like with a JNDI naming context provided.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <p/><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <p>Note that this implementation is an almost exact copy of the Spring Framework's identically named class from<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * their 2.5.4 distribution - we didn't want to re-invent the wheel, but not require a full dependency on the<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Spring framework, nor does Spring make available only its JNDI classes in a small jar, or we would have used that.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Since Shiro is also Apache 2.0 licensed, all regular licenses and conditions and authors have remained in tact.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @see JndiCallback<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @see #execute<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public class JndiTemplate {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private static final Logger log = LoggerFactory.getLogger(JndiTemplate.class);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private Properties environment;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /** Create a new JndiTemplate instance. */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public JndiTemplate() {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> }<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Create a new JndiTemplate instance, using the given environment.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param environment the Properties to initialize with<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public JndiTemplate(Properties environment) {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> this.environment = environment;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> }<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> * Set the environment for the JNDI InitialContext.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> *<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param environment the Properties to initialize with<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public void setEnvironment(Properties environment) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> this.environment = environment;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<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> * Return the environment for the JNDI InitialContext, or <code>null</code> if none should be used.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> *<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @return the environment for the JNDI InitialContext, or <code>null</code> if none should be used.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public Properties getEnvironment() {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return this.environment;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Execute the given JNDI context callback implementation.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> *<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @param contextCallback JndiCallback implementation<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @return a result object returned by the callback, or <code>null</code><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @throws NamingException thrown by the callback implementation<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @see #createInitialContext<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> public Object execute(JndiCallback contextCallback) throws NamingException {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> Context ctx = createInitialContext();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> try {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return contextCallback.doInContext(ctx);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> finally {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> try {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> ctx.close();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> } catch (NamingException ex) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> log.debug("Could not close JNDI InitialContext", ex);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * Create a new JNDI initial context. Invoked by {@link #execute}.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <p>The default implementation use this template's environment settings.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Can be subclassed for custom contexts, e.g. for testing.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return the initial Context instance<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @throws NamingException in case of initialization errors<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> @SuppressWarnings({"unchecked"})<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> protected Context createInitialContext() throws NamingException {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> Properties env = getEnvironment();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> Hashtable icEnv = null;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> if (env != null) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> icEnv = new Hashtable(env.size());<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> for (Enumeration en = env.propertyNames(); en.hasMoreElements();) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> String key = (String) en.nextElement();<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> icEnv.put(key, env.getProperty(key));<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> return new InitialContext(icEnv);<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> * Look up the object with the given name in the current JNDI context.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> *<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @param name the JNDI name of the object<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @return object found (cannot be <code>null</code>; if a not so well-behaved<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * JNDI implementations returns null, a NamingException gets thrown)<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @throws NamingException if there is no object with the given<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * name bound to JNDI<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public Object lookup(final String name) throws NamingException {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> log.debug("Looking up JNDI object with name '{}'", name);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return execute(new JndiCallback() {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> public Object doInContext(Context ctx) throws NamingException {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> Object located = ctx.lookup(name);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (located == null) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> throw new NameNotFoundException(<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> "JNDI object with [" + name + "] not found: JNDI implementation returned null");<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return located;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> });<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> /**<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * Look up the object with the given name in the current JNDI context.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> *<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @param name the JNDI name of the object<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @param requiredType type the JNDI object must match. Can be an interface or<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * superclass of the actual class, or <code>null</code> for any match. For example,<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * if the value is <code>Object.class</code>, this method will succeed whatever<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * the class of the returned instance.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @return object found (cannot be <code>null</code>; if a not so well-behaved<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * JNDI implementations returns null, a NamingException gets thrown)<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @throws NamingException if there is no object with the given<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * name bound to JNDI<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> public Object lookup(String name, Class requiredType) throws NamingException {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> Object jndiObject = lookup(name);<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> if (requiredType != null && !requiredType.isInstance(jndiObject)) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> String msg = "Jndi object acquired under name '" + name + "' is of type [" +<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> jndiObject.getClass().getName() + "] and not assignable to the required type [" +<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> requiredType.getName() + "].";<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> throw new NamingException(msg);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> return jndiObject;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /**<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * Bind the given object to the current JNDI context, using the given name.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> *<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param name the JNDI name of the object<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @param object the object to bind<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @throws NamingException thrown by JNDI, mostly name already bound<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public void bind(final String name, final Object object) throws NamingException {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> log.debug("Binding JNDI object with name '{}'", name);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> execute(new JndiCallback() {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public Object doInContext(Context ctx) throws NamingException {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> ctx.bind(name, object);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> return null;<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> });<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> /**<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * Rebind the given object to the current JNDI context, using the given name.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * Overwrites any existing binding.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> *<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @param name the JNDI name of the object<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * @param object the object to rebind<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * @throws NamingException thrown by JNDI<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> */<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> public void rebind(final String name, final Object object) throws NamingException {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> log.debug("Rebinding JNDI object with name '{}'", name);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> execute(new JndiCallback() {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> public Object doInContext(Context ctx) throws NamingException {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> ctx.rebind(name, object);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return null;<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> });<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> /**<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * Remove the binding for the given name from the current JNDI context.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> *<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @param name the JNDI name of the object<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @throws NamingException thrown by JNDI, mostly name not found<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> */<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> public void unbind(final String name) throws NamingException {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> log.debug("Unbinding JNDI object with name '{}'", name);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> execute(new JndiCallback() {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public Object doInContext(Context ctx) throws NamingException {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> ctx.unbind(name);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return null;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> });<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span>}<a name="line.224"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |