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